ErrorBarSettings API in React Chart API component

The ErrorBarSettings class provides options to customize the appearance and behavior of error bars in a series.

Properties

color

string

The color of the error bar’s stroke, which accepts values in hex, rgba, or as a valid CSS color string.

Defaults to null

direction

ErrorBarDirection

Specifies the direction of the error bar. The available options are:

• Both - Renders error bars in both directions (positive and negative).
• Minus - Renders error bars in the negative direction.
• Plus - Renders error bars in the positive direction.

Defaults to ‘Both’

errorBarCap

ErrorBarCapSettingsModel

The errorBarCap property allows customization of the appearance and behavior of the caps at the ends of error bars in a chart series.

errorBarColorMapping

string

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

Defaults to ”

horizontalError

number | string

The horizontal error of the point can also be mapped from the data source.

Defaults to 1

horizontalNegativeError

number | string

The horizontal negative error of the point can be mapped from the data source as well.

Defaults to 1

horizontalPositiveError

number | string

The horizontal positive error of the point can be mapped from the data source as well.

Defaults to 1

mode

ErrorBarMode

Specifies the mode for the error bar. The available options are:

• Vertical - Renders error bars in a vertical direction.
• Horizontal - Renders error bars in a horizontal direction.
• Both - Renders error bars in both vertical and horizontal directions.

Defaults to ‘Vertical’

type

ErrorBarType

Specifies the type of error bar. The available options are:

• Fixed - Renders a fixed type error bar.
• Percentage - Renders a percentage type error bar.
• StandardDeviation - Renders a standard deviation type error bar.
• StandardError - Renders a standard error type error bar.
• Custom - Renders a custom type error bar.

Defaults to ‘Fixed’

verticalError

number | string

The vertical error for the point can also be mapped from the data source.

Defaults to 1

verticalNegativeError

number | string

The vertical negative error of the point can be mapped from the data source as well.

Defaults to 3

verticalPositiveError

number | string

The vertical positive error of the point can be mapped from the data source as well.

Defaults to 3

visible

boolean

If set to true, the error bar for the data will be rendered.

Defaults to false

width

number

The width property determines the thickness of the error bars rendered in the chart series.

Defaults to 1