Trend Charts

Temporal

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

The Temporal chart shows the evolution of one or measures over time. The measure representation is defined by a renderer attribute (as explained in Using Datasets and Renderers for more details). It replaces the deprecated Temporal Evolution Bar and Temporal Evolution Line charts, and allows representing more than one data sets on the one chart.

CFG temporalEvo
Figure 1. Temporal using an AREA renderer
<chart type="TEMPORALEVOLUTION" id="TEMPORAL_EVOLUTION_AREA_EXAMPLE" onlyLast="5" renderer="AREA">
	<measure color="BLUE" alpha="75" label="Source Line of Code">SLOC
		<forecast>
			<version value="4865" timeValue="DATE(2014,05,01)" label="V3" />
			<version value="5555" timeValue="DATE(2014,06,01)" />
			<version value="2222+4444" timeValue="DATE(2014,08,01)" />
		</forecast>
	</measure>
	<measure color="ORANGE" alpha="75" label="Line of Code">LC
		<forecast>
			<version value="SLOC" timeValue="DATE(2014,05,01)" label="V3" />
			<version value="6666" timeValue="DATE(2014,06,01)" />
			<version value="3333+4444" timeValue="DATE(2014,08,01)" />
		</forecast>
	</measure>
</chart>

The Temporal can also be used to draw a bar chart or a line chart, as shown below:

CFG temporalEvoBar
Figure 2. Temporal using a BAR renderer
<chart type="TEMPORALEVOLUTION" id="TEMPORAL_EVOLUTION_BAR" renderer="BAR" onlyLast="5" exclude="VIEWER">
	<measure color="MAGENTA" alpha="85" label="Line of Code">LC
		<forecast>
			<version value="SLOC" timeValue="DATE(2014,05,01)" label="V3" />
			<version value="6666" timeValue="DATE(2014,06,01)" />
			<version value="3333+4444" timeValue="DATE(2014,08,01)" />
		</forecast>
	</measure>
</chart>
CFG temporalEvoLine
Figure 3. Temporal using a LINE renderer
<chart type="TEMPORALEVOLUTIONBAR" id="TEMPORAL_EVOLUTION_LINE_EXAMPLE" onlyLast="5" isCChart="true">
	<dataset renderer="LINE">
		<measure color="BLUE" label="Source Line of Code">SLOC
			<forecast>
				<version value="4865" timeValue="DATE(2014,05,01)" label="V3" />
				<version value="5555" timeValue="DATE(2014,06,01)" />
				<version value="2222+4444" timeValue="DATE(2014,08,01)" />
			</forecast>
		</measure>
		<measure color="CYAN" label="Line of Code">LC
			<forecast>
				<version value="SLOC" timeValue="DATE(2014,05,01)" label="V4" />
				<version value="6666" timeValue="DATE(2014,06,01)" />
				<version value="3333+4444" timeValue="DATE(2014,08,01)" />
			</forecast>
		</measure>
	</dataset>
</chart>

The chart above is a normal Temporal where the x-axis uses a regular gap between all versions and uses the version name as the label.

Below is an example of the difference in representation when using the x-axis as a chronological marker.

CFG TELINE byTime
Figure 4. Temporal with versions distributed evenly on the x-axis, using the version name as the label (left), or distributed on the x-axis according to the date at which the analysis was carried out. Labels on the x-axis do to not correspond to the version name this time. (right).
<chart type="TEMPORALEVOLUTIONBAR" id="TEMPORAL_EVOLUTION_LINE_EXAMPLE_2" onlyLast="5" dateFormat="MMM d" byTime="true|false" isCChart="true">
	<dataset renderer="LINE">
		<measure color="RED" label="Line of Code">LC
			<forecast>
				<version value="SLOC" timeValue="DATE(2014,05,01)" label="V4" />
				<version value="SLOC" timeValue="DATE(2014,06,01)" />
				<version value="SLOC" timeValue="DATE(2014,07,01)" />
				<version value="3333+4444" timeValue="DATE(2014,14,01)" />
			</forecast>
		</measure>
	</dataset>
