Class Model

A VDomModel for the execution status indicator.

Hierarchy (View Summary)

VDomModel
- Model

Index

Constructors

Properties

Accessors

currentNotebook displayOption isDisposed renderFlag

Methods

attachNotebook dispose executionState updateRenderOption

Constructors

constructor

new Model(): ExecutionIndicator.Model
Returns ExecutionIndicator.Model
Overrides VDomModel.constructor
- Defined in packages/notebook/src/executionindicator.tsx:288

Properties

`Readonly`stateChanged

stateChanged: Signal<ExecutionIndicator.Model, void>

A signal emitted when any model state changes.

Accessors

currentNotebook

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

Returns null | Notebook
- Defined in packages/notebook/src/executionindicator.tsx:406

displayOption

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

Returns DisplayOption
- Defined in packages/notebook/src/executionindicator.tsx:413
set displayOption(options: DisplayOption): void
Set the display options for progress bar and elapsed time.
Parameters
- options: DisplayOption
  Options to be used
Returns void
- Defined in packages/notebook/src/executionindicator.tsx:422

isDisposed

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

Returns boolean
Inherited from VDomModel.isDisposed
- Defined in packages/ui-components/lib/components/vdom.d.ts:184

renderFlag

get renderFlag(): boolean
Returns boolean
- Defined in packages/notebook/src/executionindicator.tsx:564

Methods

attachNotebook

attachNotebook(
data: null | { content?: Notebook; context?: ISessionContext },
): void
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
- data: null | { content?: Notebook; context?: ISessionContext }
  The notebook and session context to be attached to model
Returns void
- Defined in packages/notebook/src/executionindicator.tsx:301

dispose

dispose(): void
Dispose the model.

Returns void
Inherited from VDomModel.dispose
- Defined in packages/ui-components/lib/components/vdom.d.ts:188

executionState

executionState(nb: Notebook): undefined | IExecutionState
Get the execution state associated with a notebook.
Parameters
- nb: Notebook
  The notebook used to identify execution state.
Returns undefined | IExecutionState
- The associated execution state.
- Defined in packages/notebook/src/executionindicator.tsx:434

updateRenderOption

updateRenderOption(
options: { showOnToolBar: boolean; showProgress: boolean },
): void
Parameters
- options: { showOnToolBar: boolean; showProgress: boolean }
Returns void
- Defined in packages/notebook/src/executionindicator.tsx:568