Class NotebookTracker

An object that tracks notebook widgets.

Hierarchy (view full)

WidgetTracker<NotebookPanel>
- NotebookTracker

Implements

INotebookTracker

Index

Constructors

constructor

new NotebookTracker(options): NotebookTracker
Create a new widget tracker.
Parameters
- options: WidgetTracker.IOptions
  The instantiation options for a widget tracker.
Returns NotebookTracker
Inherited from WidgetTracker.constructor
- Defined in packages/apputils/lib/widgettracker.d.ts:103

Properties

`Private` _activeCell

_activeCell: null | Cell<ICellModel> = null

`Private` _activeCellChanged

_activeCellChanged: Signal<NotebookTracker, null | Cell<ICellModel>> = ...

`Private` _selectionChanged

_selectionChanged: Signal<NotebookTracker, void> = ...

`Readonly` namespace

namespace: string

A namespace for all tracked widgets, (e.g., notebook).

Accessors

activeCell

get activeCell(): null | Cell<ICellModel>
The currently focused cell.

Notes
This is a read-only property. If there is no cell with the focus, then this value is null.

Returns null | Cell<ICellModel>
Implementation of INotebookTracker.activeCell
- Defined in packages/notebook/src/tracker.ts:22

activeCellChanged

get activeCellChanged(): ISignal<this, 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.

Returns ISignal<this, null | Cell<ICellModel>>
Implementation of INotebookTracker.activeCellChanged
- Defined in packages/notebook/src/tracker.ts:36

currentChanged

get currentChanged(): ISignal<this, null | T>
A signal emitted when the current widget changes.

Returns ISignal<this, null | T>
Implementation of INotebookTracker.currentChanged
Inherited from WidgetTracker.currentChanged
- Defined in packages/apputils/lib/widgettracker.d.ts:111

currentWidget

get currentWidget(): null | T
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.

Returns null | T
Implementation of INotebookTracker.currentWidget
Inherited from WidgetTracker.currentWidget
- Defined in packages/apputils/lib/widgettracker.d.ts:119

isDisposed

get isDisposed(): boolean
Test whether the tracker is disposed.

Returns boolean
Implementation of INotebookTracker.isDisposed
Inherited from WidgetTracker.isDisposed
- Defined in packages/apputils/lib/widgettracker.d.ts:158

restored

get restored(): Promise<void>
A promise resolved when the tracker has been restored.

Returns Promise<void>
Implementation of INotebookTracker.restored
Inherited from WidgetTracker.restored
- Defined in packages/apputils/lib/widgettracker.d.ts:123

selectionChanged

get selectionChanged(): ISignal<this, void>
A signal emitted when the selection state changes.

Returns ISignal<this, void>
Implementation of INotebookTracker.selectionChanged
- Defined in packages/notebook/src/tracker.ts:43

size

get size(): number
The number of widgets held by the tracker.

Returns number
Implementation of INotebookTracker.size
Inherited from WidgetTracker.size
- Defined in packages/apputils/lib/widgettracker.d.ts:127

widgetAdded

get widgetAdded(): ISignal<this, T>
A signal emitted when a widget is added.

Notes
This signal will only fire when a widget is added to the tracker. It will not fire if a widget is injected into the tracker.

Returns ISignal<this, T>
Implementation of INotebookTracker.widgetAdded
Inherited from WidgetTracker.widgetAdded
- Defined in packages/apputils/lib/widgettracker.d.ts:135

widgetUpdated

get widgetUpdated(): ISignal<this, T>
A signal emitted when a widget is updated.

Returns ISignal<this, T>
Implementation of INotebookTracker.widgetUpdated
Inherited from WidgetTracker.widgetUpdated
- Defined in packages/apputils/lib/widgettracker.d.ts:139

Methods

`Private` _onActiveCellChanged

_onActiveCellChanged(sender, cell): void
Parameters
- sender: Notebook
- cell: Cell<ICellModel>
Returns void
- Defined in packages/notebook/src/tracker.ts:86

`Private` _onSelectionChanged

_onSelectionChanged(sender): void
Parameters
- sender: Notebook
Returns void
- Defined in packages/notebook/src/tracker.ts:94

add

add(panel): Promise<void>
Add a new notebook panel to the tracker.
Parameters
- panel: NotebookPanel
  The notebook panel being added.
Returns Promise<void>
Overrides WidgetTracker.add
- Defined in packages/notebook/src/tracker.ts:52

defer

defer(options): void
Save the restore options for this tracker, but do not restore yet.
Parameters
- options: IRestorable.IOptions<NotebookPanel>
  The configuration options that describe restoration.
  
  Notes
  This function is useful when starting the shell in 'single-document' mode, to avoid restoring all useless widgets. It should not ordinarily be called by client code.
Returns void
Inherited from WidgetTracker.defer
- Defined in packages/apputils/lib/widgettracker.d.ts:229

dispose

dispose(): void
Dispose of the resources held by the tracker.

