Interface NotebookCellExecution

Readonlycell

executionOrder

Readonlytoken

appendOutput

• appendOutput(
      out: NotebookCellOutput | readonly 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.

  Parameters

  • out: NotebookCellOutput | readonly NotebookCellOutput[]

    Output that is appended to the current output.

  • Optionalcell: NotebookCell

    Cell for which output is cleared. Defaults to the cell of this execution.

  Returns Thenable<void>

  A thenable that resolves when the operation finished.

appendOutputItems

• appendOutputItems(
      items: NotebookCellOutputItem | readonly NotebookCellOutputItem[],
      output: NotebookCellOutput,
  ): Thenable<void>

  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.

clearOutput

• clearOutput(cell?: NotebookCell): Thenable<void>

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

  Parameters

  • Optionalcell: NotebookCell

    Cell for which output is cleared. Defaults to the cell of this execution.

  Returns Thenable<void>

  A thenable that resolves when the operation finished.

end

• end(success: undefined | boolean, endTime?: number): void

  Signal that execution has ended.

  Parameters

  • success: undefined | boolean

    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.

  • OptionalendTime: number

    The time that execution finished, in milliseconds in the Unix epoch.

  Returns void

replaceOutput

• replaceOutput(
      out: NotebookCellOutput | readonly NotebookCellOutput[],
      cell?: NotebookCell,
  ): Thenable<void>

  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.

  • Optionalcell: NotebookCell

    Cell for which output is cleared. Defaults to the cell of this execution.

  Returns Thenable<void>

  A thenable that resolves when the operation finished.

replaceOutputItems

• replaceOutputItems(
      items: NotebookCellOutputItem | readonly NotebookCellOutputItem[],
      output: NotebookCellOutput,
  ): Thenable<void>

  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.

start

• start(startTime?: number): void

  Signal that the execution has begun.

  Parameters

  • OptionalstartTime: number

    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