ChartBoxAndWhiskerSettings

Provides configuration options for controlling the calculation logic and visual appearance of a Box‑and‑Whisker chart series.

Props

The following table outlines the props for the ChartBoxAndWhiskerSettings:

NameTypeDefaultDescription
boxPlotMode
BoxPlotMode
'Normal'

Defines the statistical method used to calculate quartiles and whisker ranges in the Box‑and‑Whisker series.

  • Exclusive– Quartiles exclude the median from the halves.
  • Inclusive – Quartiles include the median in both halves.
  • Normal– Uses the standard box plot calculation method.
showMean
boolean
true

Indicates whether the mean value should be calculated and visually rendered as a marker or line within the box.

showOutliers
boolean
true

Determines whether values outside the whisker range should be treated as outliers and rendered as individual markers. When enabled, outliers are collected into symbolLocations and rendered using the existing marker rendering pipeline.

whiskerStyle
ChartWhiskerStyleProps
{ color: '', width: 1, dashArray: '', capLength: 0.5 }

Specifies the visual styling for whisker stems and end caps in the Box‑and‑Whisker series. Includes control over line color, width, dash pattern, and cap length.