MultiLinearWiggleDisplay
Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the wiggle plugin. View source.
Example usage
Minimal MultiQuantitativeTrack config. See the
multi-quantitative track guide
for all adapter and display options:
{
type: 'MultiQuantitativeTrack',
trackId: 'coverage_by_sample',
name: 'Coverage by sample',
assemblyNames: ['hg38'],
adapter: {
type: 'MultiWiggleAdapter',
bigWigs: [
'https://example.com/sample1.bw',
'https://example.com/sample2.bw',
],
},
}
Taller track overlaying two samples in one shared plot (multixyplot)
instead of the default stacked-per-subtrack layout:
{
type: 'MultiQuantitativeTrack',
trackId: 'coverage_by_sample',
name: 'Coverage by sample',
assemblyNames: ['hg38'],
adapter: {
type: 'MultiWiggleAdapter',
bigWigs: [
'https://example.com/sample1.bw',
'https://example.com/sample2.bw',
],
},
displayDefaults: { height: 300, defaultRendering: 'multixyplot' },
}
See the Config slots section below for all available configuration fields.
configuration for the multi-wiggle display, which draws several quantitative subtracks (e.g. BigWig files) on a shared Y axis
These are display-level slots: set them inside a track's displays to
change its defaults (setting them at the track top level has no effect).
The object shorthand displayDefaults: { key: value } is equivalent to the
full displays: [{ type: 'MultiLinearWiggleDisplay', displayId: '...', key: value }]
array form — see
configuring displays.
Per-subtrack metadata (a name, color, and group for each subtrack) is
preloaded on the adapter, not here — use MultiWiggleAdapter's
subadapters slot, where group drives the sidebar clustering tree and
color sets each subtrack's line/fill.
Related links
- Adapter: MultiWiggleAdapter
- State model: runtime API
- Guide: Clustering rows
- Guide: CNV across a population (1000 Genomes)
- Guide: CNV cohort (TCGA)
- Guide: Custom track and display types
- Guide: Defaults for all tracks
- Guide: Mutation cohort (TCGA)
- Guide: Single-cell ATAC pseudobulk
- Guide: Tracks
Config slots
These slots go on a display entry: "displays": [{ "type": "MultiLinearWiggleDisplay", ... }], 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 |
|---|---|
defaultRenderingstringEnum (multirowxy, multirowdensity, multirowline, multirowlinecenter, multirowscatter, multixyplot, multiline, multilinecenter, multiscatter) = 'multirowxy' | Default rendering type. Multi-row modes (multirowxy, multirowdensity, multirowline, multirowlinecenter, multirowscatter) draw one stacked plot per subtrack; overlapping modes (multixyplot, multiline, multilinecenter, multiscatter) draw all subtracks together in one shared plot. |
minimalTicksboolean = false | Draw only the min/max Y-axis ticks advanced |
showLegendmaybeBoolean = true promotable | Draw the source color key in overlay mode. Unset (the default) follows the session-wide default for this display type, falling back to on; an explicit true/false customizes the track |
minScorenumber = Number.MIN_VALUE | Fixed minimum score bound. The default (Number.MIN_VALUE) is a sentinel meaning "unset, use autoscale" advanced |
maxScorenumber = Number.MAX_VALUE | Fixed maximum score bound. The default (Number.MAX_VALUE) is a sentinel meaning "unset, use autoscale" advanced |
scaleTypestringEnum (linear, log, symlog) = 'linear' | Scale type. "log" cannot represent 0 or negative scores and floors the domain above them; "symlog" is log-like away from zero and linear through it, so a track whose scores touch or cross 0 keeps them |
autoscalestringEnum (local, localsd, localpercentile) = 'localpercentile' | Autoscale type: "local" uses the min/max in the visible region, "localsd" uses mean ± numStdDev standard deviations, "localpercentile" uses the numQuantile-th percentile score as the max (robust to skewed/peaky data) |
numStdDevnumber = 3 | Number of standard deviations to use for the localsd autoscale type advanced |
displayCrossHatchesboolean = false | Rule the score axis with horizontal cross hatches at the tick positions — the config form of the score menu's "Show cross hatches". Ignored by the density rendering types, which spend color rather than height on the score and so have no axis to rule |
symlogConstantnumber = 0 | Width of symlog's linear region around zero. The default 0 means "derive from the domain" (a thousandth of its largest magnitude). Setting it to 1 makes symlog exactly log(x+1), which flattens anything living below 1 — set it near the smallest score you need to tell apart instead advanced |
posColorcolor = '#0068d1' | Fill color for positive scores, used when useBicolor is true (the default) |
negColorcolor = '#e01e26' | Fill color for negative scores, used when useBicolor is true (the default) |
bicolorPivotnumber = 0 | Pivot value for bicolor mode advanced |
densityColorRampstringEnum = 'default' | Color ramp for density ("density"/"multirowdensity") rendering. "default" fades from white at the pivot to the track color; a named ramp (e.g. "viridis") colors scores through that fixed 256-entry lookup table instead, the same table the Hi-C viridis scheme uses advanced |
numQuantilenumber = 0.99 | Percentile used to clip outliers for the localpercentile autoscale type (e.g. 0.99 clips the outermost 1% of each sign). Positive and negative extents are computed independently and anchored at 0, so a sparse minority tail (e.g. phyloP acceleration) stays visible; all-positive data pins the min at 0 advanced |
scatterPointSizemaybeNumber = 2 promotable | Point height in px for scatterplot ("scatter"/"multiscatter") rendering. Unset (the default) follows the session-wide default for this display type, falling back to 2 advanced |
lineWidthmaybeNumber = 1 promotable | Line thickness in px for line ("line"/"multiline") rendering. Unset (the default) follows the session-wide default for this display type, falling back to 1 advanced |
maxGapMultiplenumber = 0 | Interpolated line ("linecenter"/"multilinecenter"/"multirowlinecenter") only: break the line where consecutive points sit further apart than this multiple of the track's own mean point spacing, instead of drawing one long chord across the hole. Scaled to the data rather than a fixed bp distance so it holds at every zoom. 0 disables breaking (the pre-existing behavior, one connected line throughout) advanced |
heightnumber = 200 | default height for the track |
summaryScoreModestringEnum (max, min, avg, whiskers) = 'avg' | choose whether to use max/min/average or whiskers which combines all three into the same rendering |
showTreeboolean = true | Show the subtrack clustering tree in the sidebar |
showBranchLengthboolean = true | position tree nodes by branch length (dendrogram) rather than evenly by topology (cladogram) |
showRowLabelsboolean = true | Name each subtrack row down the left edge |
showRowSeparatorsboolean = false | draw a hairline between adjacent rows; off by default, because a painting whose neighbouring rows differ in color already separates itself and the line only earns its pixel where they do not — a run of same-colored rows reads as one block without it, with no way to recover the row count by eye. Drawn only once rows are at least 4px tall: below that the line is as thick as the row it borders, turning a dense painting into a grid of hairlines with a little color between them |