Class CellToolbarTracker

Watch a notebook so that a cell toolbar appears on the active cell

Implements

IDisposable

Index

Constructors

Accessors

enabled isDisposed

Methods

_onActiveCellChanged _onMetadataChanged dispose

Constructors

constructor

new CellToolbarTracker(
    panel: NotebookPanel,
    toolbar?: IObservableList<ToolbarRegistry.IToolbarItem>,
    toolbarFactory?: (
        widget: Cell<ICellModel>,
    ) => IObservableList<ToolbarRegistry.IToolbarItem>,
    translator?: ITranslator,
): CellToolbarTracker
CellToolbarTracker constructor
Parameters
- panel: NotebookPanel
  The notebook panel
- Optionaltoolbar: IObservableList<ToolbarRegistry.IToolbarItem>
  The toolbar; deprecated use toolbarFactory instead
- OptionaltoolbarFactory: (widget: Cell<ICellModel>) => IObservableList<ToolbarRegistry.IToolbarItem>
  The toolbar factory
- Optionaltranslator: ITranslator
Returns CellToolbarTracker
- Defined in cell-toolbar/src/celltoolbartracker.ts:57

Accessors

enabled

get enabled(): boolean
Whether the cell toolbar is shown, if there is enough room

Returns boolean
- Defined in cell-toolbar/src/celltoolbartracker.ts:158
set enabled(value: boolean): void
Sets whether the cell toolbar is shown, if there is enough room
Parameters
- value: boolean
Returns void
- Defined in cell-toolbar/src/celltoolbartracker.ts:165

isDisposed

get isDisposed(): boolean
Test whether the object has been disposed.

Notes
This property is always safe to access.

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in cell-toolbar/src/celltoolbartracker.ts:151

Methods

_onActiveCellChanged

_onActiveCellChanged(notebook: Notebook): void
Parameters
- notebook: Notebook
Returns void
Deprecated
Will become protected in JupyterLab 5
- Defined in cell-toolbar/src/celltoolbartracker.ts:130

_onMetadataChanged

_onMetadataChanged(model: CellModel, args: IMapChange<any>): void
Parameters
- model: CellModel
- args: IMapChange<any>
Returns void
Deprecated
Will become protected in JupyterLab 5
- Defined in cell-toolbar/src/celltoolbartracker.ts:106

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
Implementation of IDisposable.dispose
- Defined in cell-toolbar/src/celltoolbartracker.ts:170