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'] },
}Related links
Config slots
A setting written to it names members one by one: a member left out stays as it is, and null resets one. One that changes field first clears sort, hidden, which name the old values, except those it states. 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.
| Slot | Description |
|---|---|
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 Facet | 2 slots |
fieldfeatureField = '' |
A feature field, or on a row display a row attribute, 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 variant display's row attribute is a sample attribute, and the mark displays' is group, their rows.groups. The alignments displays also take a read dimension here: firstOfPairStrand, pairOrientation, pairing, split, spliced, mapq, mateRefName, alignedRefNames (the set of references a read's chain aligns to) or mateAssembly. Writing facet: "strand" sets this slot. |
sortstringArray 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). |