Options
All
  • Public
  • Public/Protected
  • All
Menu

The interface for a document model that represents code.

Hierarchy

Implemented by

Index

Properties

contentChanged

contentChanged: ISignal<this, void>

A signal emitted when the document content changes.

defaultKernelLanguage

defaultKernelLanguage: string

The default kernel language of the document.

defaultKernelName

defaultKernelName: string

The default kernel name of the document.

dirty

dirty: boolean

The dirty state of the model.

Notes

This should be cleared when the document is loaded from or saved to disk.

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

mimeType

mimeType: string

A mime type of the model.

Notes

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

mimeTypeChanged

mimeTypeChanged: ISignal<IModel, IChangedArgs<string>>

A signal emitted when a property changes.

modelDB

modelDB: IModelDB

The underlying IModelDB instance in which model data is stored.

Notes

Making direct edits to the values stored in theIModelDB is not recommended, and may produce unpredictable results.

readOnly

readOnly: boolean

The read-only state of the model.

selections

The currently selected code.

stateChanged

stateChanged: ISignal<this, IChangedArgsGeneric<any>>

A signal emitted when the model state changes.

value

The text stored in the model.

Methods

dispose

  • dispose(): void
  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

fromJSON

  • fromJSON(value: ReadonlyPartialJSONValue): void

fromString

  • fromString(value: string): void

initialize

  • initialize(): void

toJSON

  • toJSON(): PartialJSONValue

toString

  • toString(): string

Generated using TypeDoc