Common Attributes

For chart element

Although attributes may be different depending on the type of chart, some are common to all charts:

  • type (mandatory) defines the type of chart.

  • id (mandatory) is a unique identifier for the chart that can be used to add a localized description in properties files.

  • name (optional) is the display name of the chart on the dashboard. Note that the value of this attribute is used as a fallback in case no translation is found for the chart’s ID. You should use C.CHART_ID.NAME=My Chart Name in a properties file to define a chart’s name for CHART_ID instead of using this attribute.

  • width (optional) sets the desired width of the chart.

  • height (optional) sets the desired height of the chart.

  • backgroundColor (optional, default: WHITE for charts, GREY for tables) allows specifying a background color for a chart or a table. Working With Colors.

  • backgroundColorFromIndicator (optional) allows making the background color for a chart or a table dependent on an indicator level. The attribute takes an indicator Id (backgroundColorFromIndicator="ROOT"). The color will be the one defined in the indicator’s associated scale.

  • plotBackgroundColor (optional, default: same value as *backgroundColor*) sets the background of the plotting area of the chart to the specified color (Working With Colors).

  • xMin, xMax (optional, defaults to automatic values) allow defining the desired boundaries for the x-axis. This attribute can be specified as a value or as a computation.

  • yMin, yMax (optional, defaults to automatic values) allow defining the desired boundaries for the y-axis. This attribute can be specified as a value or as a computation.

  • displayOnlyIf (optional) allows specifying a computation to evaluate whether to show the element. If the result of the computation is more than 0, then the element is displayed. Consult Expressions Syntax for more information about the supported computation syntax.

  • exclude (optional) allows specifying a list of project roles that will not see the chart.

  • xLabel (optional) overrides the default name given to the x-axis for charts that use axes.

  • yLabel (optional) overrides the default name given to the x-axis for charts that use axes.

  • aggregate (optional, only valid in Model/Group Dashboards, default: false) specifies that the metrics shown on the chart are aggregated. The aggregation type is defined for each measure with the aggregationType attribute.

  • legend (optional, default: false for quadrants, true for other types of charts) allows specifying if the chart’s legend is shown (true) or hidden (false).