Options
All
  • Public
  • Public/Protected
  • All
Menu

A VDomModel for the execution status indicator.

Hierarchy

Index

Constructors

constructor

Properties

Private _cellExecutedCallback

_cellExecutedCallback: any

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

param

The notebook which contains the executed code cell.

param

The id of message.

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.

Private _cellScheduledCallback

_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.

Private _currentNotebook

_currentNotebook: any

Current activated notebook.

Private _displayOption

_displayOption: any

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

Private _notebookExecutionProgress

_notebookExecutionProgress: any

A weak map to hold execution status of multiple notebooks.

Private _renderFlag

_renderFlag: any

A flag to show or hide the indicator.

Private _resetTime

_resetTime: any

Reset the input execution state.

param

the state to be rested.

Private _startTimer

_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.

Private _tick

_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.

Readonly stateChanged

stateChanged: Signal<Model, void>

A signal emitted when any model state changes.

Accessors

currentNotebook

  • The current activated notebook in model.

    Returns Notebook

displayOption

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

    Returns DisplayOption

  • Set the display options for progress bar and elapsed time.

    Parameters

    • options: DisplayOption

      Options to be used

    Returns void

isDisposed

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

    Returns boolean

renderFlag

  • get renderFlag(): boolean
  • Returns boolean

Methods

attachNotebook

  • 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

  • dispose(): void
  • Dispose the model.

    Returns void

executionState

  • executionState(nb: Notebook): IExecutionState
  • Get the execution state associated with a notebook.

    Parameters

    • nb: Notebook

      The notebook used to identify execution state.

    Returns IExecutionState

    • The associated execution state.

updateRenderOption

  • updateRenderOption(options: { showOnToolBar: boolean; showProgress: boolean }): void
  • Parameters

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

    Returns void

Generated using TypeDoc