MultiWaySyntenyDisplay
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the linear-comparative-view plugin. View source.
Draws a multi-genome SyntenyTrack in a linear genome view as one lane per
assembly, with ribbons joining each gene's placements in adjacent lanes.
Example usage
A multi-genome SyntenyTrack listing this display first opens as lanes in
a linear genome view, each lane in its own genome's coordinates, with
ribbons connecting each gene's placements between adjacent lanes. The track
below reads an ortholog table;
three or more genomes
configures alignment files too:
{
type: 'SyntenyTrack',
trackId: 'grape_peach_cacao',
name: 'grape/peach/cacao orthologs',
assemblyNames: ['grape', 'peach', 'cacao'],
adapter: {
type: 'MCScanBlocksAdapter',
uri: 'grape.blocks',
blockAssemblies: ['grape', 'peach', 'cacao'],
bedLocations: [
{ uri: 'grape.bed' },
{ uri: 'peach.bed' },
{ uri: 'cacao.bed' },
],
},
displays: [
{
type: 'MultiWaySyntenyDisplay',
displayId: 'grape_peach_cacao-MultiWaySyntenyDisplay',
},
],
}The same display with a curated lane order, genes colored by ortholog cluster, and ribbons colored by percent identity:
{
type: 'SyntenyTrack',
trackId: 'primate_synteny',
name: 'Primate synteny',
assemblyNames: ['hg38', 'panTro6', 'gorGor6', 'ponAbe3'],
adapter: {
type: 'MCScanBlocksAdapter',
uri: 'hg38.blocks',
blockAssemblies: ['hg38', 'panTro6', 'gorGor6', 'ponAbe3'],
bedLocations: [
{ uri: 'hg38.bed' },
{ uri: 'panTro6.bed' },
{ uri: 'gorGor6.bed' },
{ uri: 'ponAbe3.bed' },
],
},
displays: [
{
type: 'MultiWaySyntenyDisplay',
displayId: 'primate_synteny-MultiWaySyntenyDisplay',
rows: { sort: ['panTro6', 'gorGor6', 'ponAbe3'] },
encoding: { color: 'cluster' },
ribbons: { encoding: { color: 'identity' } },
},
],
}Related links
- Adapter: BlastTabularAdapter
- Adapter: ChainAdapter
- Adapter: DeltaAdapter
- Adapter: MashMapAdapter
- Adapter: MCScanAnchorsAdapter
- Adapter: MCScanBlocksAdapter
- Adapter: MCScanSimpleAnchorsAdapter
- Adapter: MultiGenomeIndexedPAFAdapter
- Adapter: MultiGenomePAFAdapter
- Adapter: MultiPairwiseSyntenyAdapter
- Adapter: PAFAdapter
- Adapter: PairwiseIndexedPAFAdapter
- State model: runtime API
- Base config: BaseLinearDisplay
- Tutorial: Synteny from an ortholog table (grape, peach, cacao)
- Tutorial: Synteny visualization (OrthoFinder orthogroups)
- Config guide: Grouping and lane order
- Config guide: Synteny track
- Config guide: Tracks
- Developer guide: Custom track and display types
Color channels
| Setting | Page | scale.type |
Preset fields |
|---|---|---|---|
encoding.color |
MultiWayGeneColor | ordinal, threshold, linear, log | strand, svType, impact, score |
ribbons.encoding.color |
RibbonColor | linear, threshold, ordinal | mapq, identity, dnds, syntenicDepth, strand |
laneLayers.marks.encoding.color |
MarkColor | ordinal, linear, log, symlog, threshold, identity | strand, svType, impact, score |
Config slots
Display slots go on a display entry: "displays": [{ "type": "MultiWaySyntenyDisplay", ... }], 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 |
|---|---|
| encoding MultiWayGeneEncoding |
The channels the gene glyphs paint through: encoding.color, their fill. |
| utrs FeatureUtrs |
The gene glyphs' UTR boxes, a FeatureUtrs object, as on the canvas gene track. Unset, a UTR takes its gene's fill, and the contrasting UTR blue where nothing sets one. |
| data SyntenyData |
What the fetch reads, a SyntenyData object: resolution picks a tiered file's stored tier. |
| rows LaneRows |
The lane order and the lanes drawn, which the Lanes menu, a header drag and the lane picker write. |
| ribbons MultiWayRibbons |
The bands joining each gene's placements in adjacent lanes: ribbons.encoding.color paints them and ribbons.mark.interpolate curves their sides. |
laneGeneTracksstringArray = [] |
the trackId of the gene track each lane draws, one per genome, or an entry spelling {assembly}, such as {assembly}-ncbiRefSeq, naming in each lane the track whose id has that lane's genome, or any of its aliases, written there. Plain ids outrank {assembly} entries, and an earlier entry outranks a later one. A lane whose genome no entry names draws the session's best-ranked annotation track for it, which on a config holding several gene sets per genome is whichever is declared first, and never a BED track that sets disableGeneHeuristic |
| legend Legend |
The color key: every lane's drawn gene colors, or the anchor lane's alone where every lane's are too many to list, and what ribbons.encoding.color paints — the strand colors, the identity ramp, or a column's labels. Derived from what is on screen, so an encoding.color resolving to one color and a ribbon scale painting nothing key nothing. |
| axis MultiWayLaneAxis sub-schema |
Each lane's coordinate ticks, at one interval shared by every lane: equal spacing between two lanes means equal bp-per-pixel, and a lane whose ticks crowd together is zoomed out. |
axis.showboolean = true |
draw each lane's coordinate ticks; with this off, the span and multiple a zoomed-out lane's header prints are the only scale shown |
| labels MultiWayLabels sub-schema |
The names the display prints: each gene's, in a row under the genes, and each lane's genome. |
| labels.name FeatureNameLabel |
Each gene's name, a FeatureNameLabel object, dropped where its neighbours leave it no room. |
| labels.lanes MultiWayLaneLabels sub-schema |
Each lane's genome name. |
labels.lanes.placementstringEnum ('above', 'overlay') = 'above' |
above prints each genome's header on a line over its genes: its name, loci, badges and span; overlay prints it over the gene row instead and leaves out the loci, keeping [rev] on a flipped lane, which fits 12 px more per lane |
| laneLayers list of MultiWayLaneLayer entries |
Bands of data every lane draws above its genes, each from that genome's own track: a GC or conservation bigWig per genome as bars, say |
heightnumber = 240 |
default height for the track |
| Inherited from BaseLinearDisplay | 2 slots |
fetchSizeLimitnumber = 1000000 |
bytes a region may fetch before the display asks first; an adapter that sets its own limit takes precedence over this advanced |
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 |