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.

Example usage

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

The facet of a display that stacks labelled sections, each of which a reader can hide from its chip: Facet's field and domain, 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.

Config slots

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 = []		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 each value of which packs its own 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. 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" lands here.
domain
stringArray = []		The values whose sections stack first, in order; the rest follow sorted. Empty stacks every section sorted, and a strand facet forward, reverse, then unstranded (1, -1, 0).