ZoomCharts Documentation
Version: 1.21.1 (2024-11-08)

TimeChart.settings.valueAxis.thresholds

This section is defined by the type BaseSettingsValueAxisThreshold.

Properties

from: number
Default value: -Infinity

Specifies the bottom bound of the threshold area.

fromType: "constant" | "first" | "last" | "minimum" | "maximum" | "median" | "average" | "percentile"
Default value: "constant"

How the from value should be determined

Valid values:
  • constant - Use the from constant given
  • first - Use the first value in range
  • last - Use the last value in range
  • minimum - Use the minimum value in the series
  • maximum - Use the maximum value in the series
  • median - Use the median value in the series
  • average - Use the average value in the series
  • percentile - Use a percentile value in the series
label: string
labelDecimals: number
Default value: null
labelDisplayUnits: string
Default value: null
labelHorizontalPadding: number
Default value: 0
labelHorizontalPosition: "center" | "right" | "left"
Default value: "left"
labelType: "text" | "fromValue" | "toValue" | "textFromValue" | "textToValue"
Default value: "text"

Whether to use the line value as the label text

labelVerticalPadding: number
Default value: 0
labelVerticalPosition: "center" | "above" | "under"
Default value: "above"
percentileFrom: number
Default value: 0

Specifies a percentile to use when percentile is selected. Range 0 to 100, must be integer.

percentileTo: number
Default value: 0

Specifies a percentile to use when percentile is selected. Range 0 to 100, must be integer.

position: "above" | "under"
Default value: "under"

Threshold placement in relation to series data.

Valid values:
  • above - denote threshold location over series data
  • under - denote threshold location under series data
seriesID: string
Default value: null

Which series to use for non-constant values

style: anonymous type

Describes the visual style for the threshold guidelines and area.

Properties
fillColor: string
Default value: "rgba(255,133,152,0.2)"

Specifies the fill color for the threshold area. If multiple areas overlap, this should specify an rgba() color with transparency. If 'null' fill color will not be applied.

lineColor: string
Default value: "rgba(255,0,0,0.5)"

Specifies the line color for the upper and lower bounds. If null, the lines will not be drawn.

lineDash: Array<number>

Array of line dash pattern to have a dashed line. The array contains length of dash followed by length of space in pixels. A sequence of multiple dash-space values is supported. In case you want to set a solid line, pass empty array: []

lineWidth: number
Default value: 1

Specifies the width of the boundary lines.

to: number
Default value: Infinity

Specifies the upper bound of the threshold area.

toType: "constant" | "first" | "last" | "minimum" | "maximum" | "median" | "average" | "percentile"
Default value: "constant"

How the from value should be determined

Valid values:
  • constant - Use the from constant given
  • first - Use the first value in range
  • last - Use the last value in range
  • minimum - Use the minimum value in the series
  • maximum - Use the maximum value in the series
  • median - Use the median value in the series
  • average - Use the average value in the series
  • percentile - Use a percentile value in the series
valueFunction: (from: number, to: number, settings: BaseSettingsValueAxisThreshold) => { fromLabel: string; toLabel: string; }
Parameters
from: number
to: number
Return value
Data type: anonymous type
Properties
fromLabel: string
toLabel: string
X