Skip to main content

BaseRootModel

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Built into JBrowse core. View source.

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

Properties

MemberDescription
jbrowse
jbrowse: jbrowseModelType		jbrowse is a mapping of the config.json into the in-memory state tree
session
session: types.maybe(sessionModelType)		session encompasses the currently active state of the app, including views open, tracks open in those views, etc.
sessionPath
sessionPath: types.stripDefault(types.string, '')
assemblyManager
assemblyManager: types.optional(
        assemblyManagerFactory(assemblyConfigSchema, pluginManager),
        {},
      )

Volatiles

MemberDescription
rpcManager
rpcManager: new RpcManager(
        pluginManager,
        self.jbrowse.configuration.rpc,
        rpcManagerOptions,
      )
adminMode
adminMode: false
error
error: undefined as unknown
textSearchManager
textSearchManager: new TextSearchManager(pluginManager)
pluginManager
pluginManager

Actions

MemberDescription
setError
(error: unknown) => void
setSession
(sessionSnapshot?: any) => void		Sets the active session. Remaps any legacy display type names (e.g. LinearPileupDisplay → LinearAlignmentsDisplay), drops nodes whose pluggable type this build has no plugin for (see pruneUnbuildableNodes), then walks the resulting MST tree to drop open tracks whose config can't hydrate so shared sessions still load when referencing tracks that no longer exist. Both kinds of drop are surfaced to the user via a snackbar. If filtering throws, the previous session is restored.
setDefaultSession
() => void
setSessionPath
(path: string) => void
renameCurrentSession
(newName: string) => void