Interface ILabShell

The JupyterLab application shell interface.

interface ILabShell {
    node: HTMLElement;
    get activeChanged(): ISignal<this, ILabShell.IChangedArgs>;
    get activeWidget(): null | Widget;
    get addButtonEnabled(): boolean;
    set addButtonEnabled(value: boolean): void;
    get addRequested(): ISignal<DockPanel, TabBar<Widget>>;
    get currentChanged(): ISignal<this, ILabShell.IChangedArgs>;
    get currentPath(): undefined | null | string;
    get currentPathChanged(): ISignal<this, ICurrentPathChangedArgs>;
    get currentWidget(): null | Widget;
    get dataset(): DOMStringMap;
    get disposed(): ISignal<this, void>;
    get hiddenMode(): HiddenMode;
    set hiddenMode(value: HiddenMode): void;
    get id(): string;
    set id(value: string): void;
    get isAttached(): boolean;
    get isDisposed(): boolean;
    get isHidden(): boolean;
    get isVisible(): boolean;
    get layout(): null | Layout;
    set layout(value: null | Layout): void;
    get layoutModified(): ISignal<this, void>;
    get leftCollapsed(): boolean;
    get mode(): Mode;
    set mode(mode: Mode): void;
    get modeChanged(): ISignal<this, Mode>;
    get parent(): null | Widget;
    set parent(value: null | Widget): void;
    get presentationMode(): boolean;
    set presentationMode(value: boolean): void;
    get restored(): Promise<ILayout>;
    get rightCollapsed(): boolean;
    get title(): Title<Widget>;
    get translator(): ITranslator;
    set translator(value: ITranslator): void;
    get userLayout(): {
        "multiple-document": IUserLayout;
        "single-document": IUserLayout;
    };
    activate(): void;
    activateArea(area?: Area): void;
    activateById(id: string): void;
    activateNextTab(): void;
    activateNextTabBar(): void;
    activatePreviousTab(): void;
    activatePreviousTabBar(): void;
    add(widget: Widget, area?: Area, options?: IOpenOptions): void;
    addClass(name: string): void;
    children(): IterableIterator<Widget>;
    clearFlag(flag: Flag): void;
    close(): void;
    closeAll(): void;
    collapseLeft(): void;
    collapseRight(): void;
    contains(widget: Widget): boolean;
    dispose(): void;
    expandLeft(): void;
    expandRight(): void;
    fit(): void;
    hasClass(name: string): boolean;
    hide(): void;
    isEmpty(area: Area): boolean;
    isSideTabBarVisible(side: "left" | "right"): boolean;
    isTopInSimpleModeVisible(): boolean;
    move(
        widget: Widget,
        area: Area,
        mode?: Mode,
    ): { "multiple-document": IUserLayout; "single-document": IUserLayout };
    notifyLayout(msg: Message): void;
    onActivateRequest(msg: Message): void;
    onAfterAttach(msg: Message): void;
    onAfterDetach(msg: Message): void;
    onAfterHide(msg: Message): void;
    onAfterShow(msg: Message): void;
    onBeforeAttach(msg: Message): void;
    onBeforeDetach(msg: Message): void;
    onBeforeHide(msg: Message): void;
    onBeforeShow(msg: Message): void;
    onChildAdded(msg: ChildMessage): void;
    onChildRemoved(msg: ChildMessage): void;
    onCloseRequest(msg: Message): void;
    onFitRequest(msg: Message): void;
    onResize(msg: ResizeMessage): void;
    onUpdateRequest(msg: Message): void;
    processMessage(msg: Message): void;
    removeClass(name: string): void;
    restoreLayout(
        mode: Mode,
        layoutRestorer: LayoutRestorer,
        configuration?: { [m: string]: IUserLayout },
    ): Promise<void>;
    saveLayout(): ILayout;
    setFlag(flag: Flag): void;
    setHidden(hidden: boolean): void;
    show(): void;
    testFlag(flag: Flag): boolean;
    toggleClass(name: string, force?: boolean): boolean;
    toggleSideTabBarVisibility(side: "left" | "right"): void;
    toggleTopInSimpleModeVisibility(): void;
    update(): void;
    updateConfig(config: Partial<ILabShell.IConfig>): void;
    widgets(area?: Area): IterableIterator<Widget>;
}

Hierarchy (View Summary)

