Skip to main content

EmbeddedRootModel

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

Root model shared by the single-view embedded products (react-linear-genome-view, react-circular-genome-view). Each product supplies its own model name, version, and session model, and may .props() on extra fields (e.g. the LGV disableAddTracks/drawerViewHeight). Internet accounts come from the same product-core mixin the web/desktop root models use, so config internetAccounts are auto-initialized (no manual wiring needed).

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

Properties

MemberDescriptionDefined by
config
config: createConfigModel(pluginManager, assemblyConfigSchema)		EmbeddedRootModel
session
session: sessionModelType		EmbeddedRootModel
assemblyManager
assemblyManager: types.optional(
          assemblyManagerFactory(assemblyConfigSchema, pluginManager),
          {},
        )
EmbeddedRootModel
internetAccounts
internetAccounts: types.array(
        pluginManager.pluggableMstType('internet account', 'stateModel'),
      )
InternetAccountsMixin

Volatiles

MemberDescription
error
error: undefined as unknown
adminMode
adminMode: false
version
version
rpcManager
rpcManager: new RpcManager(
          pluginManager,
          self.config.configuration.rpc,
          {
            makeWorkerInstance,
            
            
            defaultDriverName: makeWorkerInstance
              ? 'WebWorkerRpcDriver'
              : 'MainThreadRpcDriver',
          },
        )
textSearchManager
textSearchManager: new TextSearchManager(pluginManager)

Getters

MemberDescription
jbrowse
ModelPropertiesDeclarationToProperties<{ config: IModelType<…>; session: SESSION; assemblyManager: IOptionalIType<IModelType<…>, [undefined]>; }>["config"]["Type"]
pluginManager
PluginManager

Actions

MemberDescriptionDefined by
setSession
(sessionSnapshot: SnapshotIn<SESSION>) => void		EmbeddedRootModel
restoreSession
(sessionSnapshot: SessionSnapshot) => void		Load a session whose shape is only known at runtime — decoded from a URL, read back from storage, handed over by a non-TypeScript host.

Separate from setSession because that one takes the compiler-checked snapshot type, which a value parsed out of JSON can never satisfy. The assertion below is the whole reason this exists: it is the single place the conversion happens, instead of every caller asserting at its own site. Nothing is unchecked at runtime — MST validates the snapshot as it applies it and throws on a mismatch, which is the check that actually matters for a value this app did not author.		EmbeddedRootModel
renameCurrentSession
(sessionName: string) => void		EmbeddedRootModel
setError
(error: unknown) => void		EmbeddedRootModel
initializeInternetAccount
(internetAccountConfig: ModelInstanceTypeProps<…> & {…} & IStateTreeNode<…>, initialSnapshot?: object) => any
InternetAccountsMixin
createEphemeralInternetAccount
(internetAccountId: string, initialSnapshot: Record<string, unknown>, url: string) => any
InternetAccountsMixin
findAppropriateInternetAccount
(location: UriLocation) => any		InternetAccountsMixin