A NotebookCellExecution is how {@link NotebookController 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 {@linkcode NotebookCellExecution.start start(...)} is called on the execution task, it enters the {@linkcode NotebookCellExecutionState.Executing Executing} state. When {@linkcode NotebookCellExecution.end end(...)} is called, it enters the {@linkcode NotebookCellExecutionState.Idle Idle} state.
Fields
read onlytoken:CancellationToken
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 {@link NotebookController controller} that created this execution uses an {@link NotebookController.interruptHandler interrupt-handler}.
start(?startTime:Float):Void
Signal that the execution has begun.
Parameters:
startTime | 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. |
|---|
replaceOutputItems(items:EitherType<NotebookCellOutputItem, Array<NotebookCellOutputItem>>, output:NotebookCellOutput):Thenable<Void>
Replace all output items of existing cell output.
Parameters:
items | Output items that replace the items of existing output. |
|---|---|
output | Output object that already exists. |
Returns:
A thenable that resolves when the operation finished.
replaceOutput(out:EitherType<NotebookCellOutput, Array<NotebookCellOutput>>, ?cell:NotebookCell):Thenable<Void>
Replace the output of the cell that is executing or of another cell that is affected by this execution.
@link NotebookCellExecution.cell cell} of this execution.
Parameters:
out | Output that replaces the current output. |
|---|---|
cell | Cell for which output is cleared. Defaults to the { |
Returns:
A thenable that resolves when the operation finished.
end(success:Null<Bool>, ?endTime:Float):Void
Signal that execution has ended.
Parameters:
success | 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. |
|---|---|
endTime | The time that execution finished, in milliseconds in the Unix epoch. |
clearOutput(?cell:NotebookCell):Thenable<Void>
Clears the output of the cell that is executing or of another cell that is affected by this execution.
@link NotebookCellExecution.cell cell} of this execution.
Parameters:
cell | Cell for which output is cleared. Defaults to the { |
|---|
Returns:
A thenable that resolves when the operation finished.
appendOutputItems(items:EitherType<NotebookCellOutputItem, Array<NotebookCellOutputItem>>, output:NotebookCellOutput):Thenable<Void>
Append output items to existing cell output.
Parameters:
items | Output items that are append to existing output. |
|---|---|
output | Output object that already exists. |
Returns:
A thenable that resolves when the operation finished.
appendOutput(out:EitherType<NotebookCellOutput, Array<NotebookCellOutput>>, ?cell:NotebookCell):Thenable<Void>
Append to the output of the cell that is executing or to another cell that is affected by this execution.
@link NotebookCellExecution.cell cell} of this execution.
Parameters:
out | Output that is appended to the current output. |
|---|---|
cell | Cell for which output is cleared. Defaults to the { |
Returns:
A thenable that resolves when the operation finished.