grafit-charts

---

Interface: BoxPlotSeriesOptions

Extends

• Omit<SeriesBaseOptions<BoxPlotTooltipRendererParams>, "yField" | "name">

Properties

capLengthRatio?

optional capLengthRatio?: number

Whisker cap width as a fraction of the box width.

---

fill?

optional fill?: string

---

fillOpacity?

optional fillOpacity?: number

---

groupGap?

optional groupGap?: number

Gap between boxes of one category group — fraction of the slot step (0–0.9, default 0.2). Ignored when the series is alone in the band.

---

id?

optional id?: string

Inherited from

LineSeriesOptions.id

---

itemStyler?

optional itemStyler?: Styler<BoxPlotItemStylerParams, BoxPlotItemStyle>

Style of one box by its datum. Undefined leaves the box as it is; a partial style is laid over it.

---

maxField

maxField: string

---

medianField

medianField: string

---

minField

minField: string

---

name?

optional name?: string

---

q1Field

q1Field: string

---

q3Field

q3Field: string

---

showInLegend?

optional showInLegend?: boolean

Inherited from

LineSeriesOptions.showInLegend

---

stroke?

optional stroke?: string

---

strokeWidth?

optional strokeWidth?: number

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

optional renderer?: (params) => string | TooltipContentData

Parameters

params

BoxPlotTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

Omit.tooltip

---

type

type: "box-plot"

---

visible?

optional visible?: boolean

Inherited from

Showable.visible

---

xField

xField: string

Inherited from

LineSeriesOptions.xField

---

xName?

optional xName?: string

Inherited from

LineSeriesOptions.xName