Class OutputAreaModel

The default implementation of the IOutputAreaModel.

Hierarchy

OutputAreaModel

Implements

IOutputAreaModel

Index

Constructors

Properties

_changed _isDisposed _lastName _lastStream _stateChanged _trusted clearNext contentFactory list

Accessors

changed isDisposed length stateChanged trusted

Methods

_add _createItem _onGenericChange _onListChanged add clear dispose fromJSON get set shouldCombine toJSON

Constructors

constructor

new OutputAreaModel(options?): OutputAreaModel
Construct a new observable outputs instance.
Parameters
- options: IOutputAreaModel.IOptions = {}
Returns OutputAreaModel
- Defined in packages/outputarea/src/model.ts:134

Properties

`Private` _changed

_changed: Signal<OutputAreaModel, IOutputAreaModel.ChangedArgs> = ...

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _lastName

_lastName: "stdout" | "stderr"

`Private` _lastStream

_lastStream: string = ''

`Private` _stateChanged

_stateChanged: Signal<OutputAreaModel, number> = ...

`Private` _trusted

_trusted: boolean = false

`Protected` clearNext

clearNext: boolean = false

A flag that is set when we want to clear the output area after the next addition to it.

`Readonly` contentFactory

contentFactory: IOutputAreaModel.IContentFactory

The output content factory used by the model.

`Protected` list

list: IObservableList<IOutputModel>

An observable list containing the output models for this output area.

Accessors

changed

get changed(): ISignal<IOutputAreaModel, IOutputAreaModel.ChangedArgs>
A signal emitted when the list of items changes.

Returns ISignal<IOutputAreaModel, IOutputAreaModel.ChangedArgs>
Implementation of IOutputAreaModel.changed
- Defined in packages/outputarea/src/model.ts:159

isDisposed

get isDisposed(): boolean
Test whether the model is disposed.

Returns boolean
Implementation of IOutputAreaModel.isDisposed
- Defined in packages/outputarea/src/model.ts:205

length

get length(): number
Get the length of the items in the model.

Returns number
Implementation of IOutputAreaModel.length
- Defined in packages/outputarea/src/model.ts:166

stateChanged

get stateChanged(): ISignal<IOutputAreaModel, number>
A signal emitted when an item changes.

Returns ISignal<IOutputAreaModel, number>
Implementation of IOutputAreaModel.stateChanged
- Defined in packages/outputarea/src/model.ts:152

trusted

get trusted(): boolean
Get whether the model is trusted.

Returns boolean
Implementation of IOutputAreaModel.trusted
- Defined in packages/outputarea/src/model.ts:173
set trusted(value): void
Set whether the model is trusted.

Notes
Changing the value will cause all of the models to re-set.
Parameters
- value: boolean
Returns void
Implementation of IOutputAreaModel.trusted
- Defined in packages/outputarea/src/model.ts:183

Methods

`Private` _add

_add(value): number
Add a copy of the item to the list.
Parameters
- value: IOutput
Returns number
The list length
- Defined in packages/outputarea/src/model.ts:302

`Private` _createItem

_createItem(options): IOutputModel
Create an output item and hook up its signals.
Parameters
- options: IOutputModel.IOptions
Returns IOutputModel
- Defined in packages/outputarea/src/model.ts:380

`Private` _onGenericChange

_onGenericChange(itemModel): void
Handle a change to an item.
Parameters
- itemModel: IOutputModel
Returns void
- Defined in packages/outputarea/src/model.ts:419

`Private` _onListChanged

_onListChanged(sender, args): void
Handle a change to the list.
Parameters
- sender: IObservableList<IOutputModel>
- args: IObservableList.IChangedArgs<IOutputModel>
Returns void
- Defined in packages/outputarea/src/model.ts:389

add

add(output): 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.
Implementation of IOutputAreaModel.add
- Defined in packages/outputarea/src/model.ts:248

clear

clear(wait?): void
Clear all of the output.
Parameters
- wait: boolean = false
  Delay clearing the output until the next message is added.
Returns void
Implementation of IOutputAreaModel.clear
- Defined in packages/outputarea/src/model.ts:263

dispose

dispose(): void
Dispose of the resources used by the model.

Returns void
Implementation of IOutputAreaModel.dispose
- Defined in packages/outputarea/src/model.ts:212

fromJSON

fromJSON(values): void
Deserialize the model from JSON.

Notes
This will clear any existing data.
Parameters
- values: IOutput[]
Returns void
Implementation of IOutputAreaModel.fromJSON
- Defined in packages/outputarea/src/model.ts:281

get

get(index): IOutputModel
Get an item at the specified index.
Parameters
- index: number
Returns IOutputModel
Implementation of IOutputAreaModel.get
- Defined in packages/outputarea/src/model.ts:224

set

set(index, value): void
Set the value at the specified index.
Parameters
- index: number
- value: IOutput
Returns void
Implementation of IOutputAreaModel.set
- Defined in packages/outputarea/src/model.ts:231

`Protected` shouldCombine

shouldCombine(options): boolean
Whether a new value should be consolidated with the previous output.

This will only be called if the minimal criteria of both being stream messages of the same type.
Parameters
- options: {
  lastModel: IOutputModel;
  value: IOutput;
  }
  - lastModel: IOutputModel
  - value: IOutput
Returns boolean
- Defined in packages/outputarea/src/model.ts:358

toJSON

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

Returns IOutput[]
Implementation of IOutputAreaModel.toJSON
- Defined in packages/outputarea/src/model.ts:291