Interface IOutputAreaModel

The model for an output area.


Implemented by


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.

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.


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


    Returns number

    The total number of outputs.


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

  • Clear all of the output.


    • Optional wait: 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.

    Undefined Behavior

    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.


    Returns void

  • Get an item at the specified index.


    • index: number

    Returns IOutputModel

  • Set the value at the specified index.


    Returns void

  • Serialize the model to JSON.

    Returns IOutput[]

Generated using TypeDoc