[@wago/wdx-schema](../README.md) / [Exports](../modules.md) / [WDX](../modules/WDX.md) / [Schema](../modules/WDX.Schema.md) / [Model](../modules/WDX.Schema.Model.md) / [Chart](../modules/WDX.Schema.Model.Chart.md) / StreamingPlugin

# Class: StreamingPlugin

[Model](../modules/WDX.Schema.Model.md).[Chart](../modules/WDX.Schema.Model.Chart.md).StreamingPlugin

## Table of contents

### Constructors

- [constructor](WDX.Schema.Model.Chart.StreamingPlugin.md#constructor)

### Properties

- [delay](WDX.Schema.Model.Chart.StreamingPlugin.md#delay)
- [duration](WDX.Schema.Model.Chart.StreamingPlugin.md#duration)
- [enabled](WDX.Schema.Model.Chart.StreamingPlugin.md#enabled)
- [frameRate](WDX.Schema.Model.Chart.StreamingPlugin.md#framerate)
- [id](WDX.Schema.Model.Chart.StreamingPlugin.md#id)
- [pause](WDX.Schema.Model.Chart.StreamingPlugin.md#pause)
- [refresh](WDX.Schema.Model.Chart.StreamingPlugin.md#refresh)
- [ttl](WDX.Schema.Model.Chart.StreamingPlugin.md#ttl)
- [uuid](WDX.Schema.Model.Chart.StreamingPlugin.md#uuid)

## Constructors

### constructor

• **new StreamingPlugin**(): [`StreamingPlugin`](WDX.Schema.Model.Chart.StreamingPlugin.md)

#### Returns

[`StreamingPlugin`](WDX.Schema.Model.Chart.StreamingPlugin.md)

## Properties

### delay

• **delay**: `number`

Delay added to the chart in milliseconds so that upcoming values are known
before lines are plotted. This makes the chart look like a continual stream
rather than very jumpy on the right hand side. Specify the maximum expected
delay.

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:62

___

### duration

• **duration**: `number`

Duration of the chart in milliseconds (how much time of data it will show).

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:39

___

### enabled

• **enabled**: `boolean`

If set to true, streaming options are applied to the chart, otherwise plugin will be switched off.

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:29

___

### frameRate

• **frameRate**: `number`

Frequency at which the chart is drawn on a display (frames per second).
Decrease this value to save CPU power.

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:82

___

### id

• `Optional` **id**: `number`

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:13

___

### pause

• **pause**: `boolean`

If set to true, scrolling stops. Note that onRefresh callback is called
even when this is set to true.

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:92

___

### refresh

• **refresh**: `number`

Refresh interval of data in milliseconds. onRefresh callback function will
be called at this interval.

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:72

___

### ttl

• **ttl**: `number`

Duration of the data to be kept in milliseconds. If not set, old data will
be automatically deleted as it disappears off the chart.

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:49

___

### uuid

• **uuid**: `string`

#### Defined in

src/WDX/Schema/Model/Chart/StreamingPlugin.ts:19