Skip to main content

BaseLinearDisplay

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Built into JBrowse core. View source.

Overview

Shared base config for linear displays — its slots (height, maxFeatureScreenDensity, fetchSizeLimit, mouseover, jexlFilters) are common to all of them. The GPU stack's LinearCanvasBaseDisplay config extends it, and third-party plugins extend it too.

BaseLinearDisplay - Identifier

Every BaseLinearDisplay has a unique displayId, a required top-level field that identifies it (not one of the config slots below).

Config slots

BaseLinearDisplay is a shared base schema, not a type you name in a config. Set these slots on one of the configs under Extended by above, each of which lists them as inherited and shows the shape in its own example. 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.

SlotDescription
maxFeatureScreenDensity
number = 1		maximum features per pixel before showing a "too many features" message
advanced
height
number = 100		default height for the track
mouseover
string = 
'jexl:get(feature,'_mouseOver')||get(feature,'name')||get(feature,'function')||get(feature,'id')'
text to display when the cursor hovers over a feature
callback args: feature
jexlFilters
stringArray = []		config jexlFilters are deferred evaluated so they are prepended with jexl at runtime rather than being stored with jexl in the config
fetchSizeLimit
number = 1_000_000		maximum data to attempt to download for a given track, used if adapter doesn't specify one
advanced
forceLoad
boolean = 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
densityTier
stringEnum (auto, features, density) = 'auto'		when to draw the features-per-bin density band in place of features: "auto" swaps to it where the region is too large to fetch, "features" never does and keeps the banner, "density" always does. Needs a density source on the adapter (its densityAdapter slot)
advanced
densityTierBpPerPx
number = 0		in "auto" mode, also draw the density band from this many bp per pixel outward, before the region is too large to fetch; 0 leaves the swap to the fetch-size gate alone
advanced