Interface ICodeModel

The interface for a document model that represents code.

interface ICodeModel {
    collaborative?: boolean;
    contentChanged: ISignal<ICodeModel, void>;
    defaultKernelLanguage: string;
    defaultKernelName: string;
    dirty: boolean;
    isDisposed: boolean;
    mimeType: string;
    mimeTypeChanged: ISignal<
        CodeEditor.IModel,
        IChangedArgs<string, string, string>,
    >;
    readOnly: boolean;
    selections: IObservableMap<ITextSelection[]>;
    sharedModel: ISharedFile;
    stateChanged: ISignal<ICodeModel, IChangedArgs<any, any, string>>;
    dispose(): void;
    fromJSON(value: ReadonlyPartialJSONValue): void;
    fromString(value: string): void;
    toJSON(): PartialJSONValue;
    toString(): string;
}

Hierarchy (View Summary)

Implemented by

Properties

collaborative? contentChanged defaultKernelLanguage defaultKernelName dirty isDisposed mimeType mimeTypeChanged readOnly selections sharedModel stateChanged

Methods

dispose fromJSON fromString toJSON toString

Properties

Optional Readonlycollaborative

collaborative?: boolean

Whether this document model supports collaboration when the collaborative flag is enabled globally. Defaults to false.

contentChanged

contentChanged: ISignal<ICodeModel, void>

A signal emitted when the document content changes.

ReadonlydefaultKernelLanguage

defaultKernelLanguage: string

The default kernel language of the document.

ReadonlydefaultKernelName

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.

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.

readOnly

readOnly: boolean

The read-only state of the model.

Readonlyselections

selections: IObservableMap<ITextSelection[]>

The currently selected code.

sharedModel

sharedModel: ISharedFile

The shared notebook model.

stateChanged

stateChanged: ISignal<ICodeModel, IChangedArgs<any, any, string>>

A signal emitted when the model state changes.

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

fromString

toJSON

toString

Settings

Member Visibility

On This Page

Properties
Methods