LinearBasicDisplay
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the features plugin. View source.
Draws the genes and other features of a FeatureTrack, from a BED, GFF or
similar file. The display adds the gene-glyph slots (isoforms, UTRs,
chevrons) to the shared canvas base. encoding.color paints each
feature's fill and utrs.encoding.color its UTRs; the intron lines, chevrons and
strand arrows take the theme's stroke color.
Example usage
A FeatureTrack with compact features. displayMode is normal,
compact, superCompact or collapsed (one row):
{
type: 'FeatureTrack',
trackId: 'genes',
name: 'Genes',
assemblyNames: ['hg38'],
adapter: {
type: 'Gff3TabixAdapter',
uri: 'https://example.com/genes.gff3.gz',
},
displays: [
{
type: 'LinearBasicDisplay',
displayId: 'genes-LinearBasicDisplay',
height: 200,
displayMode: 'compact',
},
],
}Related links
- Adapter: BedAdapter
- Adapter: BedTabixAdapter
- Adapter: BigBedAdapter
- Adapter: CrisprGuideAdapter
- Adapter: FromConfigAdapter
- Adapter: Gff3Adapter
- Adapter: Gff3TabixAdapter
- Adapter: GtfAdapter
- Adapter: GtfTabixAdapter
- Adapter: NCListAdapter
- Adapter: SequenceSearchAdapter
- Adapter: SPARQLAdapter
- State model: runtime API
- Base config: LinearFeatureBaseDisplay
- User guide: Sequence search
- Config guide: Tracks
- Developer guide: Custom track and display types
- Docs: Cookbook
Color channels
| Setting | Page | scale.type |
Preset fields |
|---|---|---|---|
encoding.color |
FeatureColor | ordinal, threshold, linear, log, identity | strand, svType, impact, score |
Config slots
Display slots go on a display entry: "displays": [{ "type": "LinearBasicDisplay", ... }], 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 |
|---|---|
fetchSizeLimitnumber = 5000000 |
Feature (GFF/BED) tracks are light text, and the tabix byte estimate is block-granular (a small region still pulls whole BGZF blocks), so a single gene can trip a tighter gate. advanced |
| utrs FeatureUtrs |
The UTR boxes, a FeatureUtrs object. Unset, a UTR takes its transcript's fill, a feature's own BED itemRgb included (matching UCSC's whole-item coloring), else a contrasting blue. |
geneGlyphModestringEnum (auto, all, representative) = 'auto' |
Gene glyph display mode: "auto" collapses each gene to one transcript when zoomed out and trims the rest to what the track height holds, "all" draws every transcript and scrolls the surplus instead of trimming, "representative" shows one transcript per gene — the first by transcripts.sort, else the longest coding |
| labels FeatureLabels sub-schema |
The text drawn beside each feature: the base's name and description, and the names of its parts. |
| labels.name FeatureNameLabel |
Each feature's name, a FeatureNameLabel object. |
| labels.description FeatureDescriptionLabel |
The line under each name, a FeatureDescriptionLabel object. |
| labels.subfeatures FeatureSubfeatureLabels |
The names of a feature's parts, a FeatureSubfeatureLabels object. |
| chevrons FeatureChevrons sub-schema |
The arrows on a feature's intron lines. |
chevrons.showboolean = true |
draw chevrons on intron lines pointing the way the feature reads |
| transcripts FeatureTranscripts |
How a gene's isoforms are read and ranked, a FeatureTranscripts object. |
| containers FeatureContainers |
The top-level types whose children each stack on a separate row, a FeatureContainers object. |
| Inherited from LinearFeatureBaseDisplay | 10 slots |
| filter FieldPredicate |
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 }. |
displayModestringEnum (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. |
heightModestringEnum (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 under "Feature height → When features overflow"). 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. |
growMaxHeightnumber = 800 |
Ceiling in pixels for the "Grow the track" 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 |
maxFeatureScreenDensitynumber = 1 |
maximum features per pixel before showing a "too many features" message advanced |
| Inherited from BaseLinearDisplay | 2 slots |
heightnumber = 100 |
default height for the track |
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 with no user interaction, such as an embedded or notebook view or a screenshot, where the region is known and should draw 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 |
|---|---|
maxDisplayedBpPerPx |
ignored |
mouseover |
moved into a current slot |
jexlFilters |
moved into a current slot |
color1 |
moved into a current slot |
color2 |
ignored |
color3 |
moved into a current slot |
featureHeight |
moved into a current slot |
transcriptTypes |
moved into a current slot |
containerTypes |
moved into a current slot |
showLabels |
moved into a current slot |
showDescriptions |
moved into a current slot |
subfeatureLabels |
moved into a current slot |
outline |
ignored |
maxHeight |
ignored |
impliedUTRs |
ignored |
renderer |
moved into a current slot |