JBrowseWebSessionModel
Auto-generated from the @jbrowse/mobx-state-tree model in the source — see the developer guide for concepts. View source.
The full-app web session: the shared web session plus the saved-session database management surface (favorites, recent sessions, activate/delete) and the permanent plugin list.
Each section ends with the members a composed model contributes, linked to the page that documents them.
Properties
33 inherited properties from 9 models
From BaseWebSessionModel: sessionPlugins
From MultipleViewsSessionMixin: views, stickyViewHeaders
From BaseSessionModel: id, name, focusedViewId, highlights, highlightsVisible, highlightLabelsVisible, heldForMissingPlugins
From DrawerWidgetSessionMixin: drawerPosition, drawerWidth, widgets, activeWidgets, minimized
From SessionTracksManagerSessionMixin: sessionTracks, trackConfigDeltas
From AssembliesMixin: sessionAssemblies, temporaryAssemblies
From WebSessionConnectionsMixin: sessionConnections
From ConnectionManagementSessionMixin: connectionInstances, connectionTrackConfigs
From WorkspaceLayoutMixin: viewIds, title, size, tabs, activeTabId, size, direction, children, layout, activePanelId, maximizedPanelId
Volatiles
| Member | Description |
|---|---|
permanentPluginsPermanentPluginEntry[] | the plugins installed for this config on this browser, mirrored from localStorage. Volatile rather than a view over storage, because a view is a MobX computed and this one would read no observable: it would compute once inside the plugin store's observer and cache the list forever. And volatile rather than a property, because the list belongs to the browser rather than to this session — sharing or exporting a session must not carry it. |
permanentPluginsSafeMode{ reason: SafeModeReason; suspects: string[]; } | undefined | why this load skipped the list, or undefined when it loaded them, decided once at boot |
12 inherited volatiles from 6 models
From BaseWebSessionModel: pendingFileHandleIds
From ThemeManagerSessionMixin: systemPrefersDark, darkReaderDark
From BaseSessionModel: selection, hovered, queueOfDialogs, preferencesOverrides
From SnackbarModel: snackbarMessages, errorDialog
Getters
40 inherited getters from 11 models
From BaseWebSessionModel: root, , textSearchManager
From ThemeManagerSessionMixin: themeName, themeMode, selectedThemeMode, effectiveThemeMode, themeIsDark, themeOptions, palette, styleTheme, theme
From BaseSessionModel: jbrowse, rpcManager, configuration, adminMode, assemblies, DialogComponent, DialogProps, animationMode, scrollZoom, numberGrouping
From SnackbarModel: snackbarMessageSet
From DrawerWidgetSessionMixin: visibleWidget, drawerVisible, modalWidgetVisible
From SessionTracksManagerSessionMixin: trackBasesById, tracks, promotableTrackIds
From AssembliesMixin: assemblyNames
From AppSessionMixin: version, gitCommit, history, assemblyManager
From WebSessionConnectionsMixin: connections
From WorkspaceLayoutMixin: tree, panels, tabs, visibleTree
Methods
26 inherited methods from 10 models
From BaseWebSessionModel: canEditTrack, getTrackActions
From ReferenceManagementSessionMixin: getReferringMultiple, getReferring
From ThemeManagerSessionMixin: allThemes, getActiveThemeOptions
From BaseSessionModel: getPreferenceDefault, getPreference, getPreferenceChanges
From SessionTracksManagerSessionMixin: withTrackEdits, baseTrackConfig, getEditableTrackConfig, getTrackConfigChanges, isTrackOverride
From TracksManagerSessionMixin: getTrackById, getTracksById
From AssembliesMixin: findAssemblyConf
From AppSessionMixin:
From WorkspaceLayoutMixin: hasPanel, findTab, tabContainingView, panelContainingView, viewIdsForTab, activeTabOf
From TrackMenuItemsSessionMixin: ,
Actions
| Member | Description |
|---|---|
syncPermanentPlugins() => void | re-reads the permanent plugin list from the browser, after something outside this session has written it |
addPermanentPlugin(plugin: PluginDefinition) => void | keeps a plugin for every future visit to this JBrowse, and asks for the whole-app reload every plugin change needs |
removePermanentPlugin(plugin: PluginDefinition) => void | |
setPermanentPluginDisabled(plugin: PluginDefinition, disabled: boolean) => void | switches a kept plugin off without taking it out of the list, so a user hunting one that crashed the app can keep the innocent ones. No reload is asked for: the entry is one the load already skipped, and rebuilding the app per switch is not what hunting a culprit wants |
reloadWithPermanentPlugins() => void | leaves safe mode: clears the crash marker and reloads the page |
114 inherited actions from 14 models
From BaseWebSessionModel: addAssemblyConf, addSessionPlugin, removeSessionPlugin, setSession, setPendingFileHandleIds
From ReferenceManagementSessionMixin: dereferenceTrack
From ThemeManagerSessionMixin: setThemeName, noteDarkReader, setSystemPrefersDark, setSystemThemeOverride, setThemeMode
From MultipleViewsSessionMixin: moveViewDown, moveViewUp, moveViewToTop, moveViewToBottom, orderViews, addView, replaceView, removeView, takeOutViewsMissingFrom, setStickyViewHeaders, setUseWorkspaces, launchView
From BaseSessionModel: setSelection, clearSelection, setHovered, setHighlightsVisible, setHighlightLabelsVisible, addHighlight, removeHighlight, updateHighlight, setHighlights, setPreferenceOverride, clearPreferenceOverrides, clearPreferenceOverride, setScrollZoom, setName, setFocusedViewId, removeActiveDialog, queueDialog, removeDialog
From SnackbarModel: notify, notifyError, setErrorDialog, pushSnackbarMessage, popSnackbarMessage, removeSnackbarMessage
From DrawerWidgetSessionMixin: setDrawerPosition, updateDrawerWidth, resizeDrawer, addWidget, showWidget, hideWidget, minimizeWidgetDrawer, showWidgetDrawer, popoutWidget, returnWidgetToDrawer, setModalWidgets, hideAllWidgets, closeModalWidget, openWidget, editConfiguration
From SessionTracksManagerSessionMixin: addSessionTrackConf, publishTrackConf, addTrackConf, updateTrackConfiguration, promoteTrackConfigDeltas, resetTrackConfiguration, deleteTrackConf
From AssembliesMixin: addSessionAssembly, addAssembly, removeAssembly, removeSessionAssembly, addTemporaryAssembly, removeTemporaryAssembly
From AppSessionMixin: renameCurrentSession
From WebSessionConnectionsMixin: addSessionConnectionConf, addConnectionConf, deleteConnection
From ConnectionManagementSessionMixin: makeConnection, breakConnection, teardownConnection, clearConnections, captureConnectionTrack, updateConnectionTrackConfig, setConnectionTrackConfig, pruneConnectionTrackConfig, hydrateConnection
From WorkspaceLayoutMixin: setActivePanelId, toggleMaximizedPanel, restorePanels, setActiveTab, renameTab, splitPanel, closePanel, addTab, closeTab, addViewToTab, dropTabInPanel, dropTabInNewSplit, setSizes, applyLayoutSpec, moveViewToNewTab, moveViewToSplit, moveViewToTab, homeUnassignedViews, setPendingMove, tileViews, layoutViews
From WebSessionManagementMixin: deleteSavedSession, deleteSavedSessions, setSavedSessionFavorite, renameSavedSession, activateSession