LinearWiggleDisplay
Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the wiggle plugin. View source.
Example usage
Minimal QuantitativeTrack config. See the
quantitative track guide for all
adapter and display options:
{
type: 'QuantitativeTrack',
trackId: 'coverage',
name: 'Coverage',
assemblyNames: ['hg38'],
adapter: { type: 'BigWigAdapter', uri: 'https://example.com/coverage.bw' },
}Several bigWigs, which a MultiQuantitativeTrack stacks one per row:
{
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, log scale, custom color:
{
type: 'QuantitativeTrack',
trackId: 'coverage',
name: 'Coverage',
assemblyNames: ['hg38'],
adapter: { type: 'BigWigAdapter', uri: 'https://example.com/coverage.bw' },
displayDefaults: {
height: 200,
scales: { y: { type: 'log' } },
color: 'darkgreen',
},
}Draws quantitative signal as bars, points, a line or a color strip (span),
for one source or many; rows: 'source' draws each source in a separate row.
Per-source metadata (a name, color and group for each) is preloaded on
the adapter rather than here — see MultiWiggleAdapter's subadapters
slot, where group drives the sidebar clustering tree and color sets each
source's line or fill.
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: 'LinearWiggleDisplay', displayId: '...', key: value }]
array form — see
configuring displays.
Related links
- Adapter: BedGraphAdapter
- Adapter: BedGraphTabixAdapter
- Adapter: BigWigAdapter
- State model: runtime API
- Tutorial: CNV across a population (1000 Genomes)
- Tutorial: Display settings
- Tutorial: Single-cell ATAC pseudobulk
- User guide: Clustering rows
- User guide: Quantitative track
- Config guide: Quantitative track
- Config guide: Tracks
- Developer guide: Custom track and display types
- Docs: Cookbook
Config slots
These slots go on a display entry: "displays": [{ "type": "LinearWiggleDisplay", ... }], 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 |
|---|---|
markstringEnum (bar, point, line, span) = 'bar' | The shape each score is drawn as, in the mark display's words: bar, a bar from the origin to the score; point, a point at it; line, a line through the scores; span, a strip whose color is the score. The track menu's Plot type writes it. v4's defaultRendering loads as its mark: xyplot a bar, scatter a point, density a span, and line and linecenter a line. |
interpolatestringEnum (step, linear) = 'step' | The path a line takes between scores: step holds each across its bin, as the data says; linear runs from one bin's centre to the next, smoother where the bins are few. Read by a line alone. |
| rows QuantitativeRows | One row per value of a field, stacked down the track with a label, a separator and the clustering sidebar, and the arrangement a reader gives them. source — one row per subtrack — is the only field this display reads; leave it unset and every source is drawn in one shared plot. domain is the row order: the subtracks it names lead, the rest keep the adapter's order, and a clustering run rotates its dendrogram towards it rather than discarding it. labels, tree, treeProvenance and kept are what the arrangement dialog, a clustering run and a focus write, each as a session edit to this object. |
| rowColor RowColor | The color a reader set on a named subtrack, as domain/range pairs, ahead of the adapter's color and the palette: its plot while color is unset, and otherwise, or under a score gradient, the tint beside its label. |
| color WiggleColor | One CSS color, or score through a scale — threshold for the bicolor plot, linear for the density ramp. Unset, it is the pos/neg pair about the origin, and several sources in one plot box each paint their row color. |
| scales ValueScale | The y scale the plot is drawn through: type, domainMin, domainMax, domainQuantile, symlogConstant and rules, the reference lines drawn across it. The density rendering draws no rule and does not widen to one: it spends color on the score and has no axis to rule. |
showLegendboolean = true | Draw the key: density's score color ramp, or the source colors where several share one plot. Defaults to on |
heightnumber = 100 | default height for the track |
yfeatureField = 'score' | the feature field plotted on the value axis, as a mark's encoding.y names one: a name, a dotted path or a jexl: expression. The default score is the field every adapter serves, including the value a BED adapter's scoreColumn rewrote it to; an explicit name reaches a raw column the adapter left alone (a BED extra column, a GFF attribute). A feature with no finite value in the field plots at 0 |
resolutionnumber = 1 | points per pixel the fetch asks a tiered file for: 1 is one per pixel, larger is finer and smaller is coarser. Clamped to the range the Resolution menu offers, so a value outside it reads as the nearest end |
originnumber = 0 | The value bars grow from, and the cut a threshold color scale with an empty domain uses. The same slot, with the same meaning, as the mark display's origin |
sizemaybeNumber | the mark's size in px, the display's constant for what the mark display spells encoding.size: a point's diameter, 2 while unset, or a line's width, 1 while unset |
maxGapMultiplenumber = 0 | Interpolated line 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 keeps one connected line advanced |
aggregatestringEnum (mean, min, max) = 'mean' | the stored zoom-bin summary drawn: mean, min or max. A BigWig's zoom levels, and the bins JBrowse makes over its raw section, store all three; where the source serves raw values they are one number and the setting changes nothing |
extentstringEnum (min-max, none) = 'min-max' | the span drawn around each bin's aggregate: 'min-max' draws the bin's stored min and max with it, as a lighter band |
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 |
treeAreaWidthnumber = 80 | width in px of the tree sidebar, which a drag on its edge also writes |
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 |
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 |
fetchSizeLimit | ignored |
mouseover | ignored |
jexlFilters | moved into a current slot |
displayCrossHatches | moved into a current slot |
minimalTicks | 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 |
renderers | moved into a current slot |
summaryScoreMode | moved into a current slot |
defaultRendering | moved into a current slot |
lineWidth | moved into a current slot |