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.
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.
(append-output notebook-cell-execution out)
(append-output notebook-cell-execution out cell)
Append to the output of the cell that is executing or to another cell that is affected by this execution.
Parameters:
out
: NotebookCellOutput | readonly NotebookCellOutput[]
- Output that is appended to the current output.cell
: NotebookCell | undefined
- Cell for which output is cleared. Defaults to the {@link NotebookCellExecution.cell cell} of
this execution.Returns: Thenable<void>
- 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. **Parameters:** - `out`: `NotebookCellOutput | readonly NotebookCellOutput[]` - Output that is appended to the current output. - `cell`: `NotebookCell | undefined` - Cell for which output is cleared. Defaults to the {@link NotebookCellExecution.cell cell} of this execution. **Returns:** `Thenable<void>` - A thenable that resolves when the operation finished.
(append-output-items notebook-cell-execution items output)
Append output items to existing cell output.
Parameters:
items
: NotebookCellOutputItem | readonly NotebookCellOutputItem[]
- Output items that are append to existing output.output
: NotebookCellOutput
- Output object that already exists.Returns: Thenable<void>
- A thenable that resolves when the operation finished.
Append output items to existing cell output. **Parameters:** - `items`: `NotebookCellOutputItem | readonly NotebookCellOutputItem[]` - Output items that are append to existing output. - `output`: `NotebookCellOutput` - Output object that already exists. **Returns:** `Thenable<void>` - A thenable that resolves when the operation finished.
(cell notebook-cell-execution)
The {@link NotebookCell cell} for which this execution has been created.
Returns: NotebookCell
The {@link NotebookCell cell} for which this execution has been created. **Returns:** `NotebookCell`
(clear-output notebook-cell-execution)
(clear-output notebook-cell-execution cell)
Clears the output of the cell that is executing or of another cell that is affected by this execution.
Parameters:
cell
: NotebookCell | undefined
- Cell for which output is cleared. Defaults to the {@link NotebookCellExecution.cell cell} of
this execution.Returns: Thenable<void>
- A thenable that resolves when the operation finished.
Clears the output of the cell that is executing or of another cell that is affected by this execution. **Parameters:** - `cell`: `NotebookCell | undefined` - Cell for which output is cleared. Defaults to the {@link NotebookCellExecution.cell cell} of this execution. **Returns:** `Thenable<void>` - A thenable that resolves when the operation finished.
(end notebook-cell-execution)
(end notebook-cell-execution success?)
(end notebook-cell-execution success? end-time)
Signal that execution has ended.
Parameters:
success?
: boolean | undefined
- 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.end-time
: number | undefined
- The time that execution finished, in milliseconds in the Unix epoch.Returns: void
Signal that execution has ended. **Parameters:** - `success?`: `boolean | undefined` - 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. - `end-time`: `number | undefined` - The time that execution finished, in milliseconds in the Unix epoch. **Returns:** `void`
(execution-order notebook-cell-execution)
Set and unset the order of this cell execution.
Returns: number | undefined
Set and unset the order of this cell execution. **Returns:** `number | undefined`
(replace-output notebook-cell-execution out)
(replace-output notebook-cell-execution out cell)
Replace the output of the cell that is executing or of another cell that is affected by this execution.
Parameters:
out
: NotebookCellOutput | readonly NotebookCellOutput[]
- Output that replaces the current output.cell
: NotebookCell | undefined
- Cell for which output is cleared. Defaults to the {@link NotebookCellExecution.cell cell} of
this execution.Returns: Thenable<void>
- 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. **Parameters:** - `out`: `NotebookCellOutput | readonly NotebookCellOutput[]` - Output that replaces the current output. - `cell`: `NotebookCell | undefined` - Cell for which output is cleared. Defaults to the {@link NotebookCellExecution.cell cell} of this execution. **Returns:** `Thenable<void>` - A thenable that resolves when the operation finished.
(replace-output-items notebook-cell-execution items output)
Replace all output items of existing cell output.
Parameters:
items
: NotebookCellOutputItem | readonly NotebookCellOutputItem[]
- Output items that replace the items of existing output.output
: NotebookCellOutput
- Output object that already exists.Returns: Thenable<void>
- A thenable that resolves when the operation finished.
Replace all output items of existing cell output. **Parameters:** - `items`: `NotebookCellOutputItem | readonly NotebookCellOutputItem[]` - Output items that replace the items of existing output. - `output`: `NotebookCellOutput` - Output object that already exists. **Returns:** `Thenable<void>` - A thenable that resolves when the operation finished.
(set-execution-order! notebook-cell-execution value)
Set and unset the order of this cell execution.
Set and unset the order of this cell execution.
(start notebook-cell-execution)
(start notebook-cell-execution start-time)
Signal that the execution has begun.
Parameters:
start-time
: number | undefined
- 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.Returns: void
Signal that the execution has begun. **Parameters:** - `start-time`: `number | undefined` - 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. **Returns:** `void`
(token notebook-cell-execution)
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}.
Returns: 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}. **Returns:** `CancellationToken`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close