Package io.jenkins.plugins.echarts

Klasse TrendChartJobAction<T extends io.jenkins.plugins.util.BuildAction<?>>

java.lang.Object
io.jenkins.plugins.util.JobAction<T>
io.jenkins.plugins.echarts.TrendChartJobAction<T>
Typparameter:
T - type of the results
Alle implementierten Schnittstellen:
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. The trend chart will be rendered by ECharts: 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"/>.
Autor:
Ullrich Hafner

  • Konstruktordetails

    • TrendChartJobAction

      protected TrendChartJobAction(Job<?,?> owner, Class<T> buildActionClass)
      Creates a new instance of TrendChartJobAction.
      Parameter:
      owner - the job that owns this action
      buildActionClass - the type of the action to find

  • Methodendetails

    • getUrlName

      @NonNull public abstract String getUrlName()
      Angegeben von:
      getUrlName in Schnittstelle Action

    • getConfigurableBuildTrendModel

      @JavaScriptMethod public String getConfigurableBuildTrendModel(String configuration)
      Beschreibung aus Schnittstelle kopiert: AsyncConfigurableTrendChart
      Returns the UI model for an ECharts chart that shows the build trend. The model has to be a JSON representation of a corresponding LinesChartModel instance, that will be inserted into the client side model of the corresponding ECharts instance.
      Angegeben von:
      getConfigurableBuildTrendModel in Schnittstelle AsyncConfigurableTrendChart
      Parameter:
      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.
      Gibt zurück:
      the UI model as JSON
      Siehe auch:

    • 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.
      Parameter:
      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.
      Gibt zurück:
      the model of the trend chart
      Siehe auch:
      • for details on how to construct such a model

    • 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.
      Angegeben von:
      isTrendVisible in Schnittstelle AsyncConfigurableTrendChart
      Gibt zurück:
      true if there are at least two results, false otherwise

    • createBuildHistory

      protected Iterable<? extends edu.hm.hafner.echarts.BuildResult<T>> 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.
      Gibt zurück:
      the build history
      Siehe auch: