Skip to main content

BaseSessionModel

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​

base session shared by all JBrowse products. Be careful what you include here, everything will use it.

BaseSessionModel - Properties​

property: id​

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

property: name​

// type signature
ISimpleType<string>
// code
name: types.string

property: margin​

// type signature
number
// code
margin: 0

BaseSessionModel - Getters​

getter: root​

// type
TypeOrStateTreeNodeToStateTreeNode<ROOT_MODEL_TYPE>

getter: jbrowse​

// type
any

getter: rpcManager​

// type
RpcManager

getter: configuration​

// type
Instance<JB_CONFIG_SCHEMA>

getter: adminMode​

// type
boolean

getter: textSearchManager​

// type
TextSearchManager

getter: assemblies​

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

BaseSessionModel - Actions​

action: setSelection​

set the global selection, i.e. the globally-selected object. can be a feature, a view, just about anything

// type signature
setSelection: (thing: unknown) => void

action: clearSelection​

clears the global selection

// type signature
clearSelection: () => void

action: setHovered​

// type signature
setHovered: (thing: unknown) => void