Skip to main content

EmbeddedRootModel

Auto-generated from the @jbrowse/mobx-state-tree model in the source — see the developer guide 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 the 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).

Each section ends with the members a composed model contributes, linked to the page that documents them.

Properties

MemberDescription
config
config: createConfigModel(pluginManager, assemblyConfigSchema)
session
session: sessionModelType
assemblyManager
assemblyManager: types.optional(
            assemblyManagerFactory(assemblyConfigSchema, pluginManager),
            {},
          )
1 inherited property from one model

From InternetAccountsMixin: internetAccounts

Volatiles

MemberDescription
adminMode
boolean
version
string
rpcManager
RpcManager
textSearchManager
TextSearchManager

Getters

MemberDescription
jbrowse
ModelPropertiesDeclarationToProperties<{ config: IModelType<…>; session: SESSION; assemblyManager: IOptionalIType<IModelType<{…}, {…} & {…} & {…} & {…} & {…} & { afterAttach(): void; removeAssembly(asm: Assembly): void; addAssembly(configuration: any): void; }, _NotCustomized, _NotCustomized>, [undefined]>; }>["config"]["Type"]
pluginManager
PluginManager

Actions

MemberDescription
setSession
(sessionSnapshot: SnapshotIn<SESSION>) => void		Synchronous: an async caller must await pluginManager.preloadSessionTypes(snapshot) first.
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. This method exists to hold the one assertion below, so callers do not each assert at their call site. At runtime MST validates the snapshot as it applies it and throws on a mismatch, which is the check that matters for a value this app did not author.
renameCurrentSession
(sessionName: string) => void
3 inherited actions from one model

From InternetAccountsMixin: initializeInternetAccount, createEphemeralInternetAccount, findAppropriateInternetAccount