Interface ILoggerOutputAreaModel

The model for an output area.

interface ILoggerOutputAreaModel {
    changed: ISignal<IOutputAreaModel, IOutputAreaModel.ChangedArgs>;
    contentFactory: IOutputAreaModel.IContentFactory;
    isDisposed: boolean;
    length: number;
    maxLength: 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

A signal emitted when the list of items changes.

The output content factory used by the model.

isDisposed: boolean

Test whether the object has been disposed.

This property is always safe to access.

length: number

The length of the items in the model.

maxLength: number

The maximum number of outputs to store.

stateChanged: ISignal<IOutputAreaModel, number>

A signal emitted when the output item changes.

The number is the index of the output that changed.

trusted: boolean

Whether the output area is trusted.

Methods

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

    Parameters

    Returns number

    The total number of outputs.

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

  • Parameters

    • text: string

    Returns void

  • Clear all of the output.

    Parameters

    • Optionalwait: boolean

      Delay clearing the output until the next message is added.

    Returns void

  • Dispose of the resources held by the object.

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

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

    Returns void

  • Deserialize the model from JSON.

    This will clear any existing data.

    Parameters

    Returns void

  • Remove an output at a given index.

    Parameters

    • index: number

    Returns void

  • Parameters

    • number: number

    Returns void

  • Set the value at the specified index.

    Parameters

    Returns void