Skip to main content

JBrowseConfiguration

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

this is the entry under the configuration key e.g.

{
  assemblies,
  tracks,
  configuration: { these entries here  }
}

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
configuration.rpc
RpcManager.configSchema		configuration for the RPC system that runs data adapters in web workers, see RpcOptions
configuration.formatDetails
FormatDetailsConfigSchemaFactory()		jexl callbacks that add, rewrite or hide fields in the feature-details panel of every track at once. Four slots, listed at FormatDetails; a track can set the same ones on its own formatDetails and override individual keys.
configuration.formatAbout
FormatAboutConfigSchemaFactory()		jexl callbacks that add, rewrite or hide fields in the About dialog of every track at once. Two slots, listed at FormatAbout; a track can set the same ones on its own formatAbout and override individual keys.
configuration.shareURL
string = 'https://share.jbrowse.org/api/v1/'		URL of the session-sharing backend used by the Share button, a JBrowse-hosted service by default
advanced
configuration.disableAnalytics
boolean = false		disables collection of anonymous usage analytics
advanced
configuration.hierarchical
HierarchicalConfigSchemaFactory()		configuration for the hierarchical track selector, controlling sorting and default categories, see HierarchicalConfigSchema
configuration.preferences
PreferencesConfigSchemaFactory()		user preferences such as scroll-to-zoom and animation behavior, see PreferencesConfigSchema
configuration.theme
frozen = {}		Material UI theme overrides applied to the JBrowse UI
configuration.extraThemes
frozen = {}		additional named themes the user can switch between
advanced
configuration.logoPath
fileLocation = { uri: '', locationType: 'UriLocation' }		path to a custom logo image displayed in the app header
advanced