Class DocumentModel

The default implementation of a document model.

Hierarchy

Model
- DocumentModel

Implements

ICodeModel

Constructors

constructor

new DocumentModel(options?): DocumentModel
Construct a new document model.
Parameters
- Optional options: DocumentRegistry.IModelOptions<ISharedFile>
Returns DocumentModel
Overrides CodeEditor.Model.constructor
- Defined in packages/docregistry/lib/default.d.ts:18

Properties

`Private` _collaborationEnabled

_collaborationEnabled: any

`Private` _contentChanged

_contentChanged: any

`Private` _defaultLang

_defaultLang: any

`Private` _dirty

_dirty: any

`Private` _onStateChanged

_onStateChanged: any

`Private` _readOnly

_readOnly: any

`Private` _stateChanged

_stateChanged: any

`Readonly` sharedModel

sharedModel: ISharedFile

The shared notebook model.

`Protected` standaloneModel

standaloneModel: boolean

Whether the model should disposed the shared model on disposal or not.

Accessors

collaborative

get collaborative(): boolean
Whether the model is collaborative or not.

Returns boolean
Implementation of ICodeModel.collaborative
- Defined in packages/docregistry/lib/default.d.ts:54

contentChanged

get contentChanged(): ISignal<this, void>
A signal emitted when the document content changes.

Returns ISignal<this, void>
Implementation of ICodeModel.contentChanged
- Defined in packages/docregistry/lib/default.d.ts:22

defaultKernelLanguage

get defaultKernelLanguage(): string
The default kernel language of the document.

Notes
This is a read-only property.

Returns string
Implementation of ICodeModel.defaultKernelLanguage
- Defined in packages/docregistry/lib/default.d.ts:50

defaultKernelName

get defaultKernelName(): string
The default kernel name of the document.

Notes
This is a read-only property.

Returns string
Implementation of ICodeModel.defaultKernelName
- Defined in packages/docregistry/lib/default.d.ts:43

dirty

get dirty(): boolean
The dirty state of the document.

Returns boolean
Implementation of ICodeModel.dirty
- Defined in packages/docregistry/lib/default.d.ts:30
set dirty(newValue): void
The dirty state of the model.

Notes
This should be cleared when the document is loaded from or saved to disk.
Parameters
- newValue: boolean
Returns void
Implementation of ICodeModel.dirty
- Defined in packages/docregistry/lib/default.d.ts:31

isDisposed

get isDisposed(): boolean
Whether the model is disposed.

Returns boolean
Implementation of ICodeModel.isDisposed

Inherited from CodeEditor.Model.isDisposed
- Defined in packages/codeeditor/lib/editor.d.ts:164

mimeType

get mimeType(): string
A mime type of the model.

Returns string
Implementation of ICodeModel.mimeType

Inherited from CodeEditor.Model.mimeType
- Defined in packages/codeeditor/lib/editor.d.ts:159
set mimeType(newValue): void
A mime type of the model.

Notes
It is never null, the default mime type is text/plain.
Parameters
- newValue: string
Returns void
Implementation of ICodeModel.mimeType

Inherited from CodeEditor.Model.mimeType
- Defined in packages/codeeditor/lib/editor.d.ts:160

mimeTypeChanged

get mimeTypeChanged(): ISignal<this, IChangedArgs<string, string, string>>
A signal emitted when a mimetype changes.

Returns ISignal<this, IChangedArgs<string, string, string>>
Implementation of ICodeModel.mimeTypeChanged

Inherited from CodeEditor.Model.mimeTypeChanged
- Defined in packages/codeeditor/lib/editor.d.ts:151

readOnly

get readOnly(): boolean
The read only state of the document.

Returns boolean
Implementation of ICodeModel.readOnly
- Defined in packages/docregistry/lib/default.d.ts:35
set readOnly(newValue): void
The read-only state of the model.
Parameters
- newValue: boolean
Returns void
Implementation of ICodeModel.readOnly
- Defined in packages/docregistry/lib/default.d.ts:36

