Interface INotebookTracker

An object that tracks notebook widgets.

interface INotebookTracker {
    activeCell: null | Cell<ICellModel>;
    activeCellChanged: ISignal<INotebookTracker, null | Cell<ICellModel>>;
    currentChanged: ISignal<INotebookTracker, null | NotebookPanel>;
    currentWidget: null | NotebookPanel;
    isDisposed: boolean;
    restored: Promise<void>;
    selectionChanged: ISignal<INotebookTracker, void>;
    size: number;
    widgetAdded: ISignal<INotebookTracker, NotebookPanel>;
    widgetUpdated: ISignal<INotebookTracker, NotebookPanel>;
    dispose(): void;
    filter(fn: (obj: NotebookPanel) => boolean): NotebookPanel[];
    find(fn: (obj: NotebookPanel) => boolean): undefined | NotebookPanel;
    forEach(fn: (obj: NotebookPanel) => void): void;
    has(obj: Widget): boolean;
    inject(obj: NotebookPanel): void;
}

Hierarchy (View Summary)

Implemented by

Properties

activeCell activeCellChanged currentChanged currentWidget isDisposed restored selectionChanged size widgetAdded widgetUpdated

Methods

dispose filter find forEach has inject

Properties

ReadonlyactiveCell

activeCell: null | Cell<ICellModel>

The currently focused cell.

Notes

If there is no cell with the focus, then this value is null.

ReadonlyactiveCellChanged

activeCellChanged: ISignal<INotebookTracker, null | Cell<ICellModel>>

A signal emitted when the current active cell changes.

Notes

If there is no cell with the focus, then null will be emitted.

ReadonlycurrentChanged

currentChanged: ISignal<INotebookTracker, null | NotebookPanel>

A signal emitted when the current instance changes.

Notes

If the last instance being tracked is disposed, null will be emitted.

ReadonlycurrentWidget

currentWidget: null | NotebookPanel

The current widget is the most recently focused or added widget.

Notes

It is the most recently focused widget, or the most recently added widget if no widget has taken focus.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlyrestored

restored: Promise<void>

A promise that is resolved when the widget tracker has been restored from a serialized state.

Notes

Most client code will not need to use this, since they can wait for the whole application to restore. However, if an extension wants to perform actions during the application restoration, but after the restoration of another widget tracker, they can use this promise.

ReadonlyselectionChanged

selectionChanged: ISignal<INotebookTracker, void>

A signal emitted when the selection state changes.

Readonlysize

size: number

The number of instances held by the tracker.

ReadonlywidgetAdded

widgetAdded: ISignal<INotebookTracker, NotebookPanel>

A signal emitted when a widget is added.

ReadonlywidgetUpdated

widgetUpdated: ISignal<INotebookTracker, NotebookPanel>

A signal emitted when a widget is updated.

Methods

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

filter

find

  • find(fn: (obj: NotebookPanel) => boolean): undefined | NotebookPanel

  • Find the first instance in the tracker that satisfies a filter function.

    Parameters

    • fn: (obj: NotebookPanel) => boolean

      The filter function to call on each instance.

      Notes

      If nothing is found, the value returned is undefined.

    Returns undefined | NotebookPanel

forEach

  • forEach(fn: (obj: NotebookPanel) => void): void

  • Iterate through each instance in the tracker.

    Parameters

    • fn: (obj: NotebookPanel) => void

      The function to call on each instance.

    Returns void

has

  • has(obj: Widget): boolean

  • Check if this tracker has the specified instance.

    Parameters

    • obj: Widget

      The object whose existence is being checked.

    Returns boolean

inject

  • inject(obj: NotebookPanel): void

  • Inject an instance into the widget tracker without the tracker handling its restoration lifecycle.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods