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

Source file​

packages/web-core/src/BaseWebSession/index.ts

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: unknown): any; } & IStateTreeNode<AnyConfigurationSchemaType>)[]

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: unknown): any; } & IStateTreeNode<ConfigurationSchemaType<{ name: { type: string; defaultValue: string; description: string; }; assemblyNames: { ...; }; }, ConfigurationSchemaOptions<...>>>)[]

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; loaded: boolean; loadingP: Promise<void>; volatileRegions: BasicRegion[]; refNameAliases: RefNameAliases; lowerCaseRefNameAliases: RefNameAliases; cytobands: Feature[]; } & ... 5 more ... & { ...; }, _NotCustom...

getter: savedSessions​

// type
any

getter: previousAutosaveId​

// type
any

getter: savedSessionNames​

// type
any

getter: history​

// type
any

getter: menus​

// 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: unknown): any; } & IStateTreeNode<ConfigurationSchemaType<{ name: { description: string; type: string; defaultValue: string; }; ... 8 more ...; formatAbout: ConfigurationSchemaType<...>; }, ConfigurationSchemaOptions<...>>>) => ...

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: removeSavedSession​

// type signature
removeSavedSession: (sessionSnapshot: { name: 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: unknown): any; } & IStateTreeNode<AnyConfigurationSchemaType>) => void