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: Synteny track
- Config guide: Tracks
- Developer guide: Custom track and display types
Color channels
| Setting | Page | scale.type |
Preset fields |
|---|---|---|---|
encoding.color |
LGVSyntenyColor | ordinal, linear, threshold | strand, mapq, firstOfPairStrand, insertSizeAndOrientation, mateRefName |
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. |
| pileup LGVSyntenyPileup |
The alignments displays' pileup band with collapsed defaulting to on: one row per facet section. |
| 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 |
heightmaybeNumber |
Starting height in pixels for the bands together; heightMode decides what a pileup deeper than this does. Unset, the track opens at 250 with the pileup shown and at 100 with it hidden, and showing or hiding the pileup from the menu writes the height it had, so the toggle never resizes the track |
unitstringEnum ('read', 'chain') = 'read' |
The unit one row draws: a read, or a chain, which is a read, its mate and its split segments rather than a UCSC chain file's alignment (the "View as pairs/link supplementary alignments" menu row) |
| filter FieldPredicate |
The alignments drawn, a list of FieldPredicate entries every one of which must hold. The flags, mapq and tags decide which reads count, so coverage, the sashimi junctions and the insert-size colors count only the reads they pass: flags.UNMAP and the other samtools flag names, mapq (MAPQ 255, none reported, passes a floor), and tags.HP and any other tag. name and the read categories pick which of those reads the pileup, the arcs, the consensus and an export draw, and leave coverage whole: spliced per alignment, and svSignal, alone and split over a read, its mate and its split segments together, each taking equal: true or false. The facet read fields pairOrientation, pairing, svKind, firstOfPairStrand (1 or -1), mateRefName, alignedRefNames and mateAssembly pick drawn reads too, each read by the section a facet by read files it under (svKind by its whole chain's), with equal or oneOf of their values, or valid: false for the reads with none; alignedRefNames, the references every alignment of the read's chain is on (its split pieces, and a pair's both mates), passes when any of them does, so an entry each for chr9 and chr22 keeps a split read aligned to both and a pair with a mate on each; a read's strand is flags.REVERSE. A facet on a category gives its own coverage. 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 the defaults for the field it names, 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, svKind, mapq, mateRefName, alignedRefNames (one section per set of references, chr22 + chr9), 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. |
| readConnections ReadConnections |
The connections between mates and split segments: show (default off), mark (link, the arcs, or rule, the read cloud), height, placement, encoding (strokeWidth) and ordinaryPairs; the connection and breakpoint filter fields filter the connections drawn. |
| tooltip ReadTooltip |
The read hover's first line, a ReadTooltip object: the field it reads off each read. A bare string is the field. |
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 → Track height → Grow the track"). 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 "Grow the track" 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 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 |
moved into a current slot |
jexlFilters |
ignored |
colorBy |
moved into a current slot |
pileupDisplay |
moved into a current slot |
snpCoverageDisplay |
moved into a current slot |
defaultRendering |
ignored |
colorScheme |
ignored |
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 |
renderers |
moved into a current slot |