"curveDataAtRuler","curveDataAtRulerX"
Returns the data which is available for a curve at a specific ruler position.
Synopsis
trendObj.curveDataAtRuler(string curve, int ruler, mapping
&data);
getValue(trendObj, "curveDataAtRuler", string curve, int ruler, mapping
&data);
Parameter
| Parameter | Description |
|---|---|
| trendObj | Trend for which the attributed should be get |
| curve | Name of the curve |
| ruler | ID of the ruler that should be used |
| data | Data that is returned |
Description
The Function returns the data for a specific ruler position for the given curve. The returned data is a mapping that contains following information/keys:
- time - Exact time (might differ from the stated time)
- status - The status of the curve as bit64
- value - the corresponding value as float
- formattedValue - The formatted value as displayed inside of the legend
- msgCatKey - Contains the matched config keys for the "trendStatusPattern" (optional)
- pointIcon - Path to the used icon file (optional)
If the curve is an event curve than the corresponding event data is returned as JSON mapping in addition to the mapping keys above.
The XY trend only returns a mapping with the keys value and formatted value.
Assignment
Trend
