Class pvc.options.SlidingWindow
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
The options documentation class of a sliding window for real time use.
|
| Field Attributes | Field Name and Description |
|---|---|
| Chart > Data | |
|
The name of the dimension associated with the sliding window.
|
|
|
The domain length to show on the sliding window axis.
|
|
| Method Attributes | Method Name and Description |
|---|---|
| Chart > Data | |
|
select(allData)
A function that, given a dataset, selects the data to be removed.
|
|
Class Detail
pvc.options.SlidingWindow
The options documentation class of a sliding window for real time use.
A sliding window defines the range of data to be kept, this is, all data outside the window is removed and therefore lost.
The intended use is the real time case where data is being delivered at some rate and the window is "sliding", allowing the visualization of the most recent set of data in a given domain span.
When slidingWindow is set to true, the following properties have the indicated default values:
- preserveMap: true, see axes.DiscreteColorAxis#preserveMap;
- preserveRatio: true, see axes.AnyContinuousCartesianAxis#preserveRatio;
- fixedLength - if the sliding window length (#length) is defined, fixed length is set to this value; see axes.AnyContinuousCartesianAxis#fixedLength and axes.SizeAxis#fixedLength;
- comparer: def.ascending, see DimensionType#comparer.
Field Detail
{string}
dimension
The name of the dimension associated with the sliding window.
Default
When unspecified, the sliding window will be associated with the dimension of the base axis.
{number|string|pvc.options.varia.TimeInterval}
length
The domain length to show on the sliding window axis.
When unspecified, the sliding window is considered disabled.
Method Detail
{pvc.data.Datum[]}
select(allData)
A function that, given a dataset, selects the data to be removed.
Default
The default function uses the length specified in #length, to remove every datum which is not in the domain window.If the dimension specified in #dimension is not numerical or Date, no datum is removed.
- Arguments:
- {pvc.data.Datum[]} allData
- An array of datums to evaluate.
- Returns:
- {pvc.data.Datum[]} An array with the datums to remove.