LinearMafDisplay
Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the maf plugin. View source.
Example usage
Set through the track's displayDefaults, so the track opens in this state
for every viewer.
{
type: 'MafTrack',
trackId: 'multiz_example',
name: 'Multiz alignment',
assemblyNames: ['hg38'],
adapter: {
type: 'BigMafAdapter',
bigBedLocation: { uri: 'https://example.com/multiz.bb' },
samples: ['hg38', 'panTro6', 'rheMac10', 'mm39'],
},
displayDefaults: {
rowHeight: 12,
showConservation: true,
conservationHeight: 40,
showRowLabels: true,
},
}The display for a MafTrack: one row per aligned species, with a
conservation summary above them. The slots are show/hide defaults and band
sizes; the bands and overlays derive from the alignment and toggle from the
track menu.
Related links
- Adapter: BgzipMafAdapter
- Adapter: BgzipTaffyAdapter
- Adapter: BigMafAdapter
- Adapter: MafTabixAdapter
- State model: runtime API
- Base config: BaseLinearDisplay
- User guide: MAF track
- Config guide: MAF track
- Config guide: Tracks
- Developer guide: Custom track and display types
Config slots
These slots go on a display entry: "displays": [{ "type": "LinearMafDisplay", ... }], or in the track's displayDefaults when this is its default display. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.
| Slot | Description |
|---|---|
fetchSizeLimitnumber = 5_000_000 | The whole budget the byte gate measures against, since no MAF adapter declares a fetchSizeLimit. 5 Mb, as LinearBasicDisplay uses, because the index estimate is block-granular. SUB_FLOOR_BYTE_BUDGET_FACTOR lets deep data through below the force-load floor. Measurements: MAF_LARGE_BLOCKS.md, "Fetch dominates at 470-way".advanced |
heightmaybeNumber = undefined | Overrides the base height slot as a maybeNumber: unset fits rows to their content height, an explicit value is a drag-resized track height. See the model's fitTargetHeight getter. |
rowProportionnumber = DEFAULTS.rowProportion | fraction of the row height each glyph fills |
showAllLettersboolean = DEFAULTS.showAllLetters | draw every base's letter, not only the mismatches' |
| color MafColor | The field the aligned cells are colored by; see MafColor. |
ymaybeStringEnum (identity) | Unset, each row is one band of cells. identity draws each row as a bar chart of its identity to the reference, the bars painted by color where it is identity and in one color otherwise. |
showAsUpperCaseboolean = DEFAULTS.showAsUpperCase | uppercase all base letters |
| rows SampleRows | The arrangement a reader gives the species rows, each member by row name. domain is the row order: the guide tree rotates to it while some rotation lists the species in that order; otherwise the listed species lead and the rest keep adapter order. labels, tree, treeProvenance and kept are what the arrangement dialog, a clustering run and a focus write. The adapter's guide tree is never written here. |
| rowColor RowColor | A color per species row, drawn as the bar beside its label, over the color the adapter's samples entry gives it. |
showLegendboolean = true | Show the color key for the active row rendering: codon-change categories, source-chromosome ranks, the identity ramp and the CDS frame swatches. In bases mode nothing draws, since there is nothing to key. |
showCoverageboolean = DEFAULTS.showCoverage | show the coverage band |
showAlignmentsboolean = DEFAULTS.showAlignments | Show the per-sample alignment rows. When off, only the coverage band renders (independent of showCoverage). |
coverageHeightnumber = DEFAULTS.coverageHeight | height of the coverage band in px |
showConservationboolean = DEFAULTS.showConservation | Show the conservation band (per-bp percent identity to the reference). Independent of showCoverage/showAlignments. |
conservationHeightnumber = DEFAULTS.conservationHeight | height of the conservation band in px |
conservationModestringEnum = DEFAULTS.conservationMode | Conservation band resolution: base (per-bp percent identity) or codon (per-codon amino-acid identity; needs an annotationAdapter). |
rowIdentityAutoZoomboolean = DEFAULTS.rowIdentityAutoZoom | When true (the default), identity, as color or as y, draws only while zoomed out, and zooming in to base level swaps it back for the bases (UCSC wigMaf behavior). When false identity draws at every zoom. |
showAnnotationsboolean = DEFAULTS.showAnnotations | Show the per-species CDS reading-frame overlay from the configured annotationAdapter (UCSC mafFrames). No effect without one. |
showReferenceRowboolean = DEFAULTS.showReferenceRow | Draw the reference species as a row of its own. Under mismatch coloring every cell in it matches by definition, so UCSC omits it. The row the worker named as the reference (refSampleId) is the one dropped.The row hides everywhere the row set reaches, including the FASTA "View subsequences" downloads and the per-species navigation menus. The other rows are still scored against the reference sequence. |
showInversionsboolean = DEFAULTS.showInversions | Overlay a strand-flip (inversion) indicator: inverted blocks get a diagonal hatch. |
rowHeightnumber = 0 | per-row height in px, scrolling the rows that do not fit; 0 (the default) fits the rows to the display height instead, dividing it between them |
showTreeboolean = true | show the species tree sidebar |
showBranchLengthboolean = true | position tree nodes by branch length (dendrogram) rather than evenly by topology (cladogram) |
showRowLabelsboolean = true | draw the species name over the left of each row |
treeAreaWidthnumber = 80 | width in px of the tree sidebar, which a drag on its edge also writes |
| Inherited from BaseLinearDisplay | 1 slot |
forceLoadboolean = false | Declarative equivalent of the "Force load" button on the "too much data" banner: when true the display always renders, however large the region or dense the features. Off by default (the gate guards against huge downloads). Set it on a view no one can interact with — an embedded / notebook view, or a screenshot — where the region is known and you want it drawn without a click. advanced |
Retired keys
An older config may still write these. Each loads without an error, and jbrowse validate reports it as stale.
| Key | On load |
|---|---|
maxFeatureScreenDensity | ignored |
maxDisplayedBpPerPx | ignored |
mouseover | ignored |
jexlFilters | moved into a current slot |