A private constructor for the NotebookActions class.
This class can never be instantiated. Its static member executed will be
merged with the NotebookActions namespace. The reason it exists as a
standalone class is because at run time, the Private.executed variable
does not yet exist, so it needs to be referenced via a getter.
A signal that emits whenever a cell is run.
Change the selected cell type(s).
The target notebook widget.
The target cell type.
It should preserve the widget mode. This action can be undone. The existing selection will be cleared. Any cells converted to markdown will be unrendered.
Clear all the code outputs on the widget.
The target notebook widget.
The widget mode will be preserved.
Clear the code outputs of the selected cells.
The target notebook widget.
The widget mode will be preserved.
Copy the selected cell data to a clipboard.
The target notebook widget.
Cut the selected cell data to a clipboard.
The target notebook widget.
This action can be undone. A new code cell is added if all cells are cut.
Delete the selected cells.
The target notebook widget.
The cell after the last selected cell will be activated. It will add a code cell if all cells are deleted. This action can be undone.
Deselect all of the cells of the notebook.
the targe notebook widget.
Disable output scrolling for all selected cells.
The target notebook widget.
Enable output scrolling for all selected cells.
The target notebook widget.
Extend the selection to the cell above.
The target notebook widget.
This is a no-op if the first cell is the active cell. The new cell will be activated.
Extend the selection to the cell below.
The target notebook widget.
This is a no-op if the last cell is the active cell. The new cell will be activated.
Hide the code on all code cells.
The target notebook widget.
Hide the output on all code cells.
The target notebook widget.
Hide the code on selected code cells.
The target notebook widget.
Hide the output on selected code cells.
The target notebook widget.
Insert a new code cell above the active cell.
The target notebook widget.
The widget mode will be preserved. This action can be undone. The existing selection will be cleared. The new cell will the active cell.
Insert a new code cell below the active cell.
The target notebook widget.
The widget mode will be preserved. This action can be undone. The existing selection will be cleared. The new cell will be the active cell.
Merge the selected cells.
The target notebook widget.
The widget mode will be preserved. If only one cell is selected, the next cell will be selected. If the active cell is a code cell, its outputs will be cleared. This action can be undone. The final cell will have the same type as the active cell. If the active cell is a markdown cell, it will be unrendered.
Move the selected cell(s) down.
= The target notebook widget.
Move the selected cell(s) up.
Paste cells from the application clipboard.
The target notebook widget.
the mode of the paste operation: 'below' pastes cells below the active cell, 'above' pastes cells above the active cell, and 'replace' removes the currently selected cells and pastes cells in their place.
The last pasted cell becomes the active cell. This is a no-op if there is no cell data on the clipboard. This action can be undone.
Redo a cell action.
The target notebook widget.
This is a no-op if there are no cell actions to redo.
Run the selected cell(s).
The target notebook widget.
The optional client session object.
The last selected cell will be activated, but not scrolled into view. The existing selection will be cleared. An execution error will prevent the remaining code cells from executing. All markdown cells will be rendered.
Run all of the cells in the notebook.
The target notebook widget.
The optional client session object.
The existing selection will be cleared. An execution error will prevent the remaining code cells from executing. All markdown cells will be rendered. The last cell in the notebook will be activated and scrolled into view.
Run all of the cells before the currently active cell (exclusive).
The target notebook widget.
The optional client session object.
The existing selection will be cleared. An execution error will prevent the remaining code cells from executing. All markdown cells will be rendered. The currently active cell will remain selected.
Run all of the cells after the currently active cell (inclusive).
The target notebook widget.
The optional client session object.
The existing selection will be cleared. An execution error will prevent the remaining code cells from executing. All markdown cells will be rendered. The last cell in the notebook will be activated and scrolled into view.
Run the selected cell(s) and advance to the next cell.
The target notebook widget.
The optional client session object.
The existing selection will be cleared.
The cell after the last selected cell will be activated and scrolled into view.
An execution error will prevent the remaining code cells from executing.
All markdown cells will be rendered.
If the last selected cell is the last cell, a new code cell
will be created in 'edit' mode. The new cell creation can be undone.
Run the selected cell(s) and insert a new code cell.
The target notebook widget.
The optional client session object.
An execution error will prevent the remaining code cells from executing.
All markdown cells will be rendered.
The widget mode will be set to 'edit' after running.
The existing selection will be cleared.
The cell insert can be undone.
The new cell will be scrolled into view.
Select the above the active cell.
The target notebook widget.
The widget mode will be preserved. This is a no-op if the first cell is the active cell. This will skip any collapsed cells. The existing selection will be cleared.
Select all of the cells of the notebook.
the target notebook widget.
Select the cell below the active cell.
The target notebook widget.
The widget mode will be preserved. This is a no-op if the last cell is the active cell. This will skip any collapsed cells. The existing selection will be cleared.
Set the markdown header level.
The target notebook widget.
The header level.
All selected cells will be switched to markdown. The level will be clamped between 1 and 6. If there is an existing header, it will be replaced. There will always be one blank space after the header. The cells will be unrendered.
Show the code on all code cells.
Show the output on all code cells.
The target notebook widget.
Show the code on selected code cells.
The target notebook widget.
Show the output on selected code cells.
The target notebook widget.
Split the active cell into two cells.
Toggle the line number of all cells.
The target notebook widget.
The original state is based on the state of the active cell.
The mode of the widget will be preserved.
Trust the notebook after prompting the user.
The target notebook widget.
a promise that resolves when the transaction is finished.
No dialog will be presented if the notebook is already trusted.
Undo a cell action.
The target notebook widget.
This is a no-op if if there are no cell actions to undo.
Generated using TypeDoc
A collection of actions that run against notebooks. A namespace for
NotebookActionsstatic methods.Notes
All of the actions are a no-op if there is no model on the notebook. The actions set the widget
modeto'command'unless otherwise specified. The actions will preserve the selection on the notebook widget unless otherwise specified.