Returns void
Implementation of INotebookTracker.dispose
Overrides WidgetTracker.dispose
- Defined in packages/notebook/src/tracker.ts:62

filter

filter(fn): NotebookPanel[]
Filter the widgets in the tracker based on a predicate.
Parameters
- fn: ((widget) => boolean)
  The function by which to filter.
  - - (widget): boolean
    - Parameters
      widget: NotebookPanel
      Returns boolean
Returns NotebookPanel[]
Implementation of INotebookTracker.filter
Inherited from WidgetTracker.filter
- Defined in packages/apputils/lib/widgettracker.d.ts:183

find

find(fn): undefined | NotebookPanel
Find the first widget in the tracker that satisfies a filter function.
Parameters
- fn: ((widget) => boolean)
  The filter function to call on each widget.
  
  Notes
  If no widget is found, the value returned is undefined.
  - - (widget): boolean
    - Parameters
      widget: NotebookPanel
      Returns boolean
Returns undefined | NotebookPanel
Implementation of INotebookTracker.find
Inherited from WidgetTracker.find
- Defined in packages/apputils/lib/widgettracker.d.ts:171

forEach

forEach(fn): void
Iterate through each widget in the tracker.
Parameters
- fn: ((widget) => void)
  The function to call on each widget.
  - - (widget): void
    - Parameters
      widget: NotebookPanel
      Returns void
Returns void
Implementation of INotebookTracker.forEach
Inherited from WidgetTracker.forEach
- Defined in packages/apputils/lib/widgettracker.d.ts:177

has

has(widget): boolean
Check if this tracker has the specified widget.
Parameters
- widget: Widget
  The widget whose existence is being checked.
Returns boolean
Implementation of INotebookTracker.has
Inherited from WidgetTracker.has
- Defined in packages/apputils/lib/widgettracker.d.ts:206

inject

inject(widget): Promise<void>
Inject a foreign widget into the widget tracker.
Parameters
- widget: NotebookPanel
  The widget to inject into the tracker.
  
  Notes
  Injected widgets will not have their state saved by the tracker.
  
  The primary use case for widget injection is for a plugin that offers a sub-class of an extant plugin to have its instances share the same commands as the parent plugin (since most relevant commands will use the currentWidget of the parent plugin's widget tracker). In this situation, the sub-class plugin may well have its own widget tracker for layout and state restoration in addition to injecting its widgets into the parent plugin's widget tracker.
Returns Promise<void>
Implementation of INotebookTracker.inject
Inherited from WidgetTracker.inject
- Defined in packages/apputils/lib/widgettracker.d.ts:200

`Protected` onCurrentChanged

onCurrentChanged(widget): void
Handle the current change event.
Parameters
- widget: NotebookPanel
Returns void
Overrides WidgetTracker.onCurrentChanged
- Defined in packages/notebook/src/tracker.ts:70

restore

restore(options?): Promise<any>
Restore the widgets in this tracker's namespace.
Parameters
- Optional options: IRestorable.IOptions<NotebookPanel>
  The configuration options that describe restoration.
Returns Promise<any>
A promise that resolves when restoration has completed.

Notes
This function should not typically be invoked by client code. Its primary use case is to be invoked by a restorer.
Inherited from WidgetTracker.restore
- Defined in packages/apputils/lib/widgettracker.d.ts:218

save

save(widget): Promise<void>
Save the restore data for a given widget.
Parameters
- widget: NotebookPanel
  The widget being saved.
Returns Promise<void>
Inherited from WidgetTracker.save
- Defined in packages/apputils/lib/widgettracker.d.ts:235

Class NotebookTracker

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebookTracker

Properties

Private _activeCell

Private _activeCellChanged

Private _selectionChanged

Readonly namespace

Accessors

activeCell

Returns null | Cell<ICellModel>

activeCellChanged

Returns ISignal<this, null | Cell<ICellModel>>

currentChanged

Returns ISignal<this, null | T>

currentWidget

Returns null | T

isDisposed

Returns boolean

restored

Returns Promise<void>

selectionChanged

Returns ISignal<this, void>

size

Returns number

widgetAdded

Returns ISignal<this, T>

widgetUpdated

Returns ISignal<this, T>

Methods

Private _onActiveCellChanged

Parameters

Returns void

Private _onSelectionChanged

Parameters

Returns void

add

Parameters

Returns Promise<void>

defer

Parameters

Returns void

dispose

Returns void

filter

Parameters

Parameters

Returns boolean

Returns NotebookPanel[]

find

Parameters

Parameters

Returns boolean

Returns undefined | NotebookPanel

forEach

Parameters

Parameters

Returns void

Returns void

has

Parameters

Returns boolean

inject

Parameters

Returns Promise<void>

Protected onCurrentChanged

Parameters

Returns void

restore

Parameters

Returns Promise<any>

`Private` _activeCell

`Private` _activeCellChanged

`Private` _selectionChanged

`Readonly` namespace

`Private` _onActiveCellChanged

`Private` _onSelectionChanged

`Protected` onCurrentChanged