The cell for which this execution has been created.
A cancellation token which will be triggered when the cell execution is canceled from the UI.
Note that the cancellation token will not be triggered when the controller that created this execution uses an interrupt-handler.
Set and unset the order of this cell execution.
Signal that the execution has begun.
The time that execution began, in milliseconds in the Unix epoch. Used to drive the clock that shows for how long a cell has been running. If not given, the clock won't be shown.
Signal that execution has ended.
If true, a green check is shown on the cell status bar. If false, a red X is shown. If undefined, no check or X icon is shown.
The time that execution finished, in milliseconds in the Unix epoch.
Clears the output of the cell that is executing or of another cell that is affected by this execution.
Cell for which output is cleared. Defaults to the cell of this execution.
A thenable that resolves when the operation finished.
Replace the output of the cell that is executing or of another cell that is affected by this execution.
Output that replaces the current output.
Cell for which output is cleared. Defaults to the cell of this execution.
A thenable that resolves when the operation finished.
Append to the output of the cell that is executing or to another cell that is affected by this execution.
Output that is appended to the current output.
Cell for which output is cleared. Defaults to the cell of this execution.
A thenable that resolves when the operation finished.
Replace all output items of existing cell output.
Output items that replace the items of existing output.
Output object that already exists.
A thenable that resolves when the operation finished.
Append output items to existing cell output.
Output items that are append to existing output.
Output object that already exists.
A thenable that resolves when the operation finished.
A NotebookCellExecution is how notebook controller modify a notebook cell as it is executing.
When a cell execution object is created, the cell enters the {@linkcode NotebookCellExecutionState.Pending Pending} state. When
start(...)
is called on the execution task, it enters the {@linkcode NotebookCellExecutionState.Executing Executing} state. Whenend(...)
is called, it enters the {@linkcode NotebookCellExecutionState.Idle Idle} state.