JBrowseReactAppRootModel

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

Links

Source code

GitHub page

Docs

composed of

• BaseRootModel
• InternetAccountsMixin
• RootAppMenuMixin

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

JBrowseReactAppRootModel - Methods

method: menus

// type signature
menus: () => Menu[]

JBrowseReactAppRootModel - Actions

action: setSession

// type signature
setSession: (sessionSnapshot?: ModelCreationType<ExtractCFromProps<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; name: ISimpleType<string>; margin: IType<number, number, number>; }>>) => void

action: setPluginsUpdated

// type signature
setPluginsUpdated: (flag: boolean) => void

action: setDefaultSession

// type signature
setDefaultSession: () => void

action: renameCurrentSession

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

action: setError

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