LGVSyntenyDisplay
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 SyntenyTrack's alignments in a linear genome view, stacked and
colored the way an alignments display draws reads. It has the alignments
display's bands and settings but the sashimi band, the junction filter
fields, pileup.bases and modifications: a synteny block has no introns,
basecaller tags or qualities.
Example usage
Shows a SyntenyTrack's alignments in a plain linear view (rather than the
two-row synteny view). Same track config as a synteny track — just pick this
display type:
{
type: 'SyntenyTrack',
trackId: 'hg38_vs_mm10',
name: 'hg38 vs mm10',
assemblyNames: ['hg38', 'mm10'],
adapter: {
type: 'PAFAdapter',
uri: 'https://example.com/hg38_vs_mm10.paf',
queryAssembly: 'hg38',
targetAssembly: 'mm10',
},
displays: [
{
type: 'LGVSyntenyDisplay',
displayId: 'hg38_vs_mm10-LGVSyntenyDisplay',
},
],
}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: BaseLinearAlignmentsDisplay
- Config guide: Tracks
- Developer guide: Custom track and display types
Config slots
Display slots go on a display entry: "displays": [{ "type": "LGVSyntenyDisplay", ... }], 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 |
|---|---|
| data SyntenyData | What the fetch reads, a SyntenyData object: resolution picks a tiered file's stored tier. |
| encoding LGVSyntenyEncoding | The alignments displays' encoding with color painting strand while it names neither a field nor a constant, where the base display paints the plain fill. |
| coverage LGVSyntenyCoverage | The alignments displays' coverage band with show defaulting to off: a synteny track hides the coverage histogram unless asked. |
collapseSectionsboolean = true | One row per facet section by default: an all-vs-all track faceted by mate assembly draws each mate genome as a single band, with repeat depth shown as darker shading rather than as extra rows. Overrides the base alignments display's collapseSections default of false, where a section is a read category and the stack itself is the information. |
| sort LGVSyntenySort | The row order, with length the default so big syntenic blocks cluster at the top; a string is the field. |
| Inherited from BaseLinearAlignmentsDisplay | 9 slots |
heightnumber = 250 | Starting height in pixels for the bands together; heightMode decides what a pileup deeper than this does |
unitstringEnum (read, chain) = 'read' | The unit one row draws: a read, or a chain of a read, its mate and its split segments (the "View as pairs" menu row) |
| filter FieldPredicate | The alignments drawn, a list of FieldPredicate entries every one of which must hold. The read fields run before every band, so coverage counts only the reads they pass: flags.UNMAP and the other samtools flag names, mapq (MAPQ 255, none reported, passes a floor), name, tags.HP and any other tag, and the read categories spliced, svSignal, alone and split. junction.reads, junction.canonical (a split junction reads no motif and counts as canonical, so equal: false hides it), junction.class (splice for an N gap, or a split read's deletion, duplication or inversion) and junction.source (gap or split) test the sashimi junctions, and connection.interchrom, connection.offscreen and breakpoint.reads the connections the arcs, the read cloud and the connectors draw.A written list merges with the defaults by field: unmapped, QC-failed and duplicate reads out ( flags.UNMAP, flags.QCFAIL and flags.DUP equal: false), and junction.reads and breakpoint.reads at least 2. An entry replaces its own field's defaults, and an entry naming a field with no test, such as { field: "flags.DUP" }, only removes them. |
| facet SectionFacet | In-track stacked grouping, one labelled section per value: a read dimension (strand, firstOfPairStrand, pairOrientation, pairing, split, spliced, svSignal, mapq, mateRefName, mateAssembly), a tag (tags.HP), or any other field. { field: "tags.HP", sort: ["2", "1"] } stacks the listed values first. |
| legend HiddenLegend | The display's key: show, off by default. |
| pileup Pileup | The stacked reads: show, mark.height (default 7), maxLayoutHeight, and the parts drawn on each read. |
| readConnections ReadConnections | The connections between mates and split segments: show (default off), mark (link, the arcs, or rule, the read cloud), height, placement, encoding (color and strokeWidth) and ordinaryPairs; the connection and breakpoint filter fields filter the connections drawn. |
heightModestringEnum (fixed, grow, fit) = 'fixed' | Track-sizing strategy — how the track responds when there are more reads than fit (the menu sets fit from "Read height → Fit to track height" and grow from "Advanced → Autogrow track height"). fixed (the default) keeps pileup.mark.height and scrolls; grow expands the track to show every read at that height; fit squeezes reads so every uncollapsed section fills the display without scrolling |
growMaxHeightnumber = 800 | Ceiling in pixels for the "autogrow track height" sizing mode; a pileup deeper than this grows to the ceiling and scrolls the rest. Does not apply to the fixed or fit modes, and does not limit how much is laid out (see pileup.maxLayoutHeight) advanced |
| Inherited from BaseLinearDisplay | 2 slots |
fetchSizeLimitnumber = 1000000 | bytes a region may fetch before the display asks first; an adapter that sets its own limit overrides 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 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 | ignored |
colorBy | moved into a current slot |
pileupDisplay | moved into a current slot |
snpCoverageDisplay | moved into a current slot |
defaultRendering | ignored |
colorScheme | ignored |
scales | moved into a current slot |
scaleType | moved into a current slot |
autoscale | moved into a current slot |
minScore | moved into a current slot |
maxScore | moved into a current slot |
numStdDev | ignored |
inverted | ignored |
multiTicks | ignored |
jitter | ignored |
lineWidth | moved into a current slot |
featureHeight | moved into a current slot |
maxHeight | moved into a current slot |
hideSmallIndels | ignored |
hideMismatches | moved into a current slot |
mismatchAlpha | moved into a current slot |
hideLargeIndels | ignored |
minSubfeatureWidth | ignored |
flipStrandLongReadChains | ignored |
renderers | moved into a current slot |