TracksManagerSessionMixin

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

Source code

GitHub page

Docs

composed of

  • BaseSessionModel
  • ReferenceManagementSessionMixin

TracksManagerSessionMixin - Getters

getter: tracks

// type
({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>)[]

getter: assemblies

Base assemblies from jbrowse config. Child sessions can override to include additional assemblies (e.g. sessionAssemblies).

// type
{
  sequence: {
    trackId: string
  }
}
;[]

getter: getTracksById

Map of trackId → config for all tracks, assemblies, and connections. Frozen jbrowse.tracks are returned as plain objects here; hydration to MST models happens lazily in TrackConfigurationReference on first access. MobX caches this until any dependency changes.

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

getter: tracksById

MobX-cached map of trackId → config for all tracks, assemblies, and connections. Recomputes only when dependencies change.

// type
Record<string, { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>>

TracksManagerSessionMixin - Actions

action: addTrackConf

// type signature
addTrackConf: (trackConf: AnyConfiguration) => any

action: deleteTrackConf

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