Class LabShell

The application shell for JupyterLab.

Hierarchy

Implements

Constructors

constructor

Properties

_activeChanged _addToBottomArea _addToDownArea _addToHeaderArea _addToLeftArea _addToMainArea _addToMenuArea _addToRightArea _addToTopArea _adjacentBar _bottomPanel _cachedLayout _currentChanged _currentPath _currentPathChanged _currentTabBar _delayedWidget _dockChildHook _dockPanel _downPanel _headerPanel _hsplitPanel _idTypeMap _isRestored _layoutDebouncer _layoutModified _layoutRestorer _leftHandler _mainOptionsCache _menuHandler _modeChanged _onActiveChanged _onCurrentChanged _onLayoutModified _onTabPanelChanged _restored _rightHandler _sideOptionsCache _skipLinkWidget _titleHandler _topHandler _topHandlerHiddenByUser _tracker _translator _updateCurrentPath _updateTitlePanelTitle _userLayout _vsplitPanel node

Accessors

activeChanged activeWidget addButtonEnabled addRequested currentChanged currentPath currentPathChanged currentWidget dataset disposed hiddenMode id isAttached isDisposed isHidden isVisible layout layoutModified leftCollapsed mode modeChanged parent presentationMode restored rightCollapsed title translator userLayout

Methods

activate activateArea activateById activateNextTab activateNextTabBar activatePreviousTab activatePreviousTabBar add addClass children clearFlag close closeAll collapseLeft collapseRight contains dispose expandLeft expandRight fit hasClass hide isEmpty isSideTabBarVisible isTopInSimpleModeVisible move notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest processMessage removeClass restoreLayout saveLayout setFlag setHidden show testFlag toggleClass toggleSideTabBarVisibility toggleTopInSimpleModeVisibility update updateConfig widgets

Constructors

constructor

  • Construct a new application shell.

    Parameters

    Returns LabShell

Properties

Private _activeChanged

_activeChanged: any

Private _addToBottomArea

_addToBottomArea: any

Add a widget to the bottom content area.

Notes

Widgets must have a unique id property, which will be used as the DOM id.

Private _addToDownArea

_addToDownArea: any

Private _addToHeaderArea

_addToHeaderArea: any

Add a widget to the header content area.

Notes

Widgets must have a unique id property, which will be used as the DOM id.

Private _addToLeftArea

_addToLeftArea: any

Add a widget to the left content area.

Notes

Widgets must have a unique id property, which will be used as the DOM id.

Private _addToMainArea

_addToMainArea: any

Add a widget to the main content area.

Notes

Widgets must have a unique id property, which will be used as the DOM id. All widgets added to the main area should be disposed after removal (disposal before removal will remove the widget automatically).

In the options, ref defaults to null, mode defaults to 'tab-after', and activate defaults to true.

Private _addToMenuArea

_addToMenuArea: any

Add a widget to the title content area.

Notes

Widgets must have a unique id property, which will be used as the DOM id.

Private _addToRightArea

_addToRightArea: any

Add a widget to the right content area.

Notes

Widgets must have a unique id property, which will be used as the DOM id.

Private _addToTopArea

_addToTopArea: any

Add a widget to the top content area.

Notes

Widgets must have a unique id property, which will be used as the DOM id.

Private _adjacentBar

_adjacentBar: any

Private _bottomPanel

_bottomPanel: any

Private _cachedLayout

_cachedLayout: any

Private _currentChanged

_currentChanged: any

Private _currentPath

_currentPath: any

Private _currentPathChanged

_currentPathChanged: any

Private _currentTabBar

_currentTabBar: any

Private _delayedWidget

_delayedWidget: any

Private _dockChildHook

_dockChildHook: any

A message hook for child add/remove messages on the main area dock panel.

Private _dockPanel

_dockPanel: any

Private _downPanel

_downPanel: any

Private _headerPanel

_headerPanel: any

Private _hsplitPanel

_hsplitPanel: any

Private _idTypeMap

_idTypeMap: any

Private _isRestored

_isRestored: any

Private _layoutDebouncer

_layoutDebouncer: any

