SeriesErrorBars

The configuration options of the series error bars.

color? string

The color of the error bars. Accepts a valid CSS color string, including hex and rgb.

endCaps? boolean

If set to false, the caps of the error bars are not displayed. By default, the caps are visible.

line? ErrorBarLine

The error bars line options.

value? string

The error bars value.
The value option is supported when series.type is set to "bar", "column", "line", or "area".

The following value types are supported:

  • "stderr"—The standard error of the series values will be used to calculate the point low and high values.
  • "stddev(n)"—The standard deviation of the series values will be used to calculate the point low and high values. Between the parentheses, a number can be specified that will be multiplied by the calculated standard deviation.
  • "percentage(n)"—A percentage of the point value.
  • A number that will be subtracted or added to the point value.
  • An array that holds the low and high difference from the point value.
  • A function that returns the errorBars point value.

visual? (e: ErrorBarsVisualArgs) => Element

A function that for creating custom visuals for the error bars.

The available argument fields are:

  • rect—The geometry Rect that defines where the visual has to be rendered.
  • options—The error bar options.
  • createVisual—A function that can be used to get the default visual.
  • low—The error bar low value.
  • high—The error bar high value.
  • sender—The Chart instance.

xValue? string

The value of the xAxis error bars. For a list of the supported value
types, refer to the series.errorBars.value option.
The xValue option is supported when series.type is set to "scatter", "scatterLine", or "bubble".

yValue? string

The value of the yAxis error bars. For a list of supported value types, refer
to the series.errorBars.value option.
The yValue option is supported when series.type is set to "scatter", "scatterLine", or "bubble".