Class LoggerOutputAreaModel

Output Area Model implementation which is able to limit number of outputs stored.

Hierarchy

OutputAreaModel
- LoggerOutputAreaModel

Implements

ILoggerOutputAreaModel

Index

Constructors

constructor

new LoggerOutputAreaModel(__namedParameters): LoggerOutputAreaModel
Parameters
- __namedParameters: LoggerOutputAreaModel.IOptions
Returns LoggerOutputAreaModel
Overrides OutputAreaModel.constructor
- Defined in packages/logconsole/lib/logger.d.ts:66

Properties

`Private` _applyMaxLength

_applyMaxLength: any

Manually apply length limit.

`Private` _maxLength

_maxLength: 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 ILoggerOutputAreaModel.changed

Inherited from OutputAreaModel.changed
- Defined in packages/outputarea/lib/model.d.ts:120

isDisposed

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

Returns boolean
Implementation of ILoggerOutputAreaModel.isDisposed

Inherited from OutputAreaModel.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 ILoggerOutputAreaModel.length

Inherited from OutputAreaModel.length
- Defined in packages/outputarea/lib/model.d.ts:124

maxLength

get maxLength(): number
Maximum number of outputs to store in the model.

Returns number
Implementation of ILoggerOutputAreaModel.maxLength
- Defined in packages/logconsole/lib/logger.d.ts:95
set maxLength(value): void
The maximum number of outputs to store.
Parameters
- value: number
Returns void
Implementation of ILoggerOutputAreaModel.maxLength
- Defined in packages/logconsole/lib/logger.d.ts:96

stateChanged

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

Returns ISignal<IOutputAreaModel, number>
Implementation of ILoggerOutputAreaModel.stateChanged

Inherited from OutputAreaModel.stateChanged
- Defined in packages/outputarea/lib/model.d.ts:116

trusted

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

Returns boolean
Implementation of ILoggerOutputAreaModel.trusted

Inherited from OutputAreaModel.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 ILoggerOutputAreaModel.trusted

Inherited from OutputAreaModel.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: ILogOutput
Returns number
The total number of outputs.

Notes
The output bundle is copied. Contiguous stream outputs of the same name are combined. The oldest outputs are possibly removed to ensure the total number of outputs is at most .maxLength.
Implementation of ILoggerOutputAreaModel.add

Overrides OutputAreaModel.add
- Defined in packages/logconsole/lib/logger.d.ts:77

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 ILoggerOutputAreaModel.clear

Inherited from OutputAreaModel.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 ILoggerOutputAreaModel.dispose

Inherited from OutputAreaModel.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 ILoggerOutputAreaModel.fromJSON

Inherited from OutputAreaModel.fromJSON
- Defined in packages/outputarea/lib/model.d.ts:178

get

get(index): ILogOutputModel
Get an item at the specified index.
Parameters
- index: number
Returns ILogOutputModel
Implementation of ILoggerOutputAreaModel.get

Overrides OutputAreaModel.get
- Defined in packages/logconsole/lib/logger.d.ts:91

set

set(index, value): void
Set the value at the specified index.
Parameters
- index: number
- value: IOutput
Returns void
Implementation of ILoggerOutputAreaModel.set

Inherited from OutputAreaModel.set
- Defined in packages/outputarea/lib/model.d.ts:155

`Protected` shouldCombine

shouldCombine(options): boolean
Whether an output should combine with the previous output.

We combine if the two outputs are in the same second, which is the resolution for our time display.
Parameters
- options: {
  lastModel: ILogOutputModel;
  value: ILogOutput;
  }
  - lastModel: ILogOutputModel
  - value: ILogOutput
Returns boolean
Overrides OutputAreaModel.shouldCombine
- Defined in packages/logconsole/lib/logger.d.ts:84

toJSON

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

Returns IOutput[]
Implementation of ILoggerOutputAreaModel.toJSON

Inherited from OutputAreaModel.toJSON
- Defined in packages/outputarea/lib/model.d.ts:182

Class LoggerOutputAreaModel

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: LoggerOutputAreaModel.IOptions

Returns LoggerOutputAreaModel

Properties

Private _applyMaxLength

Private _maxLength

Protected clearNext

Readonly contentFactory

Protected list

Accessors

changed

Returns ISignal<IOutputAreaModel, IOutputAreaModel.ChangedArgs>

isDisposed

Returns boolean

length

Returns number

maxLength

Returns number

Parameters

value: number

Returns void

stateChanged

Returns ISignal<IOutputAreaModel, number>

trusted

Returns boolean

Notes

Parameters

value: boolean

Returns void

Methods

add

Parameters

output: ILogOutput

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 ILogOutputModel

set

Parameters

index: number

value: IOutput

Returns void

Protected shouldCombine

Parameters

options: { lastModel: ILogOutputModel; value: ILogOutput; }

lastModel: ILogOutputModel

value: ILogOutput

Returns boolean

toJSON

Returns IOutput[]

Settings

Member Visibility

Theme

On This Page

`Private` _applyMaxLength

`Private` _maxLength

`Protected` clearNext

`Readonly` contentFactory

`Protected` list

`Optional` wait: boolean

`Protected` shouldCombine

options: {
lastModel: ILogOutputModel;
value: ILogOutput;
}