Skip to main content

DrawerWidgetSessionMixin

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Built into JBrowse core. View source.

Properties

MemberDescription
drawerPosition
drawerPosition: types.optional(
        types.enumeration<DrawerPosition>('DrawerPosition', [
          ...drawerPositions,
        ]),
        storedDrawerPosition,
      )
drawerWidth
drawerWidth: types.stripDefault(
        types.refinement(types.integer, width => width >= minDrawerWidth),
        384,
      )
widgets
widgets: types.stripDefault(types.map(widgetStateModelType), {})
activeWidgets
activeWidgets: types.stripDefault(
        types.map(types.safeReference(widgetStateModelType)),
        {},
      )
minimized
minimized: types.stripDefault(types.boolean, false)

Volatiles

MemberDescription
poppedOut
poppedOut: false		true while the visible widget is shown in a modal dialog instead of the drawer. Volatile because a restored session that opened straight into a modal, with no drawer behind it, is disorienting

Getters

MemberDescription
visibleWidget
Widget | undefined
drawerVisible
boolean		whether the drawer column is on screen: there is something to show, it is not minimized to the FAB, and it is not currently a modal instead.

A getter rather than each host's own &&, because the hosts drifted -- the app shell tested poppedOut and the embedded view did not, so the day a popout button reaches the embedded drawer header it would render the modal and the drawer at once.

Actions

MemberDescription
setDrawerPosition
(arg: DrawerPosition) => void
updateDrawerWidth
(drawerWidth: number, availableWidth?: number) => number
resizeDrawer
(distance: number, availableWidth?: number) => number
addWidget
(typeName: string, id: string, initialState?: any, conf?: unknown) => any
showWidget
(widget: any) => void
hideWidget
(widget: any) => void
minimizeWidgetDrawer
() => void
showWidgetDrawer
() => void
popoutWidget
() => void		show the visible widget in a modal dialog, freeing the drawer column
returnWidgetToDrawer
() => void
hideAllWidgets
() => void
editConfiguration
(configuration: (ModelInstanceTypeProps<…> & {…} & IStateTreeNode<…>) | { ...; }, opts?: { ...; } | undefined) => void
opens a configuration editor to configure the given thing, and sets the current task to be configuring it