Skip to main content

LinearFeatureBaseDisplay

Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the features plugin. View source.

Holds the slots shared by the canvas-drawn linear feature displays, which stack overlapping features in rows (pileup-style glyphs).

Config slots

LinearFeatureBaseDisplay 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 an 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
filter
fieldPredicateList()		The features the display draws, a list of FieldPredicate entries a feature must all pass: a field of the feature's own ({ field: "score", gte: 100 }), a jexl: expression that must hold ("jexl:feature.type == 'gene'"), or geneLike, true for every gene, transcript and RNA type, the transcripts.types and containers.types, and a top-level CDS.
tooltip
FeatureTooltip		The box hovering a feature opens, a FeatureTooltip object.
legend
Legend		The display's color key, when it has one: the key an encoding.color field derives, or a variant track's consequence-impact / SV-type presets.
encoding
FeatureEncoding		The channels the features paint through: encoding.color, each feature's main fill.
mark
FeatureMark		The box each feature draws as, a FeatureMark object: { height: 6 }.
displayMode
stringEnum (normal, compact, superCompact, collapsed) = 'normal'		Feature height preset, normal by default; compact and superCompact shrink the rows, and collapsed packs every feature onto a single row with all labels hidden
facet
SectionFacet		One labelled section of the track per value of a field: "strand", or { field, sort } with the order its sections stack in.
labels
CanvasFeatureLabels sub-schema		The text drawn beside each feature, two parts with show.
labels.name
FeatureNameLabel		Each feature's name, a FeatureNameLabel object.
labels.description
FeatureDescriptionLabel		The line under each name, a FeatureDescriptionLabel object.
heightMode
stringEnum (fixed, grow, fit) = 'fit'		Track-sizing strategy — how the track responds when there are more features than fit (shared vocabulary with the alignments display, exposed in the "Track sizing" menu). fit (the default) keeps the track height and gives up descriptions, then isoforms, then names, then squeezes boxes down to 2px, and scrolls only what still overflows; fixed keeps a scrollable fixed height; grow expands the track to show all features. Orthogonal to the per-feature size set by displayMode, which fit never enlarges.
growMaxHeight
number = 800		Ceiling in pixels for the "autogrow track height" sizing mode; a track with more content than this grows to the ceiling and scrolls the rest. Does not apply to the fixed or fit modes
advanced
maxFeatureScreenDensity
number = 1		maximum features per pixel before showing a "too many features" message
advanced
Inherited from BaseLinearDisplay3 slots
height
number = 100		default height for the track
fetchSizeLimit
number = 1000000		bytes a region may fetch before the display asks first; an adapter that sets its own limit overrides this
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