ProjectCustomChart

open class ProjectCustomChart(init: CustomChart.() -> Unit = {}) : CustomChart

A project-level Custom Chart

Example.

projectCustomChart {
id = "ProjectCustomChart_1"
title = "Chart Title"
seriesTitle = "Series Title"
format = CustomChart.Format.DURATION
series = listOf(
Serie(title = "Build Duration (all stages)", key = SeriesKey.BUILD_DURATION, sourceBuildTypeId = "Project_Build"),
Serie(title = "Build Step #1 - Command Line with id RUNNER_14", key = SeriesKey.buildStepDuration("RUNNER_14"), , sourceBuildTypeId = "Project_Build")
)
}








Constructors

Link copied to clipboard
constructor(init: CustomChart.() -> Unit = {})

Properties

Link copied to clipboard

The list of options to be checked by default.

Link copied to clipboard
var format: <Error class: unknown class>

The format of the y-axis values. If no format is specified, the numeric format is used.

Link copied to clipboard
var height: <Error class: unknown class>

The custom chart height in pixels.

Link copied to clipboard

The list of filter names that will not be shown next to the chart.

Link copied to clipboard
var id: String?

Project feature id, if not specified will be generated

Link copied to clipboard
Link copied to clipboard

The list of data shown on the chart.

Link copied to clipboard
var seriesTitle: <Error class: unknown class>

The title above the list of series used on the chart (in the singular form). The default is Serie.

Link copied to clipboard
var title: <Error class: unknown class>

The title above the chart.

Link copied to clipboard

Project feature type

Link copied to clipboard
var width: <Error class: unknown class>

The custom chart width in pixels.

Link copied to clipboard
var yAxisIncludeZero: <Error class: unknown class>

Whether the zero value is included on the Y axis.

Link copied to clipboard
var yAxisMax: <Error class: unknown class>

An integer value to use as the maximum for the Y axis value

Link copied to clipboard
var yAxisMin: <Error class: unknown class>

An integer value to start the Y axis from

Link copied to clipboard
var yAxisType: <Error class: unknown class>

The custom Y axis type.

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard

Creates an instance of this project feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer