Skip to main content

JBrowseRootConfig

Auto-generated from the config schema in the source. See the config guide for concepts. Built into JBrowse core. View source.

Holds a whole JBrowse config file: the config.json of jbrowse-web, or a file with the .jbrowse extension in jbrowse-desktop.

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.

Slot Description
plugins
types.array(types.frozen<PluginDefinition>())		 defines plugins of the format
type PluginDefinition=
   { umdUrl: string, name:string } |
   { url: string, name: string } |
   { esmUrl: string } |
   { umdLoc: { uri: string } } |
   { esmLoc: { uri: string } } |
   { storePlugin: string }
assemblies
types.array(assemblyConfigSchema)		 configuration of the assemblies in the instance, see BaseAssembly
tracks
types.frozen([] as TrackConfigEntry[])		 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
list of internet account configs		 configuration for internet accounts, see InternetAccounts
aggregateTextSearchAdapters
list of text search adapter configs		 search indexes covering whole assemblies, as jbrowse text-index writes them or any pluggable text search adapter. A trix index can be just its .ix (["trix/hg38.ix"]), which takes the config's assembly when it has one; with several, write { uri, assemblyNames }.
connections
list of connection configs		 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