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.

  • orientation (optional, default: VERTICAL) allows defining the orientation of the chart. The allowed values are VERTICAL and HORIZONTAL.

  • 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 colour for a chart or a table. Working With Colours

  • backgroundColorFromIndicator (optional) allows making the background colour 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 colour.Working With Colours

  • 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, as described in For measure and indicator elements.

  • 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).

For measure and indicator elements

Most charts use the measure and indicator elements to define the metrics used in the chart. The attributes allowed for these element are:

  • label (optional, default: the measure’s name) defines or overrides the label used for the measure. Note that the chart thumbnail will always show the mnemonic no matter what the value of label is.

  • color (optional, default: the project’s color, or a random color based on the artefact’s name) defines the colour used to represent the measure in the chart.Working With Colours

  • visible (optional, default: true) allows including a measure on a chart as hidden. It will not be displayed by default, but can be added to the chart by clicking its name in the legend.

  • dataBounds (optional, default: "];[") defines the range of values allowed to be displayed on the chart. You can use this attribute to exclude drawing an erroneous or non-representative value on a chart. This attribute is currently supported for the following charts: All Temporal Evolution charts, Quadrant, X/Y-Cloud, Histogram, Y-Cloud, Dial, Simple Pie and Optimised Pie.

    [ and ] allow you to specify that a boundary value is included.

    ] and [ specify that the boundary value itself is excluded.

  • shape (optional, default: CIRCLE) defines the shape used to represent a point on a chart. The allowed values are:

    • NONE

    • SQUARE

    • CIRCLE

    • DIAMOND

    • UP_TRIANGLE

    • DOWN_TRIANGLE

    • RIGHT_TRIANGLE

    • LEFT_TRIANGLE

    • HORIZONTAL_RECTANGLE

    • VERTICAL_RECTANGLE

    • HORIZONTAL_ELLIPSE

    • VERTICAL_ELLIPSE

  • stroke (optional, default: SOLID) defines the type of line used join points. The allowed values are NONE, SOLID and DOTTED.

  • aggregationType (optional, default: AVG) defines how the values are aggregated. Supported values are:

    • MIN: minimal value

    • MAX: maximal value

    • OCC: number of data points

    • AVG: average value

    • DEV: standard deviation

    • SUM: sum of values

    • MED: median value

    • MOD: modal value

Attributes that are specific to certain charts only are documented in each chart’s section.