TeamCity Kotlin DSL

ProjectCustomChart

TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin/ProjectCustomChart

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

ProjectCustomChart

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

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): SingleDelegateProvider<Boolean>

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T>

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

open fun create(): ProjectFeature

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.

doubleParameter

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

fun findRawParam(paramName: String): Parameter?

fun hasParam(paramName: String): Boolean

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

fun param(name: String, value: String)

Adds parameter with specified name and value

fun removeRawParam(paramName: String)

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

open override fun toString(): String

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

var defaultFilters: List<CustomChart.DefaultFilters>?

The list of options to be checked by default.

var format: CustomChart.Format?

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

var height: Int?

The custom chart height in pixels.

var hideFilters: List<CustomChart.HideFilters>?

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

var id: String? = null

Project feature id, if not specified will be generated

val params: List<Parameter>

var series: List<CustomChart.AbstractSeries>?

The list of data shown on the chart.

var seriesTitle: String?

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

var title: String?

The title above the chart.

var type: String

Project feature type

var width: Int?

The custom chart width in pixels.

yAxisIncludeZero

var yAxisIncludeZero: Boolean?

Whether the zero value is included on the Y axis.

var yAxisMax: Int?

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

var yAxisMin: Int?

An integer value to start the Y axis from

var yAxisType: CustomChart.AxisType?

The custom Y axis type.