Class OutputAreaModel

The default implementation of the IOutputAreaModel.

Hierarchy

OutputAreaModel
- LoggerOutputAreaModel

Implements

IOutputAreaModel

Index

Constructors

constructor

new OutputAreaModel(options?): OutputAreaModel
Construct a new observable outputs instance.
Parameters
- Optional options: IOutputAreaModel.IOptions
Returns OutputAreaModel
- Defined in packages/outputarea/lib/model.d.ts:112

Properties

`Private` _add

_add: any

Add a copy of the item to the list.

Returns

The list length

`Private` _changed

_changed: any

`Private` _createItem

_createItem: any

Create an output item and hook up its signals.

`Private` _isDisposed

_isDisposed: any

`Private` _lastName

_lastName: any

`Private` _lastStream

_lastStream: any

`Private` _onGenericChange

_onGenericChange: any

Handle a change to an item.

`Private` _onListChanged

_onListChanged: any

Handle a change to the list.

`Private` _stateChanged

_stateChanged: any

`Private` _trusted

_trusted: any

`Protected` clearNext

clearNext: boolean

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/lib/model.d.ts:120

isDisposed

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

Returns boolean
Implementation of IOutputAreaModel.isDisposed
- Defined in packages/outputarea/lib/model.d.ts:143

length

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

Returns number
Implementation of IOutputAreaModel.length
- Defined in packages/outputarea/lib/model.d.ts:124

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/lib/model.d.ts:116

trusted

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

Returns boolean
Implementation of IOutputAreaModel.trusted
- Defined in packages/outputarea/lib/model.d.ts:128
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/lib/model.d.ts:135

Methods

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/lib/model.d.ts:165

clear

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

dispose

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

Returns void
Implementation of IOutputAreaModel.dispose
- Defined in packages/outputarea/lib/model.d.ts:147

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/lib/model.d.ts:178

get

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

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/lib/model.d.ts:155

`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/lib/model.d.ts:195

toJSON

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

Returns IOutput[]
Implementation of IOutputAreaModel.toJSON
- Defined in packages/outputarea/lib/model.d.ts:182

Class OutputAreaModel

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: IOutputAreaModel.IOptions

Returns OutputAreaModel

Properties

Private _add

Returns

Private _changed

Private _createItem

Private _isDisposed

Private _lastName

Private _lastStream

Private _onGenericChange

Private _onListChanged

Private _stateChanged

Private _trusted

Protected clearNext

Readonly contentFactory

Protected list

Accessors

changed

Returns ISignal<IOutputAreaModel, IOutputAreaModel.ChangedArgs>

isDisposed

Returns boolean

length

Returns number

stateChanged

Returns ISignal<IOutputAreaModel, number>

trusted

Returns boolean

Notes

Parameters

value: boolean

Returns void

Methods

add

Parameters

output: IOutput

Returns number

Notes

clear

Parameters

Optional wait: boolean

Returns void

dispose

Returns void

fromJSON

Notes

Parameters

values: IOutput[]

Returns void

get

Parameters

index: number

Returns IOutputModel

set

Parameters

index: number

value: IOutput

Returns void

Protected shouldCombine

Parameters

options: { lastModel: IOutputModel; value: IOutput; }

lastModel: IOutputModel

value: IOutput

Returns boolean

toJSON

Returns IOutput[]

Settings

Member Visibility

Theme

`Optional` options: IOutputAreaModel.IOptions

`Private` _add

`Private` _changed

`Private` _createItem

`Private` _isDisposed

`Private` _lastName

`Private` _lastStream

`Private` _onGenericChange

`Private` _onListChanged

`Private` _stateChanged

`Private` _trusted

`Protected` clearNext

`Readonly` contentFactory

`Protected` list

`Optional` wait: boolean

`Protected` shouldCombine

options: {
lastModel: IOutputModel;
value: IOutput;
}