1,635
edits
Charts Definition Language (CDL): Difference between revisions
Charts Definition Language (CDL) (view source)
Revision as of 15:48, 24 June 2022
, 15:48, 24 June 2022→Explanation of the definition Keywords
| Line 56: | Line 56: | ||
==== Explanation of the definition Keywords ==== | ==== Explanation of the definition Keywords ==== | ||
#EQUATIONS: Starts an equations block. Such block only defines (partial) equations, it does not cause code generation in itself | #EQUATIONS (Optional construct): Starts an equations block. Such block only defines (partial) equations, it does not cause code generation in itself | ||
#CHART: Starts a chart definition | #CHART: Starts a chart definition | ||
#TITLE: Starts the title. All words until the next keyword comprise the title of the chart | #TITLE: Starts the title. All words until the next keyword comprise the title of the chart | ||
#CONNECTSTO: The integer numbers which follow CONNECTSTO represent a pane in the realtime [[Dashboard|dashboard]]. When clicked on that pane this chart appears. This is only valid on charts in the default output. For other outputs there is no semantics for CONNECTSTO and a warning is issued in the logfile if it is specified in any second or higher output. | #CONNECTSTO (Optional construct): The integer numbers which follow CONNECTSTO represent a pane in the realtime [[Dashboard|dashboard]]. When clicked on that pane this chart appears. This is only valid on charts in the default output. For other outputs there is no semantics for CONNECTSTO and a warning is issued in the logfile if it is specified in any second or higher output. | ||
#HAS WINDBARBS [ ABOVE | BELOW ]: Defines if the chart displays the WINDBARBS showing direction and speed as indicators (this is not an exact plot of wind) | #HAS WINDBARBS [ ABOVE | BELOW ] (Optional construct): Defines if the chart displays the WINDBARBS showing direction and speed as indicators (this is not an exact plot of wind) | ||
#PLOT: Starts the plot specification using one of the possible variables | #PLOT: Starts the plot specification using one of the possible variables. Each chart requires at least one PLOT. | ||
#[[CDL - STATS|STATS]]: Starts the statistics block using one of the possible variables. Semantics demands the variable to be plotted normally as well. | #[[CDL - STATS|STATS]]: Starts the statistics block using one of the possible variables. Semantics demands the variable to be plotted normally as well. | ||
#RECENT: Defines the variable to be governed by the CMX parameter ''GraphHours'' and are similar to the CMX RECENT graphs (though not equal). | #RECENT: Defines the variable to be governed by the CMX parameter ''GraphHours'' and are similar to the CMX RECENT graphs (though not equal). | ||
| Line 67: | Line 67: | ||
#DAILY: Identical to the ALL keyword but it sets the datarange for the chart to one month while the ALL keyword sets it to one year. | #DAILY: Identical to the ALL keyword but it sets the datarange for the chart to one month while the ALL keyword sets it to one year. | ||
#EXTRA: Defines the variable to be an extra sensor variable. It has an implicit datarange of RECENT. | #EXTRA: Defines the variable to be an extra sensor variable. It has an implicit datarange of RECENT. | ||
#AS: Defines the type of charting for that variable. | #AS (Optional construct): Defines the type of charting for that variable. All attributes of AS are optional. | ||
#[[CDL - EVAL|EVAL]] [ ]: Defines an expression for the plot variable. The equation must be placed between the square brackets, space has no value here (does not act as separator). | #[[CDL - EVAL|EVAL]] [ ]: Defines an expression for the plot variable. The equation must be placed between the square brackets, space has no value here (does not act as separator). | ||
#COLOUR: Defines the colour of that variable. | #COLOUR: Defines the colour of that variable. | ||
| Line 75: | Line 75: | ||
#AXIS: Gives the user the possibility to specify an axis when using the EVAL construct otherwise an error is generated. | #AXIS: Gives the user the possibility to specify an axis when using the EVAL construct otherwise an error is generated. | ||
#ENDCHART: End the chart definition | #ENDCHART: End the chart definition | ||
#OUTPUT: Gives an optional name of an outputfile which starts at the chart where it is defined. Any chart after this OUTPUT specifier goes to this OUTPUT until another OUTPUT is found. Only the first OUTPUT specifier ( | #OUTPUT (Optional construct): Gives an optional name of an outputfile which starts at the chart where it is defined. Any chart after this OUTPUT specifier goes to this OUTPUT until another OUTPUT is found. Only the first OUTPUT specifier (implicitly: cumuluscharts.txt) accepts click events as defined by CONNECTSTO. | ||
The keywords for the actual parameters and the Graph Types speak for themselves. | The keywords for the actual parameters and the Graph Types speak for themselves. | ||