LinearMafDisplay
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the maf plugin. View source.
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.
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: {
height: 400,
conservation: { show: true, height: 40 },
rows: { axis: { labels: true } },
},
}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
Color channels
| Setting | Page | scale.type |
Preset fields |
|---|---|---|---|
encoding.color |
MafColor | fixed by the field | identity, refNameRank |
Config slots
Display 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 = 5000000 |
The bytes a region may cost before the display stops and offers to load it anyway, the whole budget since no MAF adapter declares a fetchSizeLimit. 5 Mb, as LinearBasicDisplay uses, because the index estimate is block-granular.advanced |
| encoding MafEncoding |
The channels the aligned cells paint through: encoding.color, the field that colors them (see MafColor), and encoding.y, the field a row's bar height shows. |
| rows RowArrangement |
The arrangement a reader gives the species rows, each member by row name. sort 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 and kept are what the arrangement dialog, a clustering run and a focus write. The adapter's guide tree is never written here. rows.axis is the guide down their left, the species tree and names, with no grid: the rows keep a gap instead. rows.colors pins a species row's color, drawn as the bar beside its label over the color the adapter's samples entry gives it; a copy row (mm10~2, where a block aligns a species twice) takes its species'. A row is always a species, so rows takes no field. |
| legend Legend |
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. |
| coverage CoverageBand |
The coverage band: show, height, encoding.y, interbase and alleles, as the alignments display spells it. |
| alignments MafAlignments |
The per-species rows, which take the height the bands above them leave: show, mark.height.band, and the inversions, frames and reference parts. |
| conservation MafConservation |
The band of identity to the reference: show (default off), height and unit, base or codon. |
heightnumber = 300 |
display height in pixels, the bands above the rows included; the rows divide what is left between them, however many there are |
| 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 with no user interaction, such as an embedded or notebook view or a screenshot, where the region is known and should draw 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 |