Skip to main content

Rows

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

Example usage

{ type: 'LinearWiggleDisplay', rows: 'source' }
{ type: 'LinearMultiRowFeatureDisplay', rows: 'sample' }
{
  type: 'LinearWiggleDisplay',
  rows: { field: 'source', domain: ['tumor', 'normal'], labels: { tumor: 'Tumor' } },
}

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

The rows setting of the displays that draw one row per value of a field, with the dendrogram sidebar beside them: the field, and the arrangement a reader gives the rows. A string is the field; the object adds the order, the labels, the tree with its provenance and the focus, each by value.

Config slots

These slots go on a display entry: "displays": [{ "type": "Rows", ... }], 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
field
featureField = ''		The field each value of which takes a row of its own. Writing rows: "source" lands here. Empty is the display's default: no rows on the quantitative display, and a field picked off the data on the multi-row feature display.
Inherited from RowArrangement5 slots
domain
stringArray = []		The row order: the rows listed lead, in this order, and the rest keep the order they arrived in. A clustering run, the arrangement dialog and "Sort rows here" all write it, and a run rotates its dendrogram towards it rather than discarding it.
labels
stringMap = {}		A label drawn beside a row in place of its name, by name.
tree
maybeString		The dendrogram beside the rows, as newick. A clustering run writes it beside the order it produced, and a reorder that moves a row drops it.
treeProvenance
maybeFrozen		What tree was computed from, the locus and the settings; unset for a tree that arrived as data.
kept
stringArray = []		The rows shown, by name: a clade picked off the tree, or the rows one key row stands for. Empty, or naming no current row, shows every row.