Skip to main content

JBrowseReactAppRootModel

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

note: many properties of the root model are available through the session, and we generally prefer using the session model (via e.g. getSession) over the root model (via e.g. getRoot) in plugin code

Members a composed model contributes are listed here too, so these tables are the whole surface.

Properties

MemberDescriptionDefined by
jbrowse
jbrowse: jbrowseModelType		jbrowse is a mapping of the config.json into the in-memory state treeBaseRootModel
session
session: types.maybe(sessionModelType)		session encompasses the currently active state of the app, including views open, tracks open in those views, etc.BaseRootModel
sessionPath
sessionPath: types.stripDefault(types.string, '')		BaseRootModel
assemblyManager
assemblyManager: types.optional(
        assemblyManagerFactory(assemblyConfigSchema, pluginManager),
        {},
      )
BaseRootModel
internetAccounts
internetAccounts: types.array(
        pluginManager.pluggableMstType('internet account', 'stateModel'),
      )
InternetAccountsMixin

Volatiles

MemberDescriptionDefined by
version
version		JBrowseReactAppRootModel
pluginsUpdated
pluginsUpdated: false		JBrowseReactAppRootModel
pluginsUpdatedCallback
pluginsUpdatedCallback: undefined as
        | ((args: PluginsUpdate) => void)
        | undefined
host hook for PluginsUpdated, set from createViewState's onPluginsUpdated. Undefined means the host didn't ask to handle it.JBrowseReactAppRootModel
rpcManager
rpcManager: new RpcManager(
        pluginManager,
        self.jbrowse.configuration.rpc,
        rpcManagerOptions,
      )
BaseRootModel
adminMode
adminMode: false		BaseRootModel
error
error: undefined as unknown		BaseRootModel
textSearchManager
textSearchManager: new TextSearchManager(pluginManager)		BaseRootModel
pluginManager
pluginManager		BaseRootModel
mutableMenuActions
mutableMenuActions: [] as MenuAction[]		RootAppMenuMixin

Methods

MemberDescription
menus
() => Menu[]

Actions

MemberDescriptionDefined by
setPluginsUpdated
() => void		JBrowseReactAppRootModel
setPluginsUpdatedCallback
(callback: (args: PluginsUpdate) => void) => void		JBrowseReactAppRootModel
setError
(error: unknown) => void		BaseRootModel
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.BaseRootModel
setDefaultSession
() => void		BaseRootModel
setSessionPath
(path: string) => void		BaseRootModel
renameCurrentSession
(newName: string) => void		BaseRootModel
initializeInternetAccount
(internetAccountConfig: ModelInstanceTypeProps<…> & {…} & IStateTreeNode<…>, initialSnapshot?: object) => any
InternetAccountsMixin
createEphemeralInternetAccount
(internetAccountId: string, initialSnapshot: Record<string, unknown>, url: string) => any
InternetAccountsMixin
findAppropriateInternetAccount
(location: UriLocation) => any		InternetAccountsMixin
setMenus
(newMenus: MenuDefinition[]) => void		Replace the menu bar wholesale. Item contributions recorded before this one are dropped along with the menus they targeted, so a plugin adding to the existing bar wants appendToMenu instead.RootAppMenuMixin
appendMenu
(menuName: string) => void		Add a top-level menu, if the app bar does not already have one with this name.RootAppMenuMixin
insertMenu
(menuName: string, position: number) => void		Insert a top-level menu, if the app bar does not already have one with this name.RootAppMenuMixin
appendToMenu
(menuName: string, menuItem: MenuItem) => void		Add a menu item to a top-level menu, creating the menu if it does not exist.RootAppMenuMixin
insertInMenu
(menuName: string, menuItem: MenuItem, position: number) => void		Insert a menu item into a top-level menu, creating the menu if it does not exist.RootAppMenuMixin
appendToSubMenu
(menuPath: string[], menuItem: MenuItem) => void		Add a menu item to a sub-menu, creating any part of the path that does not exist.RootAppMenuMixin
insertInSubMenu
(menuPath: string[], menuItem: MenuItem, position: number) => void
Insert a menu item into a sub-menu, creating any part of the path that does not exist.RootAppMenuMixin