A VDomModel for the execution status indicator.

Hierarchy

Constructors

Properties

_cellExecutedCallback: any

The function is called on kernel's idle status message. It is used to keep track of number of executed cells or Comm custom messages and the status of kernel.

Param

The notebook which contains the executed code cell.

Param

The id of message.

_cellScheduledCallback: any

The function is called on kernel's execute_request message or Comm message, it is used to keep track number of scheduled cell or Comm execution message and the status of kernel.

Param

The notebook which contains the scheduled code. cell

Param

The id of message.

_currentNotebook: any

Current activated notebook.

_displayOption: any

The option to show the indicator on status bar or toolbar.

_notebookExecutionProgress: any

A weak map to hold execution status of multiple notebooks.

_renderFlag: any

A flag to show or hide the indicator.

_resetTime: any

Reset the input execution state.

Param

the state to be rested.

_restartHandler: any

The function is called on kernel's restarting status message. It is used to clear the state tracking the number of executed cells.

Param

The notebook which contains the executed code cell.

_scheduleSwitchToIdle: any

Schedule switch to idle status and clearing of the timer.

Note

To keep track of cells executed under 1 second, the execution state is marked as needReset 1 second after executing these cells. This Timeout will be cleared if there is any cell scheduled after that.

_startTimer: any

This function is called on kernel's execute_input message to start the elapsed time counter.

Param

The notebook which contains the scheduled execution request.

_tick: any

Increment the executed time of input execution state and emit stateChanged signal to re-render the indicator.

Param

the state to be updated.

stateChanged: Signal<ExecutionIndicator.Model, void>

A signal emitted when any model state changes.

Accessors

  • get currentNotebook(): Notebook
  • The current activated notebook in model.

    Returns Notebook

  • get displayOption(): DisplayOption
  • The display options for progress bar and elapsed time.

    Returns DisplayOption

  • set displayOption(options): void
  • Set the display options for progress bar and elapsed time.

    Parameters

    • options: DisplayOption

      Options to be used

    Returns void

  • get isDisposed(): boolean
  • Test whether the model is disposed.

    Returns boolean

  • get renderFlag(): boolean
  • Returns boolean

Methods

  • Attach a notebook with session context to model in order to keep track of multiple notebooks. If a session context is already attached, only set current activated notebook to input.

    Parameters

    Returns void

  • Dispose the model.

    Returns void

  • Get the execution state associated with a notebook.

    Parameters

    • nb: Notebook

      The notebook used to identify execution state.

    Returns IExecutionState

    • The associated execution state.
  • Parameters

    • options: {
          showOnToolBar: boolean;
          showProgress: boolean;
      }
      • showOnToolBar: boolean
      • showProgress: boolean

    Returns void

Generated using TypeDoc