The Chart configuration is a UConfiguration that mainly defines the layout of the chart.
Besides some settings common to all chart types (see table 1 to 3) each chart type will add its own settings to this UConfiguration. For these chart type specific settings refer to the documentation of the chart type.
Setting |
Description |
Title |
A text setting defining a text template used as header above the chart. See below for a list of supported markup variables. Default: <empty> |
Sub title |
A text setting defining a text template used for a sub title and displayed directly beneath the title. See below for a list of supported markup variables. Default: <empty> |
Header line |
A text setting defining a text template used as header line directly above the chart. See below for a list of supported markup variables. Default: <empty> |
Footer line |
A text setting defining a text template used as footer line directly beneath the chart. See below for a list of supported markup variables. Default: <empty> |
Show erroneous |
Boolean setting that defines if set the chart will show erroneous observations. If not set erroneous observations will not be included. Default: false |
Highlight erroneous |
Boolean setting that defines if erroneous observations will be highlighted in the chart. Only effective of course if Show erroneous is set. Default: false |
Highlight zero readings |
Boolean setting that defines if observations that are marked as zero reading are highlighted in the chart. Default: false |
Show observation filter |
Boolean setting that defines if a textual representation of the chart definition's observation filter is displayed on the chart. |
Table 1: Common Chart settings available in all chart types
Setting |
Description |
Show legend |
Boolean setting that defines if a legend will be shown or not. Default: false |
Legend location |
Enumeration setting that defines that defines where the legend will be shown in the chart. Options are left, right, top or bottom. Note that the the rendering logic might limit the number of legend entries. Default: Top |
Show units |
Boolean setting that defines if units of the time series will be shown in the legend entries. Default: false |
Table 2: Legend settings available with all chart types
Setting |
Description |
Date format |
Text setting defining the date & time format string that is used to display date & time values on the chart (if any). If this format string is empty it will default to the format string d . Default: d |
Date time conversion |
Defines how date time offset values are converted to date time values used in the chart. •Strip off: The offset part of date time offset values will just be stripped, no conversion will be applied. Use this option if all your charted data was recorded with reference to the same time zone. •Time zone conversion: Date time offset values will first be converted to the given time zone (see below) and after that the offset will be stripped off. Use this option if your date time offset values were recorded with reference to different time zones. •Offset conversion: Date time offset values will firt be converted to the given offset (see below) and after that the offset will be stripped off. Use this option if you want to present data without shifts introduced by daylight saving time etc. |
Time zone |
Defines the timezone to which all charted date time offset values will be converted before the offset is stripped off. The selection list includes all time zones that are made available by the operating system of the Application Server. Default: Timezone of the Application Server |
Offset [min] |
Numeric setting defining a time offset in minutes to be used for the Offset conversion (see Date time conversion setting). This option is only available if the Date time conversion is set to Offset conversion. Default: Time offset of the Application Server when the chart definition was created. |
Naming of series |
Enumeration that defines defines how series of data are named. Names of series are used in different places, e.g. in the chart legend. |
Text template for series name |
Text setting that defines a Text template used for naming series of data. This setting is only available if the Naming of series setting is set to Text template. Additional to the common markup variables this text template allows following variables and classes •FeatureType •FeatureName •FeatureSubtype.Name •FeatureSubtype.Description |
Table 3: Miscellaneous settings available with all chart types
The settings for title, subtitle, header line and footer line are text templates that can use additional markup variables as shown in table 4. E.g. you can use {{pins[0].sources[0].features[0].Name}} to reference the name of the first feature on the first pin.
Property |
Description |
Pins |
Collection of pin markup objects of class pin representing the pins defined for the chart. (See table |
Filter |
A class representing the currently used observation filter. |
Table 4: Additional text template markup variables available for title, subtitle, header line and footer line in chart templates.
Property |
Description |
Name |
Name of the pin |
Sources |
Collection of source bound to the pin, represented as pin object (see table 6) |
Table 5: The pin class used in text templates
Property |
Description |
Name |
Name of an object bound to a pin |
Description |
Description of an object bound to a pin |
Features |
Collection of pin objects representing the features the source expands to. |
Table 6: The pin object class used in text templates
Property |
Description |
From |
Date time value |
To |
Date time value |
Table 7: The filter object class used in text templates
