Skip to main content

BaseConnectionModel

Auto-generated from the @jbrowse/mobx-state-tree model in the source. See the developer guide for concepts. Built into JBrowse core. View source.

Holds the tracks a connection has loaded. Each connection type overrides connect to fetch them from its source.

Properties

Member Description
tracks
types.array(pluginManager.pluggableConfigSchemaType('track'))
configuration
ConfigurationReference(configSchema)
silent
types.optional(types.boolean, false)		 set when the connection is being re-established on session load (its open tracks are already restored from connectionTrackConfigs), so doConnect suppresses first-connect side effects like launching a view or a success snackbar. Runtime-only: connection instances aren't serialized.

Volatiles

Member Description
loading
boolean		 true while connect() is fetching this connection's tracks; drives a loading affordance in the track selector. Distinct from an empty tracks array, which is also the state of a connection that loaded successfully but has no tracks.

Getters

Member Description
connectionId
string		 the connection's unique id, resolved from its configuration (the config is the source of truth; connection names are not guaranteed unique)
name
string

Actions

Member Description
connect
() => Promise<void>		 no-op hook; concrete connections (UCSC/JB2 track hubs, etc.) override this to fetch and populate their tracks. Returns a promise so afterAttach can clear the loading flag once the fetch settles.
setLoading
(loading: boolean) => void
addTrackConf
(trackConf: TrackConf) => ConfigNodeProps<TrackConfigDefinition> & ConfigNodeActions & ConfigNodeBrand<TrackConfigSchema> & { readonly [key: string]: unknown; }
addTrackConfs
(trackConfs: TrackConf[]) => void
setTrackConfs
(trackConfs: TrackConf[]) => void