Skip to main content

FormatAbout

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

Holds jexl callbacks that add, rewrite or hide fields in a track's About dialog. Every track has this schema, and so does the root config as configuration.formatAbout, which applies to every track at once. Where both are set the track's object is spread over the session's, so a track can override individual keys the global callback added.

Example usage

On a track. The callback's variable is config, not feature, since the dialog shows the track's configuration and no feature:

{
  type: 'FeatureTrack',
  trackId: 'genes',
  name: 'Genes',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'Gff3TabixAdapter',
    uri: 'https://example.com/genes.gff.gz',
  },
  formatAbout: {
    hideUris: true,
    config: "jexl:{Source:'GENCODE v44', adapter:undefined}",
  },
}

Config slots

A setting written to it names members one by one: a member left out stays as it is, and null resets one. 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
formatAbout.config
frozen = {}		callback returning an object of fields to merge over the config shown
callback args: config
formatAbout.hideUris
boolean = false		leave file locations out of the About dialog, for a deployment that would rather not show users where the data sits. Hides URIs and local paths alike, drops the "Copy config" button, and suppresses the File info panel — a BAM's @SQ UR: and @PG CL: lines are locations too. "Show ref names" stays, since it exposes none. The two tiers are OR'd, so a session-wide true cannot be turned back on by a track. It hides the locations from the dialog only, not from config.json