Skip to main content

JBrowseRootConfig

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Built into JBrowse core. View source.

this is a config model representing a config.json (for jbrowse-web) or somefile.jbrowse (for jbrowse-desktop, where configs have the .jbrowse extension)

also includes any pluginManager.pluginConfigurationSchemas(), so plugins that have a configurationSchema field on their class are mixed into this object

Config slots

Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.

SlotDescription
plugins
types.array(types.frozen<PluginDefinition>())		defines plugins of the format typescript type PluginDefinition= { umdUrl: string, name:string } | { url: string, name: string } | { esmUrl: string } | { cjsUrl: string } | { umdLoc: { uri: string } } | { esmLoc: { uri: string } } |
assemblies
types.array(assemblyConfigSchema)		configuration of the assemblies in the instance, see BaseAssembly
tracks
types.frozen([] as { trackId: string; [key: string]: unknown }[])
track configuration is an array of track config schemas. multiple instances of a track can exist that use the same configuration. Always uses frozen for performance - editing creates temporary MST models.
internetAccounts
types.array(
  pluginManager.pluggableConfigSchemaType('internet account'),
)
configuration for internet accounts, see InternetAccounts
aggregateTextSearchAdapters
types.array(
  pluginManager.pluggableConfigSchemaType('text search adapter'),
)
configuration for aggregate text search adapters (created by e.g. jbrowse text-index, but can be a pluggable TextSearchAdapter type)
connections
types.array(
  pluginManager.pluggableConfigSchemaType('connection'),
)
configuration for connections
defaultSession
types.optional(types.frozen(), { name: 'New Session', })		the session loaded when no session is otherwise specified, e.g. the initial view shown on first load
preConfiguredSessions
types.array(types.frozen())		named sessions bundled with the config that a user can open from the session selector