JB2TrackHubConnection
Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the data-management plugin. View source.
Example usage
An entry in the config's connections, pointing at another JBrowse 2
config.json. Its tracks — and any assemblies it declares that the session
lacks — are added on connect, so one instance can publish a track set that
others subscribe to.
{
type: 'JB2TrackHubConnection',
connectionId: 'jb2_hub_example',
name: 'Shared JBrowse 2 tracks',
assemblyNames: ['hg38'],
configJsonLocation: { uri: 'https://example.com/jbrowse/config.json' },
}
See the Config slots section below for all available configuration fields.
Related links
- State model: runtime API
- Base config: BaseConnection
- Config guide: Connections
Config slots
These slots are top-level fields of the connection's entry in connections. 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 |
|---|---|
configJsonLocationfileLocation = | location of the jb2 config file (usually called config.json) |
assemblyNamesstringArray = [] | optional list of genomes to import from this config.json, if empty all genomes will be imported |
| Inherited from BaseConnection | 1 slot |
namestring = 'nameOfConnection' | a unique name for this connection |