AssembliesMixin

Note: this document is automatically generated from @jbrowse/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

Docs

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

AssembliesMixin - Properties

property: sessionAssemblies

// type signature
IArrayType<ConfigurationSchemaType<{ aliases: { type: string; defaultValue: never[]; description: string; }; sequence: AnyConfigurationSchemaType; refNameColors: { type: string; defaultValue: never[]; description: string; }; refNameAliases: ConfigurationSchemaType<...>; cytobands: ConfigurationSchemaType<...>; displ...
// code
sessionAssemblies: types.array(assemblyConfigSchemasType)

property: temporaryAssemblies

// type signature
IArrayType<ConfigurationSchemaType<{ aliases: { type: string; defaultValue: never[]; description: string; }; sequence: AnyConfigurationSchemaType; refNameColors: { type: string; defaultValue: never[]; description: string; }; refNameAliases: ConfigurationSchemaType<...>; cytobands: ConfigurationSchemaType<...>; displ...
// code
temporaryAssemblies: types.array(assemblyConfigSchemasType)

AssembliesMixin - Actions

action: addSessionAssembly

// type signature
addSessionAssembly: (conf: AnyConfiguration) => { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<...> | ({ ...; } & ... 2 more ... & IStateTreeNode<...>); } & IStateTreeNode<...>

action: addAssembly

// type signature
addAssembly: (conf: AnyConfiguration) => void

action: removeAssembly

// type signature
removeAssembly: (name: string) => void

action: removeSessionAssembly

// type signature
removeSessionAssembly: (assemblyName: string) => void

action: addTemporaryAssembly

used for read vs ref type assemblies.

// type signature
addTemporaryAssembly: (conf: AnyConfiguration) => { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<...> | ({ ...; } & ... 2 more ... & IStateTreeNode<...>); } & IStateTreeNode<...>

action: removeTemporaryAssembly

// type signature
removeTemporaryAssembly: (name: string) => void