"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 |
Details
The Function returns the data for a specific ruler position for the given curve. The returned data is a mapping that contains the following information/keys:
- time - Exact time (might differ from the stated time)
- status - The status of the curve as bit64
- value - the corresponding average value as float
- minValue - the corresponding minimum value as float (returned when downsampling is active)
- maxValue - the corresponding maximum value as float (returned when downsampling is active)
- formattedValue - The formatted average value as displayed inside the legend
- minFormattedValue - The formatted minimum value as displayed inside the legend (returned when downsampling is active)
- maxFormattedValue - The formatted maximum value as displayed inside the legend (returned when downsampling is active)
- 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, 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 key's value and formatted value.
Assignment
Trend