1,651
edits
Charts Definition Language (CDL): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Explanation of the definition Keywords
| (5 intermediate revisions by the same user not shown) | |||
| Line 72: | Line 72: | ||
#ZOOM (Optional construct): Indicates which range selector button is the default when the chart is displayed; Defaults depend on chart range. | #ZOOM (Optional construct): Indicates which range selector button is the default when the chart is displayed; Defaults depend on chart range. | ||
#PLOT: Starts the plot specification using one of the possible variables. Each chart requires at least one PLOT. | #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. IF a STATS of an equation plot is to be requested, the PLOT statement of the equation must precede the STATS statement. | ||
#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). | ||
#ALL: Defines the variable to be taken from the [[Dayfile.txt|Dayfile]] and all data for that variable will be plotted (Note that the CMX parameter ''ChartMaxDays'' will not be used) | #ALL: Defines the variable to be taken from the [[Dayfile.txt|Dayfile]] and all data for that variable will be plotted (Note that the CMX parameter ''ChartMaxDays'' will not be used) | ||
| Line 88: | Line 88: | ||
#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. | #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. | ||
#INFO (Optional construct): Introduces a helptext section for the chart. The free text is enclosed in double quotes and cannot contain double quotes. The double quotes are delimited by a space character. | #INFO (Optional construct): Introduces a helptext section for the chart. The free text is enclosed in double quotes and cannot contain double quotes. The double quotes are delimited by a space character. | ||
#PERIOD: Only in the context of the STATS function SMA. Gives the period of that specific running average | |||
| Line 148: | Line 149: | ||
===== Axis Types ===== | ===== Axis Types ===== | ||
The following Axis are possible. | The following Axis are possible. | ||
Temp, Wind, Distance, Hours, Solar, UV, Rain, Rrate, Pressure, Humidity, DegreeDays, EVT, AQ, ppm, Free | Temp, Wind, Distance, Height, Hours, Solar, UV, Rain, Rrate, Pressure, Humidity, DegreeDays, EVT, AQ, ppm, Free | ||
This only has meaning if there is an [[CDL - EVAL|EVAL]] with a valid expression present. As an [[CDL - EVAL|EVAL]] may modify the value of the plot variable to something completely different, the original Axis belonging to that plot variable may be useless or scale wrongly. Therefore you can choose your own Axis. If there is no valid equation, a warning is given and no axis is generated. | This only has meaning if there is an [[CDL - EVAL|EVAL]] with a valid expression present. As an [[CDL - EVAL|EVAL]] may modify the value of the plot variable to something completely different, the original Axis belonging to that plot variable may be useless or scale wrongly. Therefore you can choose your own Axis. If there is no valid equation, a warning is given and no axis is generated. | ||
| Line 163: | Line 164: | ||
== The Chart Axis == | == The Chart Axis == | ||
All PlotVariables have their own defined axis and those axis will be coupled automatically to the chart. Multiple axis will be alternately added left-right where the order in the definition files determines this order. So it is the user who ultimately can define where the axis are placed: left or right and from inside to the outside in the order where they are encountered during the parsing process. | All PlotVariables have their own defined axis and those axis will be coupled automatically to the chart. Multiple axis will be alternately added left-right where the order in the definition files determines this order. So it is the user who ultimately can define where the axis are placed: left or right and from inside to the outside in the order where they are encountered during the parsing process. | ||
The scaling of the axis is flexible i.e. it starts with a reasonable value for the upper and lower bounds and adjusts if the real values are higher or lower. For some axis the lower bound is always 0 (e.g. rain) for another the upper and lower bounds are fixed. Specifics are found below. | |||
The following axis are currently defined and implicit for the plot variables (the user has no options here): | The following axis are currently defined and implicit for the plot variables (the user has no options here): | ||
#None | #'''None''' | ||
#Temp | #'''Temp''' - automatic scaling for min/max | ||
#Pressure | #'''Pressure''' - scaling with a pseudo-fixed scale which means the min/max values of the scale are set to the min/max all time records found in ''alltime.ini''. Highcharts itself sets the scale values such that there is a tick at the end of the scale and the min/max values fall between the ticks at the end of the scale. If the pressure gets a lower/higher value the axis will adjust automatically. The idea is that any barometer you have at home has a fixed scale and with small variations there is little movement of the needle. However when the pressure starts falling/rising significantly it is very obvious. This behaviour is mimicked by CUtils (as far as possible) | ||
#Rain | #'''Rain''' - automatic scaling with minimum value of 0 and an initial maximum of 1 (to accommodate measurement in inches) | ||
#Rrate | #'''Rrate''' - automatic scaling with minimum value of 0 and an initial maximum of 1 (to accommodate measurement in inches) | ||
#Wind | #'''Wind''' - automatic scaling for min/max | ||
#Direction | #'''Direction''' - scaling is fixed for 0 to 360 degree. When only direction is plotted two axis are created: in degrees and in wind directions (N, E, S, W). When combined with another unit only the axis with wind directions is used. | ||
#Humidity | #'''Humidity''' - scaling is fixed between 0 and 100 | ||
#Solar | #'''Solar''' - scaling is fixed between 0 and a rough estimate of the maximum theoretical value for radiation + 50 to give the scale some space. If the actual value goes beyond that, the scale will adjust. | ||
#UV | #'''UV''' - automatic scaling for maximum, minimum is 0 | ||
#Hours | #'''Hours''' - automatic scaling for maximum, minimum is 0 | ||
#Distance | #'''Distance''' - automatic scaling for maximum, minimum is 0 | ||
#DegreeDays | #'''Height''' - automatic scaling for maximum, minimum is 0, basically used for the Cloudbase | ||
#EVT | #'''DegreeDays''' - automatic scaling for maximum, minimum is 0 | ||
#Free | #'''EVT''' - automatic scaling for maximum, minimum is 0 | ||
#AQ | #'''Free''' - has no title, unit or context associated with it. It just displays values. Automatic scaling for min/max. | ||
#ppm | #'''AQ''' - automatic scaling for maximum, minimum is 0 | ||
#'''ppm''' - automatic scaling for maximum which starts at 500, minimum is 0. The default maximum is because the CO<sub>2</sub> value is around 420 (in 2022) outdoors. | |||
Translations for the axis titles come from the [Website] section (until '''''EVT''''') and should require no additional effort. | Translations for the axis titles come from the [Website] section (until '''''EVT''''') and should require no additional effort. | ||