</chart>

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

  • backgroundColorForHeaderOnly (optional, default: false) allows displaying the background color in the header only.

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

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

  • renderer (optional, default: BAR) allows specifying the type of rendering for the data series.

  • isCChart (optional, default: false) transforms the chart in a C-Chart if set to true. This draws three extra lines to the chart at the following values on the y-axis: "mean", "mean + (coefficient * standard deviation)" and "mean - (coefficient * standard deviation)".

  • coeff (optional, default: 0) sets the value of the coefficient used to draw the control lines either side of the mean line when isCChart is set to true.

  • breakOnMissingData (optional, default: false) specifies whether the line is interrupted (true) when a value is missing.

  • displayDate (optional, default: false) for all charts that display information about several versions. When set to false, the version name is displayed in the chart. When set to true, the version date is displayed instead.

  • onlyLast (optional, default: no limit) defines the number of versions to be displayed, starting from the one that is currently selected.

  • byTime (optional, default: false) defines whether versions are placed on the x-axis according to their analysis dat.

  • timeMeasure (optional) is the measure ID (of type DATE) to use as the analysis date for a chart where byTime is true. If not specified, the real analysis date of the version is used.

  • datePattern (formerly dateFormat) (optional, default: empty) : the date pattern, used when the displayType is one of DATE, DATETIME or TIME. For example:

    • "yyyy.MM.dd G 'at' HH:mm:ss z" is "2001.07.04 AD at 12:08:56 PDT".

    • "EEE, d MMM yyyy HH:mm:ss Z" is "Wed, 4 Jul 2001 12:08:56 -0700".

    If this attribute is set, both dateStyle and timeStyle attributes are ignored. The date is formatted using the supplied pattern. Any format compatible with the Java Simple Date Format can be used. Refer to http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html for more information.

  • dateStyle (optional, default: DEFAULT) : the date formatting style, used when the displayType is one of DATE or DATETIME.

    • SHORT is completely numeric, such as 12.13.52 or 3:30pm.

    • MEDIUM is longer, such as Jan 12, 1952.

    • DEFAULT is MEDIUM.

    • LONG is longer, such as January 12, 1952 or 3:30:32pm.

    • FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42pm PST.

  • timeStyle (optional, default: DEFAULT): the time formatting style, used when the displayType is one of DATETIME or TIME. See above for available styles.

Temporal Evolution Simple Stacked Bar

This chart is supported only in Artifact Dashboards.

The Temporal Evolution Simple Stacked Bar chart represents the evolution of an indicator across the versions. It takes a single indicator as sub element. The values displayed are calculated on the fly. It is therefore sometimes recommended to use an Temporal Evolution Optimised Stacked Bar for performance reasons.

CFG simpleTemporalEvoStackedBar nopercent
Figure 5. Temporal Evolution Optimised Stacked Bar
<chart type="SIMPLETEMPORALEVOLUTIONSTACKEDBAR" id="SIMPLETEMPORALEVOLUTIONSTACKEDBAR_EXAMPLE" targetArtefactTypes="FILE">
	<indicator>ROOT</indicator>
</chart>

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

  • backgroundColorForHeaderOnly (optional, default: false) allows displaying the background color in the header only.

  • artefactsLimit (optional, default: 2000 ) allows limiting the number of child artifacts to include.

  • inverted (optional, default: false) allows reversing the sort order of bars in the chart.

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

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

  • renderer (optional, default: STACKED_BAR) allows specifying the type of rendering for the data series.

  • isCChart (optional, default: false) transforms the chart in a C-Chart if set to true. This draws three extra lines to the chart at the following values on the y-axis: "mean", "mean + (coefficient * standard deviation)" and "mean - (coefficient * standard deviation)".

  • coeff (optional, default: 0) sets the value of the coefficient used to draw the control lines either side of the mean line when isCChart is set to true.

  • breakOnMissingData (optional, default: false) specifies whether the line is interrupted (true) when a value is missing.

  • displayDate (optional, default: false) for all charts that display information about several versions. When set to false, the version name is displayed in the chart. When set to true, the version date is displayed instead.

  • onlyLast (optional, default: no limit) defines the number of versions to be displayed, starting from the one that is currently selected.

  • byTime (optional, default: false) defines whether versions are placed on the x-axis according to their analysis dat.

  • timeMeasure (optional) is the measure ID (of type DATE) to use as the analysis date for a chart where byTime is true. If not specified, the real analysis date of the version is used.

  • datePattern (formerly dateFormat) (optional, default: empty) : the date pattern, used when the displayType is one of DATE, DATETIME or TIME. For example:

    • "yyyy.MM.dd G 'at' HH:mm:ss z" is "2001.07.04 AD at 12:08:56 PDT".

    • "EEE, d MMM yyyy HH:mm:ss Z" is "Wed, 4 Jul 2001 12:08:56 -0700".

    If this attribute is set, both dateStyle and timeStyle attributes are ignored. The date is formatted using the supplied pattern. Any format compatible with the Java Simple Date Format can be used. Refer to http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html for more information.

  • dateStyle (optional, default: DEFAULT) : the date formatting style, used when the displayType is one of DATE or DATETIME.

    • SHORT is completely numeric, such as 12.13.52 or 3:30pm.

    • MEDIUM is longer, such as Jan 12, 1952.

    • DEFAULT is MEDIUM.

    • LONG is longer, such as January 12, 1952 or 3:30:32pm.

    • FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42pm PST.

  • timeStyle (optional, default: DEFAULT): the time formatting style, used when the displayType is one of DATETIME or TIME. See above for available styles.

