Skip to main content

HierarchicalTrackSelectorWidget

Note: this document is automatically generated from 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

Source code

GitHub page

Docs

HierarchicalTrackSelectorWidget - Properties

property: id

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
id: ElementId

property: type

// type signature
ISimpleType<"HierarchicalTrackSelectorWidget">
// code
type: types.literal('HierarchicalTrackSelectorWidget')

property: view

// type signature
IMaybe<IReferenceType<IAnyType>>
// code
view: types.safeReference(
pluginManager.pluggableMstType('view', 'stateModel'),
)

property: faceted

// type signature
IOptionalIType<IModelType<{ filterText: IOptionalIType<ISimpleType<string>, [undefined]>; showSparse: IOptionalIType<ISimpleType<boolean>, [undefined]>; showFilters: IOptionalIType<...>; showOptions: IOptionalIType<...>; panelWidth: IOptionalIType<...>; }, { ...; } & ... 4 more ... & { ...; }, _NotCustomized, _NotCu...
// code
faceted: types.optional(facetedStateTreeF(), {})

HierarchicalTrackSelectorWidget - Getters

getter: shownTrackIds

// type
Set<string>

getter: selectionSet

// type
Set<{ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>>

getter: favoritesSet

// type
Set<string>

getter: recentlyUsedSet

// type
Set<string>

getter: assemblyNames

// type
string[]

getter: activeSortTrackNames

// type
any

getter: activeSortCategories

// type
any

getter: configAndSessionTrackConfigurations

filter out tracks that don't match the current assembly/display types

// type
({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[]

getter: allTrackConfigurations

// type
any[]

getter: allTrackConfigurationTrackIdSet

// type
Map<unknown, unknown>

getter: favoriteTracks

filters out tracks that are not in the favorites group

// type
unknown[]

getter: recentlyUsedTracks

filters out tracks that are not in the recently used group

// type
unknown[]

getter: allTracks

// type
{ group: any; tracks: ({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ ...; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[]; noCategories: boolean; menuItems: any[]; }[]

getter: hierarchy

// type
{ name: string; id: string; isOpenByDefault: boolean; type: "category"; children: { name: any; id: any; type: "category"; isOpenByDefault: boolean; menuItems: any[]; children: TreeNode[]; }[]; }

getter: hasAnySubcategories

// type
boolean

HierarchicalTrackSelectorWidget - Methods

method: isSelected

// type signature
isSelected: (track: { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>) => boolean

method: isFavorite

// type signature
isFavorite: (trackId: string) => boolean

method: isRecentlyUsed

// type signature
isRecentlyUsed: (trackId: string) => boolean

method: getRefSeqTrackConf

// type signature
getRefSeqTrackConf: (assemblyName: string) => { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ ...; } & ... 2 more ... & IStateTreeNode<...>); } & IStateTreeNode<...>

HierarchicalTrackSelectorWidget - Actions

action: setSortTrackNames

// type signature
setSortTrackNames: (val: boolean) => void

action: setSortCategories

// type signature
setSortCategories: (val: boolean) => void

action: setSelection

// type signature
setSelection: (elt: ({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[]) => void

action: addToSelection

// type signature
addToSelection: (elt: ({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[]) => void

action: removeFromSelection

// type signature
removeFromSelection: (elt: ({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[]) => void

action: clearSelection

// type signature
clearSelection: () => void

action: addToFavorites

// type signature
addToFavorites: (trackId: string) => void

action: removeFromFavorites

// type signature
removeFromFavorites: (trackId: string) => void

action: clearFavorites

// type signature
clearFavorites: () => void

action: setRecentlyUsedCounter

// type signature
setRecentlyUsedCounter: (val: number) => void

action: setRecentlyUsed

// type signature
setRecentlyUsed: (str: string[]) => void

action: setFavorites

// type signature
setFavorites: (str: string[]) => void

action: setFavoritesCounter

// type signature
setFavoritesCounter: (val: number) => void

action: addToRecentlyUsed

// type signature
addToRecentlyUsed: (id: string) => void

action: clearRecentlyUsed

// type signature
clearRecentlyUsed: () => void

action: setView

// type signature
setView: (view: unknown) => void

action: toggleCategory

// type signature
toggleCategory: (pathName: string) => void

action: setCategoryCollapsed

// type signature
setCategoryCollapsed: (pathName: string, status: boolean) => void

action: expandAllCategories

// type signature
expandAllCategories: () => void

action: setCollapsedCategories

// type signature
setCollapsedCategories: (str: [string, boolean][]) => void

action: clearFilterText

// type signature
clearFilterText: () => void

action: setFilterText

// type signature
setFilterText: (newText: string) => void

action: collapseSubCategories

// type signature
collapseSubCategories: () => void

action: collapseTopLevelCategories

// type signature
collapseTopLevelCategories: () => void