kotlin-vscode/vscode/NotebookCellExecution

NotebookCellExecution

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 {@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.

Online Documentation

Properties

cell

abstract val cell: NotebookCell

The cell for which this execution has been created.

executionOrder

abstract var executionOrder: Int?

Set and unset the order of this cell execution.

token

abstract val token: CancellationToken

A cancellation token which will be triggered when the cell execution is canceled from the UI.

Functions

appendOutput

abstract fun appendOutput(out: JsAny, cell: NotebookCell = definedExternally): PromiseLike<Void>

Append to the output of the cell that is executing or to another cell that is affected by this execution.

appendOutputItems

abstract fun appendOutputItems(items: JsAny, output: NotebookCellOutput): PromiseLike<Void>

Append output items to existing cell output.

clearOutput

abstract fun clearOutput(cell: NotebookCell = definedExternally): PromiseLike<Void>

Clears the output of the cell that is executing or of another cell that is affected by this execution.

end

abstract fun end(success: Boolean?, endTime: JsInt53 = definedExternally)

Signal that execution has ended.

replaceOutput

abstract fun replaceOutput(out: JsAny, cell: NotebookCell = definedExternally): PromiseLike<Void>

Replace the output of the cell that is executing or of another cell that is affected by this execution.

replaceOutputItems

abstract fun replaceOutputItems(items: JsAny, output: NotebookCellOutput): PromiseLike<Void>

Replace all output items of existing cell output.

start

abstract fun start(startTime: JsInt53 = definedExternally)

Signal that the execution has begun.