Skip to main content

BaseRootModel

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​

factory function for the Base-level root model shared by all products

BaseRootModel - Properties​

property: jbrowse​

jbrowse is a mapping of the config.json into the in-memory state tree

// type signature
IAnyType
// code
jbrowse: jbrowseModelType

property: session​

session encompasses the currently active state of the app, including views open, tracks open in those views, etc.

// type signature
IMaybe<IAnyType>
// code
session: types.maybe(sessionModelType)

property: sessionPath​

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
sessionPath: types.optional(types.string, '')

property: assemblyManager​

// type signature
IOptionalIType<IModelType<{ assemblies: IArrayType<IModelType<{ configuration: IMaybe<IReferenceType<IAnyType>>; }, { error: unknown; loadingP: Promise<void> | undefined; volatileRegions: BasicRegion[] | undefined; refNameAliases: RefNameAliases | undefined; lowerCaseRefNameAliases: RefNameAliases | undefined; cytob...
// code
assemblyManager: types.optional(
        assemblyManagerFactory(assemblyConfigSchema, pluginManager),
        {},
      )

BaseRootModel - Actions​

action: setError​

// type signature
setError: (error: unknown) => void

action: setSession​

// type signature
setSession: (sessionSnapshot?: any) => void

action: setDefaultSession​

// type signature
setDefaultSession: () => void

action: setSessionPath​

// type signature
setSessionPath: (path: string) => void

action: renameCurrentSession​

// type signature
renameCurrentSession: (newName: string) => void