Skip to main content

WebSessionConnectionsMixin

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

Adds connections that a user creates to a web session, kept in the session beside the connections the config declares.

Each section ends with the members a composed model contributes, linked to the page that documents them.

Properties

MemberDescription
sessionConnections
sessionConnections: types.stripDefault(
          types.array(pluginManager.pluggableConfigSchemaType('connection')),
          [],
        )
2 inherited properties from one model

From ConnectionManagementSessionMixin: connectionInstances, connectionTrackConfigs

Getters

MemberDescription
connections
(ConfigNodeProps<…> & ConfigNodeActions & ConfigNodeBrand<ConfigurationSchemaType<{ readonly name: { type: "string"; } & { defaultValue: string; }; readonly assemblyNames: { type: "stringArray"; } & { defaultValue: unknown; }; connectionId: { type: "string"; } & { defaultValue: string; }; type: { type: "string"; } & { defaultValue: string; }; }, ConfigurationSchemaOptions<undefined, "connectionId", true, ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>>)[]
list of config connections and session connections

Actions

MemberDescription
addSessionConnectionConf
(connectionConf: AnyConfiguration) => PluggableConfigNode & IStateTreeNode<PluggableConfigSchemaType>
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.
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.
deleteConnection
(configuration: AnyConfigurationModel) => any
9 inherited actions from one model

From ConnectionManagementSessionMixin: makeConnection, breakConnection, teardownConnection, clearConnections, captureConnectionTrack, updateConnectionTrackConfig, setConnectionTrackConfig, pruneConnectionTrackConfig, hydrateConnection