Skip to main content

LinearReferenceSequenceDisplay

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

Draws a ReferenceSequenceTrack as rows of bases: the forward strand, the reverse complement and the translation frames.

Example usage

The display goes in the displays array of the assembly's sequence track, which is where a ReferenceSequenceTrack is authored, so the display sets no assembly name. showForward, showReverse, and showTranslation toggle the strand and translation rows:

sequence: {
  type: 'ReferenceSequenceTrack',
  trackId: 'refseq',
  adapter: {
    type: 'IndexedFastaAdapter',
    uri: 'https://example.com/genome.fa',
  },
  displays: [
    {
      type: 'LinearReferenceSequenceDisplay',
      displayId: 'refseq-LinearReferenceSequenceDisplay',
      showTranslation: false,
    },
  ],
}

Config slots

Display slots go on a display entry: "displays": [{ "type": "LinearReferenceSequenceDisplay", ... }], 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.

SlotDescription
height
maybeNumber		explicit display height (e.g. from a drag-resize); unset means auto-fit to the zoom-aware computed height. See the model's height getter.
showForward
boolean = true		show the forward-strand sequence row
showReverse
boolean = true		show the reverse-complement sequence row (DNA only)
showTranslation
boolean = true		show the translation frame rows (DNA only)
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

Retired keys

An older config may still write these. Each loads without an error, and jbrowse validate reports it as stale.

KeyOn load
rendererignored