Interface ValueType
-
- All Superinterfaces:
ValueProvider
- All Known Implementing Classes:
BuildFinishAwareValueTypeBase
,BuildValueTypeBase
,CompositeVTB
,MultipleKeysBuildMetricVT
,SimpleBuildMetricVT
public interface ValueType extends ValueProvider
Statistic value type - such value type can be shown as a separate graph in the UI.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDescription(ChartSettings chartSettings)
Metric textual description, i.e.java.lang.String
getExtendedDescription(ChartSettings chartSettings)
Extended metric textual description (for tooltip), i.e.java.lang.String
getSeriesColor(java.lang.String s)
Allows to provide special color coding for series.java.lang.String
getSeriesGenericName()
Generic name for this value's seriesjava.lang.String
getValueFormat()
Format name for Values (point hints and axis).-
Methods inherited from interface jetbrains.buildServer.serverSide.statistics.ValueProvider
getDataSet, getKey, hasData
-
-
-
-
Method Detail
-
getDescription
@NotNull java.lang.String getDescription(ChartSettings chartSettings)
Metric textual description, i.e. "Build Duration"- Parameters:
chartSettings
- the same settings as passed toValueProvider.getDataSet(ChartSettings)
method- Returns:
- graph description, used in graph title on the web
-
getExtendedDescription
@NotNull java.lang.String getExtendedDescription(ChartSettings chartSettings)
Extended metric textual description (for tooltip), i.e. "Build Duration (includes stages A, B, C)"- Parameters:
chartSettings
- the same filter as passed toValueProvider.getDataSet(ChartSettings)
method- Returns:
- graph description, used in graph title on the web
-
getValueFormat
@Nullable java.lang.String getValueFormat()
Format name for Values (point hints and axis).
Following formats are supported by default:
- text - no special formatting, value is treat as float
- integer - only integer values
- duration - value is treat as milliseconds and is formatted
- size - value is treat as bytes and is formatted
- percent - value is treat as N%
- percentBy1 - value is treat as (N * 100)%
- Returns:
- format name.
-
getSeriesColor
@Nullable java.lang.String getSeriesColor(java.lang.String s)
Allows to provide special color coding for series.
Color should be formatted as web color - hex "#rrggbb" (or short hex form "#rgb") or color name.
- Parameters:
s
- series key- Returns:
- series color, null to autogenerate by renderer
-
getSeriesGenericName
java.lang.String getSeriesGenericName()
Generic name for this value's series- Returns:
- short name string
-
-