Skip to main content

RowArrangement

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

Example usage

{
  type: 'LinearMultiSampleVariantDisplay',
  rows: { domain: ['NA12878', 'NA12891'], labels: { NA12878: 'Proband' } },
}

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

The rows setting of a display whose rows are its own — a sample, a species — rather than the values of a field: the arrangement a reader gives them, which every product writes as a session edit to this object. The order, the labels, the tree with its provenance and the focus, each by row name. The field-keyed displays' Rows object is this plus field.

Config slots

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