ChartErrorBarProps

Configuration options for customizing error bars in chart series.

Props

The following table outlines the props for the ChartErrorBarProps:

NameTypeDefaultDescription
color
string
''

Specifies the stroke color of the error bar. Accepts hex, rgba, or any valid CSS color string.

errorBarCap
ChartErrorBarCapProps
{ width: 1, length: 10, color: "", opacity: 1 }

Allows customization of the appearance and behavior of the caps at the ends of error bars in a chart series.

errorBarColorField
string
''

Defines the color for the error bar, which is mapped to the data source mapping name.

horizontalError
number | string
0

Specifies the horizontal error value associated with each data point. This value can be mapped from a specific field in the data source.

type
ErrorBarType
'Custom'

Specifies the type of error bar to render on the chart. Determines how the error values are calculated and displayed. The available options are:

  • Percentage - Renders an error bar based on percentage.
  • StandardDeviation- Renders an error bar using standard deviation.
  • StandardError- Renders an error bar using standard error.
  • Custom- Renders a custom-defined error bar.
verticalError
number | string
1

Specifies the vertical error value associated with each data point. This value can be mapped from a specific field in the data source.

visible
boolean
false

Specifies whether error bars should be displayed for the data. When set to true, error bars will be rendered to represent data variability or uncertainty.

width
number
1

Defines the width of the error bars in the chart series. This value controls the thickness of the error bars, allowing customization of their appearance.