Properties

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

Properties

Readonlynode

node: HTMLElement

Get the DOM node owned by the widget.

Accessors

activeChanged

activeWidget

addButtonEnabled

addRequested

currentChanged

currentPath

currentPathChanged

currentWidget

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: HiddenMode): 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: string): 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(): null | Layout

  • Get the layout for the widget.

    Returns null | Layout

  • set layout(value: null | Layout): 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: null | Layout

    Returns void

layoutModified

leftCollapsed

mode

modeChanged

parent

  • get parent(): null | Widget

  • Get the parent of the widget.

    Returns null | Widget

  • set parent(value: null | Widget): 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: boolean): void

  • Parameters

    • value: boolean

    Returns void

restored

rightCollapsed

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

userLayout

Methods

activate

  • activate(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

activateArea

activateById

activateNextTab

activateNextTabBar

activatePreviousTab

activatePreviousTabBar

add

addClass

  • addClass(name: string): void

  • 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

  • children(): IterableIterator<Widget>

  • 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

  • clearFlag(flag: Flag): void

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

close

  • close(): void

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

    Notes

    This is a simple convenience method for sending the message.

    Returns void

closeAll

collapseLeft

collapseRight

contains

  • contains(widget: Widget): boolean

  • 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

expandLeft

expandRight

fit

  • fit(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

hasClass

  • hasClass(name: string): boolean

  • 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(): void

  • 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

isSideTabBarVisible

isTopInSimpleModeVisible

move

  • move(
        widget: Widget,
        area: Area,
        mode?: Mode,
    ): { "multiple-document": IUserLayout; "single-document": IUserLayout }

  • 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

    • Optionalmode: Mode

      Mode to change

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

    The new user layout

ProtectednotifyLayout

  • notifyLayout(msg: Message): void

  • 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

ProtectedonActivateRequest

  • onActivateRequest(msg: Message): void

  • 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

ProtectedonAfterAttach

ProtectedonAfterDetach

  • onAfterDetach(msg: Message): void

  • 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

ProtectedonAfterHide

  • onAfterHide(msg: Message): void

  • 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

ProtectedonAfterShow

  • onAfterShow(msg: Message): void

  • 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

ProtectedonBeforeAttach

  • onBeforeAttach(msg: Message): void

  • 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

ProtectedonBeforeDetach

  • onBeforeDetach(msg: Message): void

  • 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

ProtectedonBeforeHide

  • onBeforeHide(msg: Message): void

  • 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

ProtectedonBeforeShow

  • onBeforeShow(msg: Message): void

  • 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

ProtectedonChildAdded

  • onChildAdded(msg: ChildMessage): void

  • 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

ProtectedonChildRemoved

  • onChildRemoved(msg: ChildMessage): void

  • 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

ProtectedonCloseRequest

  • onCloseRequest(msg: Message): void

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

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

ProtectedonFitRequest

  • onFitRequest(msg: Message): void

  • 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

ProtectedonResize

  • onResize(msg: ResizeMessage): void

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

    Notes

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

    Parameters

    • msg: ResizeMessage

    Returns void

ProtectedonUpdateRequest

  • onUpdateRequest(msg: Message): void

  • 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

  • processMessage(msg: Message): void

  • 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

  • removeClass(name: string): void

  • 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

saveLayout

setFlag

  • setFlag(flag: Flag): void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

setHidden

  • setHidden(hidden: boolean): void

  • 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(): void

  • 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

  • testFlag(flag: Flag): boolean

  • 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

  • toggleClass(name: string, force?: boolean): boolean

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

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optionalforce: 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

toggleTopInSimpleModeVisibility

update

  • update(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

updateConfig

widgets

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
activateactivateAreaactivateByIdactivateNextTabactivateNextTabBaractivatePreviousTabactivatePreviousTabBaraddaddClasschildrenclearFlagclosecloseAllcollapseLeftcollapseRightcontainsdisposeexpandLeftexpandRightfithasClasshideisEmptyisSideTabBarVisibleisTopInSimpleModeVisiblemovenotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonFitRequestonResizeonUpdateRequestprocessMessageremoveClassrestoreLayoutsaveLayoutsetFlagsetHiddenshowtestFlagtoggleClasstoggleSideTabBarVisibilitytoggleTopInSimpleModeVisibilityupdateupdateConfigwidgets