Condensed Graph
Note
See Condensed Data for explanation how
condensed data handling works.
Note
Array references can not be used in Condensed Graph templates.
Contains the definition how to present condensed_data
in graph form.
Model
attribute |
description |
x_axis* X-axis |
The X-axis configuration |
y_axis* Y-axis |
The Y-axis configuration |
graph_type* 'boxplot'|'histogram'|'line'|'scatter' |
Indicates how the graph is to be drawn. The allowed values depend on the value of the attribute is_discrete of X-axis:false : boxplot , histogram , line , scatter true : N/A (for future use)
|
data_point* Data Point |
Template used to render the individual data points |
thresholds Thresholds |
Thresholds for the Data Point values |
X-axis
attribute |
description |
label* cdid@datasets |
The X-axis description translation key |
is_discrete* bool |
Indicates if the X-axis values are a continuum or a discrete set |
filters [filter] |
Filters to be applied to the x-axis label |
unit string@datasets |
The translation key for unit of the X-axis values |
Y-axis
attribute |
description |
label* cdid@datasets |
The Y-axis description translation key |
min* numeric |
The minimal value of the Y-axis practical for most data points |
max* numeric |
The maximal value of the Y-axis practical for most data points |
unit string@datasets |
The translation key for unit of the Y-axis values |
Data Point
attribute |
description |
x_value* cdid |
Pointer to the X-axis value |
description cdid@datasets |
Pointer to the description string translation key |
description_params [Description Param] |
The parameters to be interpolated into the translated description string |
severity cdid |
Severity of the data point |
terminus cdid |
Pointer to value indicating that the point is an end point of a continuous sequence. Supported values are 'start'|'end' . Only applicable for graphs withgraph_type set to value other then scatter and with non-discrete x-axis. |
y_value cdid |
Pointer to the actual Y-value. |
y_stdev cdid |
Pointer to the standard deviation within the set from which y_value is calculated. Mandatory when graph_type is set to boxplot . |
y_min cdid |
Pointer to the minimal value in set from which y_value is calculated. Mandatory when graph_type is set to boxplot . |
y_max cdid |
Pointer to the maximal value in set from which y_value is calculated. Mandatory when graph_type is set to boxplot . |
Description Param
attribute |
description |
key* string |
The param ID |
value* string |
The value to be used in the translation |
Thresholds
attribute |
description |
y_high [Threshold Value] |
An array of points defining the Y-axis high threshold |
y_low [Threshold Value] |
An array of points defining the Y-axis low threshold |
Threshold Value
Threshold value changes happen instantly, the threshold y_value
remains
constant until the next threshold value. When plotted into graph the lines
describing the threshold are therefore always either horizontal or vertical.
attribute |
description |
x_value* cdid |
Pointer to the new X-axis value of the threshold |
y_value* cdid |
Pointer to the new Y-axis value of the threshold |
Example
{
"x_axis": {
"is_discrete": true,
"filters": ["translate"]
},
"y_axis": {
"min": 10000,
"max": 17000,
"unit": "currency.usd"
},
"graph_type": "column",
"data_point": {
"x_value": ".0",
"y_value": ".1.1.0",
"description": ".1.0"
}
}