Interface IOutputAreaModel

The model for an output area.

interface IOutputAreaModel {
    changed: ISignal<IOutputAreaModel, IOutputAreaModel.ChangedArgs>;
    contentFactory: IOutputAreaModel.IContentFactory;
    isDisposed: boolean;
    length: number;
    stateChanged: ISignal<IOutputAreaModel, number>;
    trusted: boolean;
    add(output: IOutput): number;
    appendStreamOutput(text: string): void;
    clear(wait?: boolean): void;
    dispose(): void;
    fromJSON(values: IOutput[]): void;
    get(index: number): IOutputModel;
    remove(index: number): void;
    removeStreamOutput(number: number): void;
    set(index: number, output: IOutput): void;
    toJSON(): IOutput[];
}

Hierarchy (View Summary)

Implemented by

Properties

changed contentFactory isDisposed length stateChanged trusted

Methods

add appendStreamOutput clear dispose fromJSON get remove removeStreamOutput set toJSON

Properties

Readonlychanged

changed: ISignal<IOutputAreaModel, IOutputAreaModel.ChangedArgs>

A signal emitted when the list of items changes.

ReadonlycontentFactory

contentFactory: IOutputAreaModel.IContentFactory

The output content factory used by the model.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlylength

length: number

The length of the items in the model.

ReadonlystateChanged

stateChanged: ISignal<IOutputAreaModel, number>

A signal emitted when the output item changes.

The number is the index of the output that changed.

trusted

trusted: boolean

Whether the output area is trusted.

Methods

add

  • add(output: IOutput): number

  • Add an output, which may be combined with previous output.

    Parameters

    Returns number

    The total number of outputs.

    Notes

    The output bundle is copied. Contiguous stream outputs of the same name are combined.

appendStreamOutput

clear

  • clear(wait?: boolean): void

  • Clear all of the output.

    Parameters

    • Optionalwait: boolean

      Delay clearing the output until the next message is added.

    Returns void

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

get

remove

removeStreamOutput

set

toJSON

Settings

Member Visibility

On This Page

Properties
Methods