Package io.jenkins.plugins.echarts
Class TrendChartJobAction<T extends io.jenkins.plugins.util.BuildAction<?>>
java.lang.Object
io.jenkins.plugins.util.JobAction<T>
io.jenkins.plugins.echarts.TrendChartJobAction<T>
- Type Parameters:
T
- type of the results
- All Implemented Interfaces:
Action
,ModelObject
,AsyncConfigurableTrendChart
public abstract class TrendChartJobAction<T extends io.jenkins.plugins.util.BuildAction<?>>
extends io.jenkins.plugins.util.JobAction<T>
implements AsyncConfigurableTrendChart
A job action displays a link on the side panel of a job that refers to the last build that contains results (i.e., a
BuildAction
with a corresponding result). This action also is responsible to render the historical trend via
its associated 'floatingBox.jelly' view. ECharts will render the trend chart: the model of the chart will be
obtained using an asynchronous Ajax call. This action basically is the same as TrendChartJobAction
,
it additionally provides a configuration of the trend chart using a JSON object (given as a string value). This
JSON object can be populated in the client using a configuration dialog (or using the browser's local storage).
For the default trend charts that are simply built around ChartModelConfiguration
you can include the provided
global configuration dialog with <st:adjunct includes="io.jenkins.plugins.echarts-trend-default-setup"/>
.- Author:
- Ullrich Hafner
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
TrendChartJobAction
(Job<?, ?> owner, Class<T> buildActionClass) Creates a new instance ofTrendChartJobAction
. -
Method Summary
Modifier and TypeMethodDescriptionCreates a history of build results.protected abstract edu.hm.hafner.echarts.line.LinesChartModel
createChartModel
(String configuration) Creates the model of the trend chart.getConfigurableBuildTrendModel
(String configuration) Returns the UI model for an ECharts chart that shows the build trend.abstract String
boolean
This default implementation checks whether there are at least two build results available.Methods inherited from class io.jenkins.plugins.util.JobAction
doIndex, getBuildActionClass, getLatestAction, getOwner
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface hudson.model.Action
getDisplayName, getIconFileName
-
Constructor Details
-
TrendChartJobAction
Creates a new instance ofTrendChartJobAction
.- Parameters:
owner
- the job that owns this actionbuildActionClass
- the type of the action to find
-
-
Method Details
-
getUrlName
- Specified by:
getUrlName
in interfaceAction
-
getConfigurableBuildTrendModel
Description copied from interface:AsyncConfigurableTrendChart
Returns the UI model for an ECharts chart that shows the build trend. The model has to be a JSON representation of a correspondingLinesChartModel
instance, that will be inserted into the client side model of the corresponding ECharts instance.- Specified by:
getConfigurableBuildTrendModel
in interfaceAsyncConfigurableTrendChart
- Parameters:
configuration
- JSON configuration of the chart (number of builds, etc.). It is up to an individual plugin to correctly create this configuration in the trend configuration dialog.- Returns:
- the UI model as JSON
- See Also:
-
createChartModel
protected abstract edu.hm.hafner.echarts.line.LinesChartModel createChartModel(String configuration) Creates the model of the trend chart. The returned model will be converted to JSON and inserted into the client side model of the corresponding ECharts instance.- Parameters:
configuration
- JSON configuration of the chart (number of builds, etc.). It is up to an individual plugin to correctly create this configuration in the trend configuration dialog.- Returns:
- the model of the trend chart
- See Also:
-
isTrendVisible
public boolean isTrendVisible()This default implementation checks whether there are at least two build results available. Override if this behavior does not make sense in your job action.- Specified by:
isTrendVisible
in interfaceAsyncConfigurableTrendChart
- Returns:
true
if there are at least two results,false
otherwise
-
createBuildHistory
Creates a history of build results. This default implementation selects all actions that share the same URL and returns these actions as value for the trend charts.- Returns:
- the build history
- See Also:
-