Package io.jenkins.plugins.coverage.metrics.charts

Class TrendChart

java.lang.Object

io.jenkins.plugins.coverage.metrics.charts.TrendChart

Direct Known Subclasses:

CoverageTrendChart, MetricsTrendChart

public abstract class TrendChart
extends Object

Builds the Java side model for a trend chart. The number of builds to consider is controlled by a ChartModelConfiguration instance. The created model object can be serialized to JSON (e.g., using the JacksonFacade) and can be used 1:1 as ECharts configuration object in the corresponding JS file.

Author:

Ullrich Hafner

See Also:

• JacksonFacade

Method Summary

Modifier and Type	Method	Description
abstract edu.hm.hafner.echarts.line.LinesChartModel	create(Iterable<edu.hm.hafner.echarts.BuildResult<CoverageStatistics>> results, edu.hm.hafner.echarts.ChartModelConfiguration configuration)	Creates the chart for the specified results.
static TrendChart	createTrendChart(boolean metrics)	Create a trend chart instance for coverage or software metrics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createTrendChart

public static TrendChart createTrendChart(boolean metrics)

Create a trend chart instance for coverage or software metrics.

Parameters:

metrics - if the instance should be the metrics

Returns:

the created Trend Chart Instance

create

public abstract edu.hm.hafner.echarts.line.LinesChartModel create(Iterable<edu.hm.hafner.echarts.BuildResult<CoverageStatistics>> results,
 edu.hm.hafner.echarts.ChartModelConfiguration configuration)

Creates the chart for the specified results.

Parameters:

results - the forensics results to render - these results must be provided in descending order, i.e. the current * build is the head of the list, then the previous builds, and so on

configuration - the chart configuration to be used

Returns:

the chart model, ready to be serialized to JSON