Class Model

The default implementation of the editor model.

Hierarchy

Model

Implements

IModel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Model(options?: IOptions): Model

- Defined in packages/codeeditor/src/editor.ts:226
Construct a new Model.

Parameters
- Optional options: IOptions
Returns Model

Properties

Private _isDisposed

_isDisposed: boolean = false

Private _mimeTypeChanged

_mimeTypeChanged: Signal<Model, IChangedArgs<string, string, string>> = ...

Private _sharedModelSwitched

_sharedModelSwitched: Signal<Model, boolean> = ...

Readonly modelDB

modelDB: IModelDB

The underlying IModelDB instance in which model data is stored.

sharedModel

sharedModel: ISharedText

The shared model for the cell editor.

Accessors

isDisposed

get isDisposed(): boolean

Implementation of IModel.isDisposed
- Defined in packages/codeeditor/src/editor.ts:394
Whether the model is disposed.

Returns boolean

mimeType

get mimeType(): string
set mimeType(newValue: string): void

Implementation of IModel.mimeType
- Defined in packages/codeeditor/src/editor.ts:380
A mime type of the model.

Returns string
Implementation of IModel.mimeType
- Defined in packages/codeeditor/src/editor.ts:383
A mime type of the model.

Notes

It is never null, the default mime type is text/plain.

Parameters
- newValue: string
Returns void

mimeTypeChanged

get mimeTypeChanged(): ISignal<this, IChangedArgs<string, string, string>>

Implementation of IModel.mimeTypeChanged
- Defined in packages/codeeditor/src/editor.ts:352
A signal emitted when a mimetype changes.

Returns ISignal<this, IChangedArgs<string, string, string>>

selections

get selections(): IObservableMap<ITextSelection[]>

Implementation of IModel.selections
- Defined in packages/codeeditor/src/editor.ts:373
Get the selections for the model.

Returns IObservableMap<ITextSelection[]>

sharedModelSwitched

get sharedModelSwitched(): ISignal<this, boolean>

Implementation of IModel.sharedModelSwitched
- Defined in packages/codeeditor/src/editor.ts:359
A signal emitted when the shared model was switched.

Returns ISignal<this, boolean>

type

get type(): CellType

- Defined in packages/codeeditor/src/editor.ts:334
Returns CellType

value

get value(): IObservableString

Implementation of IModel.value
- Defined in packages/codeeditor/src/editor.ts:366
Get the value of the model.

Returns IObservableString

Methods

Private _onModelDBMimeTypeChanged

_onModelDBMimeTypeChanged(mimeType: IObservableValue, args: IChangedArgs): void

- Defined in packages/codeeditor/src/editor.ts:409
Parameters
- mimeType: IObservableValue
- args: IChangedArgs
Returns void

Private _onModelDBValueChanged

_onModelDBValueChanged(value: IObservableString, event: IChangedArgs): void

- Defined in packages/codeeditor/src/editor.ts:309
Handle a change to the modelDB value.

Parameters
- value: IObservableString
- event: IChangedArgs
Returns void

Protected _onSharedModelChanged

_onSharedModelChanged(sender: ISharedBaseCell<any>, change: CellChange<IBaseCellMetadata>): void

- Defined in packages/codeeditor/src/editor.ts:284
We update the modeldb store when the shared model changes. To ensure that we don't run into infinite loops, we wrap this call in a "mutex". The "mutex" ensures that the wrapped code can only be executed by either the sharedModelChanged handler or the modelDB change handler.

Parameters
- sender: ISharedBaseCell<any>
- change: CellChange<IBaseCellMetadata>
Returns void

dispose

dispose(): void

Implementation of IModel.dispose
- Defined in packages/codeeditor/src/editor.ts:401
Dispose of the resources used by the model.

Returns void

switchSharedModel

switchSharedModel(sharedModel: ISharedText, reinitialize?: boolean): void

Implementation of IModel.switchSharedModel
- Defined in packages/codeeditor/src/editor.ts:262
When we initialize a cell model, we create a standalone model that cannot be shared in a YNotebook. Call this function to re-initialize the local representation based on a fresh shared model (e.g. models.YFile or models.YCodeCell).

Parameters
- sharedModel: ISharedText
- Optional reinitialize: boolean
  
  Whether to reinitialize the shared model.
Returns void

Generated using TypeDoc