Skip to main content

BaseWebSession

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​

used for "web based" products, including jbrowse-web and react-app composed of

BaseWebSession - Properties​

property: margin​

// type signature
number
// code
margin: 0

property: sessionPlugins​

// type signature
IArrayType<IType<any, any, any>>
// code
sessionPlugins: types.array(types.frozen())

BaseWebSession - Getters​

getter: tracks​

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

getter: root​

// type
any

getter: assemblies​

list of sessionAssemblies and jbrowse config assemblies, does not include temporaryAssemblies. basically the list to be displayed in a AssemblySelector dropdown

// type
ConfigurationSchemaType<{ aliases: { type: string; defaultValue: any[]; description: string; }; sequence: AnyConfigurationSchemaType; refNameColors: { type: string; defaultValue: any[]; description: string; }; refNameAliases: ConfigurationSchemaType<...>; cytobands: ConfigurationSchemaType<...>; displayName: { ...; ...

getter: connections​

list of config connections and session connections

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

getter: assemblyNames​

list of sessionAssemblies and jbrowse config assemblies, does not include temporaryAssemblies. basically the list to be displayed in a AssemblySelector dropdown

// type
string[]

getter: version​

// type
any

getter: shareURL​

// type
any

getter: textSearchManager​

// type
TextSearchManager

getter: assemblyManager​

// type
{ assemblies: IMSTArray<IModelType<{ configuration: IMaybe<IReferenceType<IAnyType>>; }, { error: unknown; loadingP: Promise<void> | undefined; volatileRegions: BasicRegion[] | undefined; refNameAliases: RefNameAliases | undefined; lowerCaseRefNameAliases: RefNameAliases | undefined; cytobands: Feature[] | undefined...

getter: savedSessionMetadata​

// type
any

getter: previousAutosaveId​

// type
any

getter: history​

// type
any

BaseWebSession - Methods​

method: renderProps​

// type signature
renderProps: () => {
  theme: Theme
  highResolutionScaling: any
}

method: getTrackActionMenuItems​

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

method: menus​

// type signature
menus: () => Menu[]

BaseWebSession - Actions​

action: setName​

// type signature
setName: (str: string) => void

action: addAssemblyConf​

// type signature
addAssemblyConf: (conf: AnyConfiguration) => void

action: addSessionPlugin​

// type signature
addSessionPlugin: (plugin: JBrowsePlugin) => void

action: removeSessionPlugin​

// type signature
removeSessionPlugin: (pluginDefinition: PluginDefinition) => void

action: addSavedSession​

// type signature
addSavedSession: (sessionSnapshot: ModelCreationType<ExtractCFromProps<{ drawerPosition: IOptionalIType<ISimpleType<string>, [undefined]>; drawerWidth: IOptionalIType<ISimpleType<number>, [undefined]>; widgets: IMapType<...>; activeWidgets: IMapType<...>; minimized: IOptionalIType<...>; } & ... 8 more ... & { ...; }>>) => any

action: deleteSavedSession​

// type signature
deleteSavedSession: (id: string) => any

action: favoriteSavedSession​

// type signature
favoriteSavedSession: (id: string) => any

action: unfavoriteSavedSession​

// type signature
unfavoriteSavedSession: (id: string) => any

action: renameCurrentSession​

// type signature
renameCurrentSession: (sessionName: string) => any

action: duplicateCurrentSession​

// type signature
duplicateCurrentSession: () => any

action: activateSession​

// type signature
activateSession: (sessionName: string) => any

action: setDefaultSession​

// type signature
setDefaultSession: () => any

action: saveSessionToLocalStorage​

// type signature
saveSessionToLocalStorage: () => any

action: loadAutosaveSession​

// type signature
loadAutosaveSession: () => any

action: setSession​

// type signature
setSession: (sessionSnapshot: ModelCreationType<ExtractCFromProps<{ drawerPosition: IOptionalIType<ISimpleType<string>, [undefined]>; drawerWidth: IOptionalIType<ISimpleType<number>, [undefined]>; widgets: IMapType<...>; activeWidgets: IMapType<...>; minimized: IOptionalIType<...>; } & ... 8 more ... & { ...; }>>) => any

action: editTrackConfiguration​

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