Interface IModel

An editor model.

interface IModel {
    isDisposed: boolean;
    mimeType: string;
    mimeTypeChanged: ISignal<
        CodeEditor.IModel,
        IChangedArgs<string, string, string>,
    >;
    selections: IObservableMap<ITextSelection[]>;
    sharedModel: ISharedText;
    dispose(): void;
}

Hierarchy (View Summary)

Implemented by

Properties

isDisposed mimeType mimeTypeChanged selections sharedModel

Methods

dispose

Properties

ReadonlyisDisposed

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<
    CodeEditor.IModel,
    IChangedArgs<string, string, string>,
>

A signal emitted when a property changes.

Readonlyselections

selections: IObservableMap<ITextSelection[]>

The currently selected code.

ReadonlysharedModel

sharedModel: ISharedText

The shared model for the cell editor.

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

Settings

Member Visibility

On This Page

Properties
Methods