HiddenGroupsMixin
Auto-generated from the @jbrowse/mobx-state-tree model in the source — see the developer guide for concepts. Built into JBrowse core. View source.
The sections a reader hid from an in-track grouping's chips: the facet.hidden keys while the stack groups by the facet's field, hideGroup and showAllGroups writing them, hiddenGroupKeys reading them, groupStateKey (with the ownGroupState hook) for a live figure to key on, and the dropGroupState reset that fires when the host's groupKeySpace moves
The hidden sections are config, facet.hidden, so they ride a session and
a share link, and a new field written whole starts with none. A key names
a section only within the grouping that issued it, '' being both the
ungrouped section and every field's catch-all, so they apply only while
the stack groups by facet.field: where a mode degrades the grouping (an
alignments chain beside a per-read facet) they wait unread. A display
that keeps volatile per-group state overrides dropGroupState,
which the reset calls.
Getters
| Member | Description |
|---|---|
ownGroupStateunknown | Overridable hook: the per-group state a display keeps beyond the hidden sections, as a plain value. undefined by default; alignments returns its collapses and height overrides, the state its dropGroupState clears. |
ReadonlySet<string> | The sections the user hid: facet.hidden, while the stack groups by the facet's field. |
ReadonlySet<string> | Every key the stack drops. A fresh Set per change, so a layout memo comparing its inputs by identity sees a hide. |
groupStateKeyunknown | All the per-group state as a plain, comparable value: the hidden sections, sorted, beside ownGroupState. A live figure keys on it, since a display's own state is volatile and in no snapshot; a Set would serialize as {}. |
Actions
| Member | Description |
|---|---|
hideGroup(key: string) => void | Drop a section from the stack. Reversed by showAllGroups, which the "Show..." menu offers while anything is hidden, since a hidden section has no chip to restore it. |
showAllGroups() => void | |
dropGroupState() => void | Overridable hook: forget the volatile per-group state a display keeps. A no-op by default, since the hidden sections are config. |