Private _layoutModified

_layoutModified: any

Private _layoutRestorer

_layoutRestorer: any

Private _leftHandler

_leftHandler: any

Private _mainOptionsCache

_mainOptionsCache: any

Private _menuHandler

_menuHandler: any

Private _modeChanged

_modeChanged: any

Private _onActiveChanged

_onActiveChanged: any

Handle a change to the dock area active widget.

Private _onCurrentChanged

_onCurrentChanged: any

Handle a change to the dock area current widget.

Private _onLayoutModified

_onLayoutModified: any

Handle a change to the layout.

Private _onTabPanelChanged

_onTabPanelChanged: any

Handle a change on the down panel widgets

Private _restored

_restored: any

Private _rightHandler

_rightHandler: any

Private _sideOptionsCache

_sideOptionsCache: any

Private _skipLinkWidget

_skipLinkWidget: any

Private _titleHandler

_titleHandler: any

Private _topHandler

_topHandler: any

Private _topHandlerHiddenByUser

_topHandlerHiddenByUser: any

Private _tracker

_tracker: any

Private _translator

_translator: any

Private _updateCurrentPath

_updateCurrentPath: any

The path of the current widget changed, fire the _currentPathChanged signal.

Private _updateTitlePanelTitle

_updateTitlePanelTitle: any

Update the title panel title based on the title of the current widget.

Private _userLayout

_userLayout: any

Private _vsplitPanel

_vsplitPanel: any

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Accessors

activeChanged

activeWidget

  • get activeWidget(): Widget

  • The active widget in the shell's main area.

    Returns Widget

addButtonEnabled

  • get addButtonEnabled(): boolean

  • Whether the add buttons for each main area tab bar are enabled.

    Returns boolean

  • set addButtonEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

addRequested

currentChanged

currentPath

  • get currentPath(): string

  • Current document path.

    Returns string

currentPathChanged

currentWidget

  • get currentWidget(): Widget

  • The current widget in the shell's main area.

    Returns Widget

dataset

  • get dataset(): DOMStringMap

  • The dataset for the widget's DOM node.

    Returns DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

hiddenMode

  • get hiddenMode(): HiddenMode

  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value): void

  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

id

  • get id(): string

  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): void

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

  • Test whether the widget's node is attached to the DOM.

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Test whether the widget has been disposed.

    Returns boolean

isHidden

  • get isHidden(): boolean

  • Test whether the widget is explicitly hidden.

    Returns boolean

isVisible

  • get isVisible(): boolean

  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Returns boolean

layout

  • get layout(): Layout

  • Get the layout for the widget.

    Returns Layout

  • set layout(value): void

  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    • value: Layout

    Returns void

layoutModified

  • get layoutModified(): ISignal<this, void>

  • A signal emitted when the main area's layout is modified.

    Returns ISignal<this, void>

leftCollapsed

  • get leftCollapsed(): boolean

  • Whether the left area is collapsed.

    Returns boolean

mode

  • get mode(): Mode

  • The main dock area's user interface mode.

    Returns Mode

  • set mode(mode): void

  • Parameters

    • mode: Mode

    Returns void

modeChanged

  • get modeChanged(): ISignal<this, Mode>

  • A signal emitted when the shell/dock panel change modes (single/multiple document).

    Returns ISignal<this, Mode>

parent

  • get parent(): Widget

  • Get the parent of the widget.

    Returns Widget

  • set parent(value): void

  • Set the parent of the widget.

    Notes

    Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

    The widget will be automatically removed from its old parent.

    This is a no-op if there is no effective parent change.

    Parameters

    Returns void

presentationMode

  • get presentationMode(): boolean

  • Whether JupyterLab is in presentation mode with the jp-mod-presentationMode CSS class.

    Returns boolean

  • set presentationMode(value): void

  • Parameters

    • value: boolean

    Returns void

restored

  • get restored(): Promise<ILayout>

  • Promise that resolves when state is first restored, returning layout description.

    Returns Promise<ILayout>

rightCollapsed

  • get rightCollapsed(): boolean

  • Whether the left area is collapsed.

    Returns boolean

