Skip to main content

AssembliesMixin

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

Adds sessionAssemblies (admin-aware, persisted-with-session assemblies) and temporaryAssemblies (used for ad-hoc read-vs-ref style assemblies).

Properties

MemberDescription
sessionAssemblies
sessionAssemblies: types.stripDefault(
        types.array(assemblyConfigSchemasType),
        [],
      )
temporaryAssemblies
temporaryAssemblies: types.stripDefault(
        types.array(assemblyConfigSchemasType),
        [],
      )

Getters

MemberDescription
assemblies
(ModelInstanceTypeProps<…> & { setSubschema(slotName: string, data: Record<string, unknown>): any; setSlot(slotName: string, value: unknown): void; } & IStateTreeNode<...>)[]
sessionAssemblies plus jbrowse config assemblies. Does not include temporaryAssemblies; this is the list shown in the AssemblySelector dropdown.
assemblyNames
string[]		names of the assemblies returned by the assemblies getter

Methods

MemberDescription
findAssemblyConf
(name: unknown) => (ModelInstanceTypeProps<…> & {…} & IStateTreeNode<…>) | undefined
The assembly config already carrying name, from any of the three arrays the assemblyManager draws on, or undefined.

One namespace, because name is the assembly config's MST identifier: a second config carrying a name one of the others already has doesn't fail at the add, it makes every assembly.configuration safeReference in the manager ambiguous, and MST then throws on every read of one — inside the manager's own autorun and inside assemblyNameMap, which takes the session down. So each add path checks all three, not just the array it pushes to.

Actions

MemberDescription
addSessionAssembly
(conf: AnyConfiguration) => ModelInstanceTypeProps<…> & {…} & IStateTreeNode<…>
addAssembly
(conf: AnyConfiguration) => void
removeAssembly
(name: string) => void
removeSessionAssembly
(assemblyName: string) => void
addTemporaryAssembly
(conf: AnyConfiguration) => ModelInstanceTypeProps<…> & {…} & IStateTreeNode<…>
used for read vs ref type assemblies.
removeTemporaryAssembly
(name: string) => void