Class DocumentModel

constructor

• new DocumentModel(
      options?: DocumentRegistry.IModelOptions<ISharedFile>,
  ): DocumentModel

• Construct a new document model.

  Parameters

  • options: DocumentRegistry.IModelOptions<ISharedFile> = {}

  Returns DocumentModel

ReadonlysharedModel

collaborative

• get collaborative(): boolean

• Whether the model is collaborative or not.

  Returns boolean

contentChanged

• get contentChanged(): ISignal<this, void>

• A signal emitted when the document content changes.

  Returns ISignal<this, void>

defaultKernelLanguage

• get defaultKernelLanguage(): string

• The default kernel language of the document.

  Notes

  This is a read-only property.

  Returns string

defaultKernelName

• get defaultKernelName(): string

• The default kernel name of the document.

  Notes

  This is a read-only property.

  Returns string

dirty

• get dirty(): boolean

• The dirty state of the document.

  Returns boolean
• set dirty(newValue: boolean): 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

readOnly

• get readOnly(): boolean

• The read only state of the document.

  Returns boolean
• set readOnly(newValue: boolean): void

• The read-only state of the model.

  Parameters

  • newValue: boolean

  Returns void

stateChanged

• get stateChanged(): ISignal<this, IChangedArgs<any, any, string>>

• A signal emitted when the document state changes.

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

fromJSON

• fromJSON(value: PartialJSONValue): void

• Deserialize the model from JSON.

  Notes

  Should emit a [contentChanged] signal.

  Parameters

  • value: PartialJSONValue

  Returns void

fromString

• fromString(value: string): void

• Deserialize the model from a string.

  Notes

  Should emit a [contentChanged] signal.

  Parameters

  • value: string

  Returns void

initialize

• initialize(): void

• Initialize the model with its current state.

  Returns void

toJSON

• toJSON(): PartialJSONValue

• Serialize the model to JSON.

  Returns PartialJSONValue

toString

• toString(): string

• Serialize the model to a string.

  Returns string