FacetedModel
Note: this document is automatically generated from @jbrowse/mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info
Also note: this document represents the state model API for the current released version of jbrowse. If you are not using the current version, please cross reference the markdown files in our repo of the checked out git tag
Links
Docs
FacetedModel - Properties
property: filterText
// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
filterText: types.optional(types.string, '')
property: showSparse
// type signature
IOptionalIType<ISimpleType<boolean>, [undefined]>
// code
showSparse: types.optional(types.boolean, () =>
localStorageGetBoolean('facet-showSparse', false),
)
property: showFilters
// type signature
IOptionalIType<ISimpleType<boolean>, [undefined]>
// code
showFilters: types.optional(types.boolean, () =>
localStorageGetBoolean('facet-showFilters', true),
)
property: showOptions
// type signature
IOptionalIType<ISimpleType<boolean>, [undefined]>
// code
showOptions: types.optional(types.boolean, () =>
localStorageGetBoolean('facet-showTableOptions', false),
)
property: panelWidth
// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
panelWidth: types.optional(types.number, () =>
localStorageGetNumber('facet-panelWidth', 400),
)
FacetedModel - Getters
getter: allTrackConfigurations
// type
({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[]
getter: allRows
Builds row objects from track configs. Cached and only recomputes when track configurations change, not on every filterText keystroke.
// type
{ readonly id: string; readonly conf: { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ ...; } & ... 2 more ... & IStateTreeNode<...>); } & IStateTreeNode<...>; ... 4 more ...; readonly metadata: Record<...>; }[]
getter: rows
Text-filtered rows. Cheap string filtering on already-built allRows.
// type
{ readonly id: string; readonly conf: { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ ...; } & ... 2 more ... & IStateTreeNode<...>); } & IStateTreeNode<...>; ... 4 more ...; readonly metadata: Record<...>; }[]
getter: filteredNonMetadataKeys
// type
string[] | readonly ["category", "adapter", "description"]
getter: metadataKeys
// type
string[]
getter: filteredMetadataKeys
// type
string[]
getter: fields
// type
string[]
getter: filteredRows
// type
{ readonly id: string; readonly conf: { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ ...; } & ... 2 more ... & IStateTreeNode<...>); } & IStateTreeNode<...>; ... 4 more ...; readonly metadata: Record<...>; }[]
FacetedModel - Actions
action: setTrackConfigurations
// type signature
setTrackConfigurations: (tracks: ({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[], session: AbstractSessionModel) => void
action: setFilter
// type signature
setFilter: (key: string, value: string[]) => void
action: setPanelWidth
// type signature
setPanelWidth: (width: number) => number
action: setUseShoppingCart
// type signature
setUseShoppingCart: (f: boolean) => void
action: setFilterText
// type signature
setFilterText: (str: string) => void
action: setShowSparse
// type signature
setShowSparse: (f: boolean) => void
action: setShowOptions
// type signature
setShowOptions: (f: boolean) => void
action: setShowFilters
// type signature
setShowFilters: (f: boolean) => void
action: setVisible
// type signature
setVisible: (args: Record<string, boolean>) => void