Package io.jenkins.plugins.echarts

Interface AsyncConfigurableTrendChart

All Known Implementing Classes:
AsyncConfigurableTrendJobAction, TrendChartJobAction
public interface AsyncConfigurableTrendChart
Provides the trend chart for a job. The trend chart model will be rendered by ECharts: the model of the chart will be obtained using an asynchronous Ajax call.
Author:
Ullrich Hafner

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getConfigurableBuildTrendModel(String configuration)
    Returns the UI model for an ECharts chart that shows the build trend.
    boolean
    isTrendVisible()
    Returns whether the trend report should be shown.

  • Method Details

    • getConfigurableBuildTrendModel

      @JavaScriptMethod String getConfigurableBuildTrendModel(String configuration)
      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.
      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:

    • isTrendVisible

      boolean isTrendVisible()
      Returns whether the trend report should be shown.
      Returns:
      true if the trend should be shown, false otherwise