Current Artifact Only

Dial

This chart is supported in Model/Group Dashboards and Artifact Dashboards.

The Dial chart represents the value of the measure associated to an indicator against a backdrop of the scale associated to this indicator. The Dial chart requires one indicator as a sub-element.

Figure 1. Dial Chart

<chart type="DIAL" id="DIAL_EXAMPLE">
	<indicator>ROOT</indicator>
</chart>

The Dial chart element may have the following attributes:

decimals (optional) is the number of decimal places used to display the data.
majorTickIncrement (optional) is the increment between two major ticks on the dial.

The majorTickIncrement and minorTickCount parameters only need to be used if you want to completely control the appearance of the chart. Generally, they can be omitted, as the defaults should be smart enough to show what you need.

The indicator element accepts the following attributes:

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.

[ and ] allow you to specify that the boundary value is included, while ] and [ allow you to specify that the boundary value is excluded.
excludeLevels (optional, default: empty) to hide levels and exclude them from chart computations.
aggregationType (optional, only available at Model/Group Dashboard level, 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

Key Performance Indicator

This chart is supported only in Artifact Dashboards.

The Key Performance Indicator chart is used to display the rating of the root indicator for artifact.

Figure 2. Key Performance Indicator

<chart type="KPI" id="KPI_EXAMPLE">
  <indicator>ICCR</indicator>
</chart>

When used in this chart, the indicator element accepts the following attributes:

excludeLevels (optional, default: empty) to hide levels and exclude them from chart computations.

You can configure the image displayed by Key Performance Indicator chart by defining an image per scale level in your model:

<SQUORE_HOME>/configuration/models/shared/Analysis/SQuORE_PerformanceLevels_en.properties:
LOP.LEVELA.IMAGE=../Shared/Images/images/perfA.png
LOP.LEVELB.IMAGE=../Shared/Images/images/perfB.png
LOP.LEVELC.IMAGE=../Shared/Images/images/perfC.png
LOP.LEVELD.IMAGE=../Shared/Images/images/perfD.png
LOP.LEVELE.IMAGE=../Shared/Images/images/perfE.png
LOP.LEVELF.IMAGE=../Shared/Images/images/perfF.png
LOP.LEVELG.IMAGE=../Shared/Images/images/perfG.png

For more information about properties files, consult Properties files.

The Indicator chart now offers a more dynamic way to display a KPI without the need to create images for every level on a scale. You can find out more about this chart in Indicator section.

Kiviat

This chart is supported in Model/Group Dashboards and Artifact Dashboards.

The Kiviat chart displays three or more indicators in a radar-type chart.

Figure 3. Kiviat

The Kiviat chart takes a set of at least three indicators as sub-elements.

<chart type="KIVIAT" id="KIVIAT_EXAMPLE" isInverted="true" currentLabel="Current" objectiveLabel="Objective">
	<indicator label="My testability" objective="LEVELC">TESTABILITY</indicator>
	<indicator objective="LEVELC">STABILITY</indicator>
	<indicator objective="LEVELC">CHANGEABILITY</indicator>
	<indicator objective="LEVELD">ANALYSABILITY</indicator>
</chart>

On top of supported common attributes, this chart also accepts the following additional attributes:

isInverted (optional, default: true) when set to true, places the highest rank (usually the worst mark) at the centre of the Kiviat instead of on the outside.
currentLabel (optional, default: "Current") to set a custom tooltip label for the current value.
objectiveLabel (optional, default: "Objective") to set a custom tooltip label for the objective’s value.

When used in this chart, the indicator element accepts the following attributes:

label (optional, default: the indicator’s name ) defines or overrides the label used for the indicator.
objective (optional, default: none) draws a dotted line at the specified level representing the objective line. Accepted values are:
- A scale level (LEVELA)
- An indicator ID (TESTABILITY). In this case, both indicators must use the same scale.
- A computation (LC+100). The computed value is then used together with the scale of the indicator to define the level to display.
aggregationType (optional, only available at Model/Group Dashboard level, 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

Indicator

This chart is supported only in Artifact Dashboards.

The Indicator chart displays the rating of the current artifact for a specific indicator. It accepts exactly one indicator element.

Figure 4. Indicator chart with tooltips showing information about the scale for the indicator (left) and the actual rating of the artifact (right)

<chart type="INDICATOR" id="INDICATOR_EXAMPLE" topText="More efficient" bottomText="Less efficient">
	<indicator excludeLevels="UNKNOWN">ROOT</indicator>
</chart>

On top of supported common attributes, this chart also accepts the following additional attributes:

topText (optional, default: More efficient) is the text to display at the top of the scale on the chart.
bottomText (optional, default: Less efficient) is the text to display at the bottom of the scale of the chart.

When used in this chart, the indicator element accepts the following attributes:

excludeLevels (optional, default: empty) to hide levels and exclude them from chart computations.

The colors and level names displayed by the Indicator chart are taken from the configuration of the scale levels for your indicator in your model.

Exemple of properties file content

LOP.LEVELA.MNEMO=A
LOP.LEVELA.NAME=Level A
LOP.LEVELA.COLOR=#006893

LOP.LEVELB.MNEMO=B
LOP.LEVELB.NAME=Level B
LOP.LEVELB.COLOR=#00a38a
...

For more information about properties files, consult Properties files.

Optimised Bar

This chart is supported only in Artifact Dashboards.

The Optimised Bar chart is a bar chart that takes several measures as input. It simply displays a bar chart with the values previously computed.

Figure 5. Optimised Bar

<chart type="OPTIMIZEDBAR" id="OPTIMIZED_BAR_EXAMPLE" asPercentage="true">
	<measure color="#006893" label="A">A_FILE</measure>
	<measure color="#67C8B9" label="B">B_FILE</measure>
	<measure color="#79C142" label="C">C_FILE</measure>
	<measure color="#FEC422" label="D">D_FILE</measure>
	<measure color="#F6A01B" label="E">E_FILE</measure>
	<measure color="#F48026" label="F">F_FILE</measure>
	<measure color="#F25B21" label="G">G_FILE</measure>
</chart>

On top of supported common attributes, this chart also accepts the following additional attributes:

decimals (optional, default: 0) is the number of decimals places to be used for displaying values.
displayEmptyData (optional, default: false) forces the display of artifacts for which there is no corresponding data.
asPercentage (optional, default: false) specifies whether the values are displayed as real values or percentages.
displayGlobalPercentage (optional, default: false) allows showing the global percentage value for each bar in the tooltip next to the relative percentage value.
displayEmptyValue (deprecated) specifies whether categories with no value or a value of 0 are included on the chart. Use displayEmptyData instead.

When used in this chart, the measure element accepts the following attributes:

label (optional, default: the measure’s name ) defines or overrides the label used for the measure.
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.

[ and ] allow you to specify that the boundary value is included, while ] and [ allow you to specify that the boundary value is excluded.
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.
color (optional, default: the project’s color, or a random color based on the artifact’s name ) defines the color used to represent the measure in the chart. To know more about colors, see the Working With Colors section.
alpha (optional, default: 255) defines the alpha applied to the color defined with color attribute, 255 for no transparency, 0 for invisible color.

Optimised Pie

This chart is supported only in Artifact Dashboards.

The Optimised Pie chart is a pie chart that takes several measures as input (at least two). It simply displays a pie chart with the values previously computed.

Figure 6. Optimised Pie Chart

<chart type="OPTIMIZEDPIE" id="OPTIMIZED_PIE_EXAMPLE" decimals="2">
	<measure label="Source">SLOC_ONLY</measure>
	<measure label="Comment">CLOC_ONLY</measure>
	<measure label="Mixed">MLOC</measure>
	<measure color="YELLOW" label="Blank">BLAN</measure>
</chart>

On top of supported common attributes, this chart also accepts the following additional attributes:

decimals (optional, default: 0) is the number of decimals places to be used for displaying values.
displayEmptyData (optional, default: false) forces the display of artifacts for which there is no corresponding data.
labels (optional, default: true) displays the labels.
valueOnLabels (optional, default: false) displays the value alongside the labels.

When used in this chart, the measure element accepts the following attributes:

label (optional, default: the measure’s name ) defines or overrides the label used for the measure.
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.

[ and ] allow you to specify that the boundary value is included, while ] and [ allow you to specify that the boundary value is excluded.
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.
color (optional, default: the project’s color, or a random color based on the artifact’s name ) defines the color used to represent the measure in the chart. To know more about colors, see the Working With Colors section.
alpha (optional, default: 255) defines the alpha applied to the color defined with color attribute, 255 for no transparency, 0 for invisible color.

SQALE Pyramid

This chart is supported in Model/Group Dashboards and Artifact Dashboards.

This SQALE Pyramid chart allows to represent a set of measures (at least two) as a matrix.

Figure 7. SQALE Pyramid

<chart type="SQALEPYRAMID" id="SQALEPYRAMID_EXAMPLE">
	<measure label="My Testability">CLOC</measure>
	<measure label="Stability">LC</measure>
	<measure label="Changeability">BLAN</measure>
	<measure label="Analysability">SLOC</measure>
</chart>

On top of supported common attributes, this chart also accepts the following additional attributes:

decimals (optional, default: 0) is the number of decimals places to be used for displaying values.

When used in this chart, the measure element accepts the following attributes:

label (optional, default: the measure’s name ) defines or overrides the label used for the measure.
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.

[ and ] allow you to specify that the boundary value is included, while ] and [ allow you to specify that the boundary value is excluded.

Text Values

This chart is supported in Model/Group Dashboards and Artifact Dashboards.

The Text Values chart is used to display one or more metrics (indicators, measures or information) as a large clickable element in your dashboard. The chart can also display the trend for the displayed metrics.

When used at Model/Group Dashboard level, only the measure element is available.

Figure 8. Text Values

<chart type="TEXTVALUES" id="TEXTVALUES_EXAMPLE" layout="4x3" displayEvolution="true">
	<measure color="#006893">A_FILE</measure>
	<measure color="#00a38a">B_FILE</measure>
	<measure color="#79c142">C_FILE</measure>
	<measure color="#fec422">D_FILE</measure>
	<measure color="#f6a01b">E_FILE</measure>
	<measure color="#f48026">F_FILE</measure>
	<measure color="#f25b21">G_FILE</measure>
</chart>

On top of supported common attributes, this chart also accepts the following additional attributes:

layout (optional, default: 1x1) defines how to display the metrics on the chart in terms of rows and columns.
displayLabel (optional, default: true) displays the labels.
displayEvolution (optional, default: false) allows displaying trends next to the metric value on the chart.
valueFontStyle (optional, default: BOLD) allows configuring the text font style.
valueTestAlign (optional, default: CENTER) allows configuring the text alignment.

When used in this chart, the measure element accepts the following attributes:

label (optional, default: the measure’s name ) defines or overrides the label used for the measure.
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.

[ and ] allow you to specify that the boundary value is included, while ] and [ allow you to specify that the boundary value is excluded.
color (optional, default: the project’s color, or a random color based on the artifact’s name ) defines the color used to represent the measure in the chart. To know more about colors, see the Working With Colors section.
alpha (optional, default: 255) defines the alpha applied to the color defined with color attribute, 255 for no transparency, 0 for invisible color.
aggregationType (optional, only available at Model/Group Dashboard level, 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

When used in this chart, the indicator element accepts the following attributes:

label (optional, default: the indicator’s name ) defines or overrides the label used for the indicator.

When used in this chart, the info element accepts the following attributes:

label (optional, default: the information value ) defines or overrides the label used for the information.