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

Source file​

packages/product-core/src/Session/BaseSession.ts

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: unknown): any; } & IStateTreeNode<ConfigurationSchemaType<{ aliases: { type: string; defaultValue: any[]; description: string; }; sequence: AnyConfigurationSchemaType; refNameColors: { ...; }; refNameAliases: ConfigurationSchemaType<......

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