Skip to main content

BaseTrack

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

Overview

Configuration shared by all track types. Concrete tracks (FeatureTrack, AlignmentsTrack, VariantTrack, ...) extend this, so every track accepts these fields in addition to its own.

BaseTrack - Identifier

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

Config slots

BaseTrack 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
name
string = ''		descriptive name of the track, falls back to the trackId when unset
assemblyNames
stringArray = ['assemblyName']		name of the assembly (or assemblies) track belongs to
description
string = ''		a description of the track
category
stringArray = []		the category and sub-categories of a track
metadata
frozen = {}		anything to add about this track
adapter
pluginManager.pluggableConfigSchemaType('adapter')		where this track's data comes from. Its type names the adapter for the file format (BamAdapter, Gff3TabixAdapter, ...) and the rest of the object is that adapter's own slots — see the adapter pages for each. Most adapters also accept a uri shorthand in place of writing their location slots out.
textSearching.indexingAttributes
stringArray = ['Name', 'ID', 'symbol']		list of which feature attributes to index for text searching
textSearching.indexingFeatureTypesToExclude
stringArray = ['CDS', 'exon']		list of feature types to exclude in text search index
textSearching.textSearchAdapter
pluginManager.pluggableConfigSchemaType(
  'text search adapter',
)
a per-track name search index, normally a TrixTextSearchAdapter over what jbrowse text-index --tracks built. Without one, this track's features are only findable through an assembly-wide search adapter.
displays
types.array(pluginManager.pluggableConfigSchemaType('display'))		An array of full display configs, e.g. displays: [{ type: 'LinearBasicDisplay', color: 'green' }]. Each entry names a display type; use this when you need exact control — your own displayId, different settings for two displays, or choosing which display is the default.

For the common case, prefer the displayDefaults shorthand instead — an object of appearance settings (e.g. displayDefaults: { color: 'green' }) that JBrowse routes to whichever display uses each setting, so you don't have to name the display or write the array.

See the track config guide.
formatDetails
FormatDetailsConfigSchemaFactory()		jexl callbacks that add, rewrite or hide fields in this track's feature-details panel. Four slots, listed at FormatDetails, and the same schema exists session-wide as configuration.formatDetails.
formatAbout
FormatAboutConfigSchemaFactory()		jexl callbacks that add, rewrite or hide fields in this track's About dialog. Two slots, listed at FormatAbout, and the same schema exists session-wide as configuration.formatAbout.