Skip to main content

SectionFacet

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

The facet of a display that stacks labelled sections, each of which a reader can hide from its chip: Facet's field and sort, and the sections hidden. A hide-set rather than a show-set, so a section a later region discovers shows; a new field starts with none hidden. Only here, since the row displays' Facet reads no hidden band.

Example usage

{
  type: 'LinearBasicDisplay',
  facet: { field: 'gene_biotype', hidden: ['misc_RNA'] },
}

Config slots

A setting written to it replaces it whole, since its members are alternatives: a member left out returns to its default. 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
hidden
stringArray of strings or numbers = []		The keys of the sections hidden from the stack, as a section chip's Hide writes them; "Show all" clears it.
Inherited from Facet2 slots
field
featureField = ''		The feature field whose values each get a labelled section of the track: a field name, a dotted path into a structured field (INFO.SVTYPE, a read's tags.HP), a jexl: expression, or strand. A feature with no value stacks last, under field: none ((no value) for a jexl: field, whose sections show the value alone). The multi-sample variant displays read a sample attribute instead, and the multi-row display group, its rowGroups. The alignments displays also take a read dimension here: firstOfPairStrand, pairOrientation, pairing, split, spliced, mapq, mateRefName or mateAssembly. Writing facet: "strand" sets this slot.
sort
stringArray of strings or numbers = []		The values whose sections stack first, in order, as Vega-Lite's sort lists them: the rest follow sorted, and none is dropped. Empty stacks every section sorted, and a strand facet forward, reverse, then unstranded (1, -1, 0).