WebSessionConnectionsMixin
Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Built into JBrowse core. View source.
Members a composed model contributes are listed here too, so these tables are the whole surface.
Properties
| Member | Description | Defined by |
|---|---|---|
| sessionConnections | WebSessionConnectionsMixin | |
| connectionInstances | ConnectionManagementSessionMixin | |
| connectionTrackConfigs | Persisted configs of connection tracks the user has opened, keyed by trackId. Unlike connectionInstances (stripped from snapshots, holds the whole fetched hub), this holds only the tracks in use, so an open connection track resolves synchronously on session load without re-establishing the connection. | ConnectionManagementSessionMixin |
Getters
| Member | Description | Defined by |
|---|---|---|
| connections | ConnectionManagementSessionMixin |
Actions
| Member | Description | Defined by |
|---|---|---|
addSessionConnectionConf(connectionConf: AnyConfiguration) => any | Add a connection config to this session: it lands in sessionConnections, travels with the session when it is saved or shared, and never reaches the config.json the server hands every visitor. Idempotent on connectionId.This is the one to call when the connection belongs to the session being built — a &hubURL= link, a session spec's sessionConnections — no matter who is looking. addConnectionConf below is the one whose destination depends on that. | WebSessionConnectionsMixin |
addConnectionConf(connectionConf: AnyConfiguration) => any | Add a connection config wherever this user's edits belong: an admin's into the shared config (jbrowse.connections, which the admin server writes back into config.json for every visitor), everyone else's into the session. Two destinations behind one name, so call it only where that really is the intent — the "Open connection..." dialog, where an admin adding a hub means to add it for the whole site. Anything that means one destination should say which: addSessionConnectionConf above for the session, jbrowse.addConnectionConf for the config. | WebSessionConnectionsMixin |
| deleteConnection | WebSessionConnectionsMixin | |
| makeConnection | ConnectionManagementSessionMixin | |
| breakConnection | Remove a live connection instance. Tolerant of an already-dormant connection (its instance is stripped from the session on reload). Leaves persisted open-track configs alone — the connect() error path calls this and the user's already-open tracks must survive a transient failure. Full removal goes through deleteConnection. | ConnectionManagementSessionMixin |
| teardownConnection | Close every track a connection contributed — the live instance's tracks plus any persisted open-track configs (a dormant connection, never expanded this session, still renders its opened tracks from connectionTrackConfigs) — from all views/widgets, drop the live instance, and drop the persisted configs. The session is left as if the connection had never loaded. | ConnectionManagementSessionMixin |
clearConnections() => void | ConnectionManagementSessionMixin | |
captureConnectionTrack(trackId: string) => void | Snapshot a just-opened connection track's config into connectionTrackConfigs so it survives session reload. No-op if the track isn't connection-provided or is already captured (edits go through updateConnectionTrackConfig). | ConnectionManagementSessionMixin |
| updateConnectionTrackConfig | Persist an edit to an opened connection track. The full config is stored (not a delta): the connection's fetched "base" isn't present at load, so only a complete config resolves synchronously. | ConnectionManagementSessionMixin |
| setConnectionTrackConfig | Upsert one opened connection track's persisted config. | ConnectionManagementSessionMixin |
pruneConnectionTrackConfig(trackId: string) => void | Drop a connection track's persisted config once no open view still references it, so the session doesn't accumulate closed tracks. | ConnectionManagementSessionMixin |
hydrateConnection(connectionId: string) => void | Lazily establish a single connection by id if it isn't already live — used when its category is expanded in the track selector. Fetches silently (no view launch / success snackbar); already-open tracks keep rendering from connectionTrackConfigs meanwhile. Idempotent. | ConnectionManagementSessionMixin |