Gff3Adapter

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the gff3 plugin. View source.

Example usage#

{
  type: 'FeatureTrack',
  trackId: 'my_track',
  name: 'My track',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'Gff3Adapter',
    uri: 'https://example.com/genes.gff3',
  },
}

genes.gff3 infers Gff3Adapter and FeatureTrack on its own, and name defaults to the file name. In a config declaring one assembly, assemblyNames comes from there too — see the shortest track.

{
  trackId: 'my_track',
  uri: 'https://example.com/genes.gff3',
  assemblyNames: ['hg38'],
}

See the Config slots section below for all available configuration fields.

used to load plain-text GFF3 files. Loads the whole file into memory, so prefer the Gff3TabixAdapter for large files.

Related links#

• Track: FeatureTrack
• Display: LinearArcDisplay
• Display: LinearBasicDisplay
• Display: LinearMultiRowFeatureDisplay
• Display: LinearScoreDisplay
• Guide: Supported file types

Config slots#

These slots go inside the track's adapter: "adapter": { "type": "Gff3Adapter", ... }. It also accepts the shorthand keys uri, baseUri in place of writing a location slot out. 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.