Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOutputAreaModel

The model for an output area.

Hierarchy

Implemented by

Index

Properties

Readonly changed

changed: ISignal<IOutputAreaModel, ChangedArgs>

A signal emitted when the model changes.

Readonly contentFactory

contentFactory: IContentFactory

The output content factory used by the model.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly length

length: number

The length of the items in the model.

Optional maxNumberOutputs

maxNumberOutputs: number

The maximum number of output items to display on top and bottom of cell output.

Readonly stateChanged

stateChanged: ISignal<IOutputAreaModel, void>

A signal emitted when the model state changes.

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

    • output: IOutput

    Returns number

    The total number of outputs.

    Notes

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

clear

  • clear(wait?: boolean): void
  • Clear all of the output.

    Parameters

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

  • fromJSON(values: IOutput[]): void
  • Deserialize the model from JSON.

    Notes

    This will clear any existing data.

    Parameters

    • values: IOutput[]

    Returns void

get

  • Get an item at the specified index.

    Parameters

    • index: number

    Returns IOutputModel

set

  • set(index: number, output: IOutput): void
  • Set the value at the specified index.

    Parameters

    • index: number
    • output: IOutput

    Returns void

toJSON

  • toJSON(): IOutput[]
  • Serialize the model to JSON.

    Returns IOutput[]

Generated using TypeDoc