GetScatterDataForElements
Use this method to retrieve the data to create a scatter chart for an array of elements.
| Item |
Format |
Description |
| connection |
String |
The connection ID. See ConnectApp. |
| xAxisInfo.Type |
String |
Determines what is displayed by the X-axis of the scatter chart: ALARM_COUNT, ALARM_STATE or PARAMETER_VALUE |
| yAxisInfo.Type |
String |
Determines what is displayed by the Y-axis of the scatter chart: ALARM_COUNT, ALARM_STATE or PARAMETER_VALUE |
| filter.FilterBy |
String |
Determines what the elements are filtered by: VIEW, PROTOCOL or VIEW_AND_PROTOCOL. |
| filter.ViewID |
Integer |
The view ID for which element data should be retrieved. |
| filter.ProtocolName |
String |
The protocol ID of the protocol for which element data should be retrieved. |
| filter.ProtocolVersion |
String |
The protocol version of the protocol for which element data should be retrieved. |
| filter.Limit |
Integer |
The maximum number of elements for which data should be retrieved. |
| filter.StartTimeUTC |
Long integer |
The start time (in UTC) of the timespan for which data should be retrieved. |
| filter.EndTimeUTC |
Long integer |
The end time (in UTC) of the timespan for which data should be retrieved. |
| filter.IncludeSubViews |
Boolean |
Indicates whether data should also be retrieves for elements in subviews of the specified view. |
Output
| Item |
Format |
Description |
| GetScatterDataForElementsResult |
Array of XValues, YValues and Labels |
The values for the X and Y axis of the scatter chart and the corresponding labels |