Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INotebookTracker

An object that tracks notebook widgets.

Hierarchy

Index

Properties

activeCell

activeCell: Cell | null

The currently focused cell.

Notes

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

activeCellChanged

activeCellChanged: ISignal<this, Cell | null>

A signal emitted when the current active cell changes.

Notes

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

currentChanged

currentChanged: ISignal<this, NotebookPanel | null>

A signal emitted when the current instance changes.

Notes

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

currentWidget

currentWidget: NotebookPanel | null

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.

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

restored

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.

selectionChanged

selectionChanged: ISignal<this, void>

A signal emitted when the selection state changes.

size

size: number

The number of instances held by the tracker.

widgetAdded

widgetAdded: ISignal<this, NotebookPanel>

A signal emitted when a widget is added.

widgetUpdated

widgetUpdated: ISignal<this, 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

forEach

has

  • has(obj: Widget): boolean

inject

Generated using TypeDoc