Class Model

A VDomModel for the kernel status indicator.

Hierarchy (view full)

VDomModel
- Model

Index

Constructors

Properties

_activityName _kernelName _kernelStatus _sessionContext _statusNames _trans stateChanged translation

Accessors

activityName isDisposed kernelName sessionContext status

Methods

_getAllState _onKernelChanged _onKernelStatusChanged _triggerChange dispose

Constructors

constructor

new Model(translator?): KernelStatus.Model
Parameters
- Optional translator: ITranslator
Returns KernelStatus.Model
Overrides VDomModel.constructor
- Defined in packages/apputils/src/kernelstatuses.tsx:159

Properties

`Private` _activityName

_activityName: string = ''

`Private` _kernelName

_kernelName: string = ''

`Private` _kernelStatus

_kernelStatus: undefined | KernelDisplayStatus = ''

`Private` _sessionContext

_sessionContext: null | ISessionContext = null

`Private` `Readonly` _statusNames

_statusNames: Record<KernelDisplayStatus, string>

`Private` _trans

_trans: IRenderMime.TranslationBundle

`Readonly` stateChanged

stateChanged: Signal<KernelStatus.Model, void>

A signal emitted when any model state changes.

`Protected` translation

translation: ITranslator

Accessors

activityName

get activityName(): string
A display name for the activity.

Returns string
- Defined in packages/apputils/src/kernelstatuses.tsx:185
set activityName(val): void
Parameters
- val: string
Returns void
- Defined in packages/apputils/src/kernelstatuses.tsx:188

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

kernelName

get kernelName(): string
The name of the kernel.

Returns string
- Defined in packages/apputils/src/kernelstatuses.tsx:169

sessionContext

get sessionContext(): null | ISessionContext
The current client session associated with the kernel status indicator.

Returns null | ISessionContext
- Defined in packages/apputils/src/kernelstatuses.tsx:200
set sessionContext(sessionContext): void
Parameters
- sessionContext: null | ISessionContext
Returns void
- Defined in packages/apputils/src/kernelstatuses.tsx:203

status

get status(): undefined | string
The current status of the kernel.

Returns undefined | string
- Defined in packages/apputils/src/kernelstatuses.tsx:176

Methods

`Private` _getAllState

_getAllState(): State
Returns State
- Defined in packages/apputils/src/kernelstatuses.tsx:254

`Private` _onKernelChanged

_onKernelChanged(_sessionContext, change): void
React to changes in the kernel.
Parameters
- _sessionContext: ISessionContext
- change: IKernelChangedArgs
Returns void
- Defined in packages/apputils/src/kernelstatuses.tsx:242

`Private` _onKernelStatusChanged

_onKernelStatusChanged(): void
React to changes to the kernel status.

Returns void
- Defined in packages/apputils/src/kernelstatuses.tsx:234

`Private` _triggerChange

_triggerChange(oldState, newState): void
Parameters
- oldState: State
- newState: State
Returns void
- Defined in packages/apputils/src/kernelstatuses.tsx:258

dispose

dispose(): void
Dispose the model.

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