It also supports the common distributed charts grouping and aggregating features defined in Distributed Charts section.

Temporal Evolution Optimised Stacked Bar

This chart is supported only in Artifact Dashboards.

The Temporal Evolution Optimised Stacked Bar chart represents the evolution of several measures across several versions. It takes a minimum of two measures as elements.

CFG temporalEvoStackedBar nopercent
Figure 6. Temporal Evolution Optimised Stacked Bar
<chart type="OPTIMIZEDTEMPORALEVOLUTIONSTACKEDBAR" id="OPTIMIZED_TEMPORAL_EVOLUTION_STACKED_BAR_EXEMPLE" targetArtefactTypes="FILE">
	<measure color="#006893" label="A">A_FILE</measure>
	<measure color="#00a38a" 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:

  • backgroundColorForHeaderOnly (optional, default: false) allows displaying the background color in the header only.

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

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

  • renderer (optional, default: STACKED_BAR) allows specifying the type of rendering for the data series.

  • isCChart (optional, default: false) transforms the chart in a C-Chart if set to true. This draws three extra lines to the chart at the following values on the y-axis: "mean", "mean + (coefficient * standard deviation)" and "mean - (coefficient * standard deviation)".

  • coeff (optional, default: 0) sets the value of the coefficient used to draw the control lines either side of the mean line when isCChart is set to true.

  • breakOnMissingData (optional, default: false) specifies whether the line is interrupted (true) when a value is missing.

  • displayDate (optional, default: false) for all charts that display information about several versions. When set to false, the version name is displayed in the chart. When set to true, the version date is displayed instead.

  • onlyLast (optional, default: no limit) defines the number of versions to be displayed, starting from the one that is currently selected.

  • byTime (optional, default: false) defines whether versions are placed on the x-axis according to their analysis dat.

  • timeMeasure (optional) is the measure ID (of type DATE) to use as the analysis date for a chart where byTime is true. If not specified, the real analysis date of the version is used.

  • datePattern (formerly dateFormat) (optional, default: empty) : the date pattern, used when the displayType is one of DATE, DATETIME or TIME. For example:

    • "yyyy.MM.dd G 'at' HH:mm:ss z" is "2001.07.04 AD at 12:08:56 PDT".

    • "EEE, d MMM yyyy HH:mm:ss Z" is "Wed, 4 Jul 2001 12:08:56 -0700".

    If this attribute is set, both dateStyle and timeStyle attributes are ignored. The date is formatted using the supplied pattern. Any format compatible with the Java Simple Date Format can be used. Refer to http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html for more information.

  • dateStyle (optional, default: DEFAULT) : the date formatting style, used when the displayType is one of DATE or DATETIME.

    • SHORT is completely numeric, such as 12.13.52 or 3:30pm.

    • MEDIUM is longer, such as Jan 12, 1952.

    • DEFAULT is MEDIUM.

    • LONG is longer, such as January 12, 1952 or 3:30:32pm.

    • FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42pm PST.

  • timeStyle (optional, default: DEFAULT): the time formatting style, used when the displayType is one of DATETIME or TIME. See above for available styles.