selections

get selections(): IObservableMap<ITextSelection[]>
Get the selections for the model.

Returns IObservableMap<ITextSelection[]>
Implementation of ICodeModel.selections

Inherited from CodeEditor.Model.selections
- Defined in packages/codeeditor/lib/editor.d.ts:155

stateChanged

get stateChanged(): ISignal<this, IChangedArgs<any, any, string>>
A signal emitted when the document state changes.

Returns ISignal<this, IChangedArgs<any, any, string>>
Implementation of ICodeModel.stateChanged
- Defined in packages/docregistry/lib/default.d.ts:26

Methods

dispose

dispose(): void
Dispose of the resources used by the model.

Returns void
Implementation of ICodeModel.dispose

Inherited from CodeEditor.Model.dispose
- Defined in packages/codeeditor/lib/editor.d.ts:168

fromJSON

fromJSON(value): void
Deserialize the model from JSON.

Notes
Should emit a [contentChanged] signal.
Parameters
- value: PartialJSONValue
Returns void
Implementation of ICodeModel.fromJSON
- Defined in packages/docregistry/lib/default.d.ts:76

fromString

fromString(value): void
Deserialize the model from a string.

Notes
Should emit a [contentChanged] signal.
Parameters
- value: string
Returns void
Implementation of ICodeModel.fromString
- Defined in packages/docregistry/lib/default.d.ts:65

initialize

initialize(): void
Initialize the model with its current state.

Returns void
- Defined in packages/docregistry/lib/default.d.ts:80

toJSON

toJSON(): PartialJSONValue
Serialize the model to JSON.

Returns PartialJSONValue
Implementation of ICodeModel.toJSON
- Defined in packages/docregistry/lib/default.d.ts:69

toString

toString(): string
Serialize the model to a string.

Returns string
Implementation of ICodeModel.toString
- Defined in packages/docregistry/lib/default.d.ts:58

`Protected` triggerContentChange

triggerContentChange(): void
Trigger a content changed signal.

Returns void
- Defined in packages/docregistry/lib/default.d.ts:88

`Protected` triggerStateChange

triggerStateChange(args): void
Trigger a state change signal.
Parameters
- args: IChangedArgs<any, any, string>
Returns void
- Defined in packages/docregistry/lib/default.d.ts:84

Class DocumentModel

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: DocumentRegistry.IModelOptions<ISharedFile>

Returns DocumentModel

Properties

Private _collaborationEnabled

Private _contentChanged

Private _defaultLang

Private _dirty

Private _onStateChanged

Private _readOnly

Private _stateChanged

Readonly sharedModel

Protected standaloneModel

Accessors

collaborative

Returns boolean

contentChanged

Returns ISignal<this, void>

defaultKernelLanguage

Notes

Returns string

defaultKernelName

Notes

Returns string

dirty

Returns boolean

Notes

Parameters

newValue: boolean

Returns void

isDisposed

Returns boolean

mimeType

Returns string

Notes

Parameters

newValue: string

Returns void

mimeTypeChanged

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

readOnly

Returns boolean

Parameters

newValue: boolean

Returns void

selections

Returns IObservableMap<ITextSelection[]>

stateChanged

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

Methods

dispose

Returns void

fromJSON

Notes

Parameters

value: PartialJSONValue

Returns void

fromString

Notes

Parameters

value: string

Returns void

initialize

Returns void

toJSON

Returns PartialJSONValue

toString

Returns string

Protected triggerContentChange

Returns void

`Optional` options: DocumentRegistry.IModelOptions<ISharedFile>

`Private` _collaborationEnabled

`Private` _contentChanged

`Private` _defaultLang

`Private` _dirty

`Private` _onStateChanged

`Private` _readOnly

`Private` _stateChanged

`Readonly` sharedModel

`Protected` standaloneModel

`Protected` triggerContentChange

`Protected` triggerStateChange