Skip to main content

FeatureTrack

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the linear-genome-view plugin. View source.

Example usage

A minimal hand-authored entry in the top-level tracks array — adapter points at the data file, and the track opens with a LinearBasicDisplay:

{
  type: 'FeatureTrack',
  trackId: 'genes',
  name: 'Genes',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'Gff3TabixAdapter',
    uri: 'https://example.com/genes.sorted.gff.gz',
  },
}

genes.sorted.gff.gz infers Gff3TabixAdapter and FeatureTrack on its own, and name defaults to the file name. In a config declaring one assembly, assemblyNames comes from there too — see the shortest track.

{
  trackId: 'genes',
  uri: 'https://example.com/genes.sorted.gff.gz',
  assemblyNames: ['hg38'],
}

The same track, colored. Rather than writing out the full displays array, you can put appearance settings in a displayDefaults object — JBrowse works out which display they belong to and applies them for you (here, the track's LinearBasicDisplay), so you don't have to know display names. A jexl: value gives per-feature coloring:

{
  type: 'FeatureTrack',
  trackId: 'genes',
  name: 'Genes',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'Gff3TabixAdapter',
    uri: 'https://example.com/genes.sorted.gff.gz',
  },
  displayDefaults: { color: "jexl:feature.type=='CDS'?'red':'blue'" },
}

See the Config slots section below for all available configuration fields.

Overview

used for basic gene and feature tracks, generally used with LinearBasicDisplay

FeatureTrack - Identifier

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

Config slots

These slots are top-level fields of the track config, alongside trackId and name. 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
Inherited from BaseTrack12 slots
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.