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

CustomChart

sealed class CustomChart : ProjectFeature

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

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

Abstact class for Project and Build Type related custom charts.

Example. Add a build-configuration-level custom chart.

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        buildTypeCustomChart {
            id = "BuildTypeCustomChartID"
            title = "Chart Title"
            seriesTitle = "Series Title"
            format = CustomChart.Format.DURATION
            series = listOf(
                Serie(title = "Build Duration (all stages)", key = SeriesKey.BUILD_DURATION),
                Serie(title = "Build Step #1 - Command Line with id RUNNER_14", key = SeriesKey.buildStepDuration("RUNNER_14"))
            )
        }
Content copied to clipboard
    }
}

Inheritors

ProjectCustomChart

BuildTypeCustomChart

Types

AbstractSeries

abstract class AbstractSeries(var title: String, var color: String?)

Abstract class for Series

AxisType

enum AxisType : Enum<CustomChart.AxisType>

The type of the Y axis

DefaultFilters

enum DefaultFilters : Enum<CustomChart.DefaultFilters> , CustomChart.FilterParameterValue

Predefined default filters.

Format

enum Format : Enum<CustomChart.Format>

The format of the Y axis values.

HideFilters

enum HideFilters : Enum<CustomChart.HideFilters> , CustomChart.FilterParameterValue

Predefined hide filters.

PatternSeries

class PatternSeries(var title: String, var pattern: String, var color: String? = null) : CustomChart.AbstractSeries

Series of data to be shown on the chart specified with pattern

Serie

class Serie(var title: String, var key: CustomChart.SeriesKey, var sourceBuildTypeId: String? = null, var color: String? = null) : CustomChart.AbstractSeries

A serie of data to be shown on the chart.

SeriesKey

class SeriesKey(val keyValue: String)

Default Statistics Values Provided by TeamCity

Properties

defaultFilters

var defaultFilters: List<CustomChart.DefaultFilters>?

The list of options to be checked by default.

format

var format: CustomChart.Format?

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

height

var height: Int?

The custom chart height in pixels.

hideFilters

var hideFilters: List<CustomChart.HideFilters>?

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

var id: String?

Project feature id, if not specified will be generated

params

val params: List<Parameter>

series

var series: List<CustomChart.AbstractSeries>?

The list of data shown on the chart.

seriesTitle

var seriesTitle: String?

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

title

var title: String?

The title above the chart.

type

var type: String

Project feature type

width

var width: Int?

The custom chart width in pixels.

yAxisIncludeZero

var yAxisIncludeZero: Boolean?

Whether the zero value is included on the Y axis.

yAxisMax

var yAxisMax: Int?

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

yAxisMin

var yAxisMin: Int?

An integer value to start the Y axis from

yAxisType

var yAxisType: CustomChart.AxisType?

The custom Y axis type.

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

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

copyParamsTo

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

Copies parameters of this object to the specified target

create

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