title

  • get title(): Title<Widget>

  • The title object for the widget.

    Notes

    The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

    Since not all widgets will use the title, it is created on demand.

    The owner property of the title is set to this widget.

    Returns Title<Widget>

translator

  • get translator(): ITranslator

  • Returns ITranslator

  • set translator(value): void

  • Parameters

    Returns void

userLayout

  • get userLayout(): {
        multiple-document: IUserLayout;
        single-document: IUserLayout;
    }

  • User customized shell layout.

    Returns {
        multiple-document: IUserLayout;
        single-document: IUserLayout;
    }

Methods

activate

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

activateArea

  • Alpha

    Activate widget in specified area.

    Notes

    The alpha version of this method only supports activating the "main" area.

    Parameters

    • Optional area: Area

      Name of area to activate

    Returns void

activateById

  • Activate a widget in its area.

    Parameters

    • id: string

    Returns void

activateNextTab

  • Activate the next Tab in the active TabBar.

    Returns void

activateNextTabBar

  • Activate the next TabBar.

    Returns void

activatePreviousTab

  • Activate the previous Tab in the active TabBar.

    Returns void

activatePreviousTabBar

  • Activate the next TabBar.

    Returns void

add

  • Add a widget to the JupyterLab shell

    Parameters

    Returns void

addClass

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

children

  • Create an iterator over the widget's children.

    Returns IterableIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

close

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

closeAll

  • Close all widgets in the main and down area.

    Returns void

collapseLeft

  • Collapse the left area.

    Returns void

collapseRight

  • Collapse the right area.

    Returns void

contains

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

dispose

  • Dispose the shell.

    Returns void

expandLeft

  • Expand the left area.

    Notes

    This will open the most recently used tab, or the first tab if there is no most recently used.

    Returns void

expandRight

  • Expand the right area.

    Notes

    This will open the most recently used tab, or the first tab if there is no most recently used.

    Returns void

fit

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

hasClass

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hide

  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

isEmpty

  • True if the given area is empty.

    Parameters

    Returns boolean

isSideTabBarVisible

  • Whether an side tab bar is visible or not.

    Parameters

    • side: "left" | "right"

      Sidebar of interest

    Returns boolean

    Side tab bar visibility

isTopInSimpleModeVisible

  • Whether the top bar in simple mode is visible or not.

    Returns boolean

    Top bar visibility

move

  • Move a widget type to a new area.

    The type is determined from the widget.id and fallback to widget.id.

    Notes

    If mode is undefined, both mode are updated. The new layout is now persisted.

    Parameters

    • widget: Widget

      Widget to move

    • area: Area

      New area

    • Optional mode: Mode

      Mode to change

    Returns {
        multiple-document: IUserLayout;
        single-document: IUserLayout;
    }

    The new user layout

Protected notifyLayout

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

Protected onActivateRequest

  • A message handler invoked on an 'activate-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • Handle after-attach messages for the application shell.

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • A message handler invoked on a 'before-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

Protected onChildRemoved

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

Protected onCloseRequest

  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

Protected onFitRequest

  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onResize

  • A message handler invoked on a 'resize' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onUpdateRequest

  • A message handler invoked on an 'update-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

processMessage

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

removeClass

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

restoreLayout

  • Restore the layout state and configuration for the application shell.

    Notes

    This should only be called once.

    Parameters

    Returns Promise<void>

saveLayout

  • Save the dehydrated state of the application shell.

    Returns ILayout

setFlag

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

setHidden

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

show

  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

testFlag

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: boolean

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

toggleSideTabBarVisibility

  • Toggle side tab bar visibility

    Parameters

    • side: "left" | "right"

      Sidebar of interest

    Returns void

toggleTopInSimpleModeVisibility

  • Toggle top header visibility in simple mode

    Note: Does nothing in multi-document mode

    Returns void

update

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

updateConfig

  • Update the shell configuration.

    Parameters

    Returns void

widgets

  • Returns the widgets for an application area.

    Parameters

    • Optional area: Area

    Returns IterableIterator<Widget>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc