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.
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',
},
],
}Draws a SyntenyTrack's alignments in a linear genome view, stacked and
colored the way an alignments display draws reads.
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: LinearAlignmentsDisplay
- Config guide: Tracks
- Developer guide: Custom track and display types
Config slots
These 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 |
|---|---|
| color LGVSyntenyColor | The alignments displays' color object with field defaulting to strand, where the base display paints the plain fill. |
showCoverageboolean = false | Synteny reads hide the coverage histogram by default; overrides the inherited base alignments display's showCoverage default of true. |
collapseGroupRowsboolean = true | One lane per group by default: an all-vs-all track grouped 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 collapseGroupRows default of false, where a group is a read category and the stack itself is the information. |
hideSelfAlignmentsboolean = false | Hide the lane an all-vs-all track draws for the view's own assembly. That lane holds no self-alignment line — aligners skip each sequence's own diagonal — so it carries only the assembly's internal paralogy, and readers consistently read it as missing data. Only meaningful when grouping by mate assembly. |
| sort LGVSyntenySort | The row order, with length the default so big syntenic blocks cluster at the top; a string is the type. |
lodModestringEnum (auto, fine, coarse) = 'auto' | stored tier of a tiered file to fetch: 'auto' switches on the adapter's bpPerPx threshold, 'fine' pins the per-row CIGAR tier, and 'coarse' the tier whose CIGAR is folded to its large indels |
| Inherited from LinearAlignmentsDisplay | 37 slots |
featureHeightnumber = 7 | Height of each feature (read) in pixels. Defaults to 7 |
readConnectionsLineWidthnumber = 1 | Line width for read-connection arcs/lines in pixels |
showSashimiLabelsboolean = false | Draw the supporting-read count on each sashimi arc |
showNonCanonicalJunctionsboolean = true | Draw sashimi arcs whose splice-site motif is none of GT-AG, GC-AG or AT-AC. Off, the motif is read off the reference under each junction, so it needs a sequence adapter, and a junction whose motif could not be read stays |
maxHeightnumber = 6000 | Maximum pixel height of the pileup layout; reads beyond this are not stacked (coverage still reflects true depth) advanced |
heightnumber = 250 | Starting height in pixels for the coverage band and pileup together; heightMode decides what a pileup deeper than this does |
| baseColor AlignmentsBaseColor | The per-base layer drawn over the reads, whatever fills them: { field: "modifications" }, "bisulfite", "baseQuality" or "base". |
| modifications AlignmentsModifications | Settings for the modifications and bisulfite color fields: threshold (percent, default 10), unmodified, cytosineContext and shownModifications. |
| filter ReadFilter | Every read filter, in one object: the flag masks, a read name, tag filters, and the four read categories. default filter flags is exclude 1540 read unmapped (0x4) read fails platform/vendor quality checks (0x200) read is PCR or optical duplicate (0x400) A read category takes "only" or "exclude", and is absent when it isn't filtering — { "svSignal": "only" } for the split reads, the SV-size indels and the discordant pairs. svSignal, singletons, split and spliced. |
| facet SectionFacet | In-track stacked grouping, one labelled section per value: a read dimension (strand, firstOfPairStrand, pairOrientation, pairing, split, spliced, mapq, mateRefName, mateAssembly), a tag (tags.HP), or any other field. { field: "tags.HP", domain: ["2", "1"] } stacks the listed values first. |
| scales ValueScale | The coverage band's value scale — the one thing on this display drawn against an axis, the pileup having no value and the arcs their own arcBandYScale. symlogConstant starts at 1 rather than the wiggle family's 0, which makes symlog exactly log(depth+1): the knee sits at one read, the smallest depth there is. domainQuantile stays at 1, the deepest base in view; the Coverage axis panel's Clip extreme outliers writes 0.99, which stops the axis at twice the 99th percentile of the covered bins' peaks, and misses a collapsed-repeat pile-up once it covers more than 1% of the view. |
fadeLowQualityMismatchesboolean = false | Fade mismatch bases by their per-base Phred quality. Defaults to off |
fadeLowFrequencyMismatchesboolean = true | Fade the sub-pixel mismatches, insertions and clip bars in the pileup that fall below the depth-dependent frequency threshold; off draws them all at full opacity. Does not affect the coverage band (see runCoveragePipeline) advanced |
showLegendboolean = false | Show the color-scheme legend overlay. Defaults to off |
showOutlinemaybeBoolean | null = auto: outline is drawn only under unit: 'chain'. Set true/false to force it on or off regardless of mode.advanced |
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) |
showBezierConnectionsboolean = false | Draw paired-read connection curves over the pileup |
showPileupboolean = true | Draw the stacked-read pileup band |
coverageHeightnumber = 45 | Height of the coverage band in pixels |
coverageSnpMinFrequencynumber = 0 | Hide a coverage-band allele segment whose share of that position's depth is below this fraction, so the band stops painting a sliver for every sequencing error at high depth. 0 (the default) colors every mismatch. Distinct from fadeLowFrequencyMismatches, the pileup's fade of sub-pixel marks against a depth-dependent threshold; this is a flat allele-fraction floor on the band, and the grey depth bar still shows through where a segment is hiddenadvanced |
showMismatchesboolean = true | Draw how reads differ from the reference: per-base mismatches, insertion markers and deletion bars. Not the intron centerlines — a spliced read is drawn as separate exon blocks, so the line joining them says they are one read rather than several, and it draws either way (PILEUP_MARKS) |
showInterbaseIndicatorsboolean = true | Draw interbase insertion/clip count bars and indicator triangles |
showInterchromboolean = true | Draw inter-chromosomal read-connection arcs |
showOrdinaryPairsmaybeBoolean | Draw the ordinary pairs alongside the abnormal ones: concordant pairs as arcs, pairs of modal insert size in the read cloud. Unset, the arcs draw them as context and the cloud leaves them out |
minInterchromSupportnumber = 2 | Hide inter-chromosomal connections supported by fewer than this many reads clustered at the same breakpoint |
showLongRangeboolean = true | Draw long-range read-connection arcs |
| arcColor AlignmentsArcColor | The field the read-connection arcs and the read cloud are colored by: "pairOrientation" paints them by pair orientation whatever the reads show, and "" takes the reads' color field where an arc paints it. |
readConnectionsstringEnum (off, arc, cloud) = 'off' | Read-connection rendering mode (mate pairs + split reads) |
readConnectionsDownboolean = true | Draw read connections below the coverage band. Defaults to on |
showSashimiArcsboolean = true | Draw sashimi (splice-junction) arcs |
sashimiArcsModestringEnum (up, down, auto) = 'up' | Sashimi junction-arc placement |
minSashimiScorenumber = 2 | Hide sashimi arcs with fewer than this many supporting reads |
sashimiArcsHeightnumber = 40 | Height of the sashimi-arc band in pixels |
readConnectionsHeightnumber = 35 | Height of the read-connection band in pixels |
showSoftClippingboolean = false | Draw soft-clipped read portions. Defaults to off |
heightModestringEnum (fixed, grow, fit) = 'fixed' | Track-sizing strategy — how the track responds when there are more reads than fit (shared vocabulary with the canvas feature display, exposed in the "Track sizing" menu). fixed (the default) keeps featureHeight and scrolls; grow expands the track to show every read at the configured height; fit squeezes reads so every uncollapsed group fills the display without scrolling. Orthogonal to the per-read size set by featureHeight |
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 maxHeight) advanced |
| Inherited from BaseLinearDisplay | 2 slots |
fetchSizeLimitnumber = 1_000_000 | maximum data to attempt to download for a given track, used if adapter doesn't specify one 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 |
drawInter | moved into a current slot |
drawLongRange | moved into a current slot |
filterBy | moved into a current slot |
pileupDisplay | moved into a current slot |
snpCoverageDisplay | moved into a current slot |
defaultRendering | ignored |
renderers | moved into a current slot |
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 |
hideSmallIndels | ignored |
hideMismatches | moved into a current slot |
mismatchAlpha | moved into a current slot |
hideLargeIndels | ignored |
minSubfeatureWidth | ignored |
flipStrandLongReadChains | ignored |