chartjs-chart-boxplot

Appearance

chartjs-chart-boxplot v4.3.1 / BoxPlotControllerDatasetOptions

Interface: BoxPlotControllerDatasetOptions ​

Extends ​

  • ControllerDatasetOptions.IBoxplotOptions.ScriptableAndArrayOptions<IBoxAndWhiskersOptions, ScriptableContext<"boxplot">>.ScriptableAndArrayOptions<CommonHoverOptions, ScriptableContext<"boxplot">>.AnimationOptions<"boxplot">

Properties ​

backgroundColor ​

backgroundColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

Default ​

ts
see rectangle

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.backgroundColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:12

borderColor ​

borderColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

Default ​

ts
see rectangle

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.borderColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:19

borderWidth ​

borderWidth: ScriptableAndArray<number, ScriptableContext<"boxplot">>

Default ​

ts
1

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.borderWidth

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:26

coef? ​

optional coef: number

from the R doc: this determines how far the plot ‘whiskers’ extend out from the box. If coef is positive, the whiskers extend to the most extreme data point which is no more than coef times the length of the box away from the box. A value of zero causes the whiskers to extend to the data extremes

Default ​

ts
1.5

Inherited from ​

IBoxplotOptions.coef

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/data.ts:123

hitPadding ​

hitPadding: ScriptableAndArray<number, ScriptableContext<"boxplot">>

padding that is added around the bounding box when computing a mouse hit

Default ​

ts
2

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.hitPadding

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:126

itemBackgroundColor ​

itemBackgroundColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

background color for items

Default ​

ts
see rectangle.backgroundColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.itemBackgroundColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:102

itemBorderColor ​

itemBorderColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

border color for items

Default ​

ts
see rectangle.borderColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.itemBorderColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:110

itemBorderWidth ​

itemBorderWidth: ScriptableAndArray<number, ScriptableContext<"boxplot">>

border width for items

Default ​

ts
0

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.itemBorderWidth

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:118

itemRadius ​

itemRadius: ScriptableAndArray<number, ScriptableContext<"boxplot">>

radius used to render items

Default ​

ts
0 so disabled

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.itemRadius

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:94

itemStyle ​

itemStyle: ScriptableAndArray<"triangle" | "circle" | "line" | "rect" | "cross" | "crossRot" | "dash" | "rectRounded" | "rectRot" | "star", ScriptableContext<"boxplot">>

item style used to render items

Default ​

ts
circle

Inherited from ​

ScriptableAndArrayOptions.itemStyle

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:76

lowerBackgroundColor ​

lowerBackgroundColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

color the lower half (median-q3) of the box in a different color

Default ​

ts
'transparent' takes the current borderColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.lowerBackgroundColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/BoxAndWiskers.ts:30

maxStats? ​

optional maxStats: "max" | "q3" | "whiskerMax"

statistic measure that should be used for computing the maximal data limit

Default ​

ts
'max'

Inherited from ​

IBoxplotOptions.maxStats

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/data.ts:114

meanBackgroundColor ​

meanBackgroundColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

background color for mean dot

Default ​

ts
see rectangle.backgroundColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.meanBackgroundColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:166

meanBorderColor ​

meanBorderColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

border color for mean dot

Default ​

ts
see rectangle.borderColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.meanBorderColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:174

meanBorderWidth ​

meanBorderWidth: ScriptableAndArray<number, ScriptableContext<"boxplot">>

border width for mean dot

Default ​

ts
0

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.meanBorderWidth

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:182

meanRadius ​

meanRadius: ScriptableAndArray<number, ScriptableContext<"boxplot">>

radius used to mean dots

Default ​

ts
3

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.meanRadius

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:158

meanStyle ​

meanStyle: ScriptableAndArray<"triangle" | "circle" | "line" | "rect" | "cross" | "crossRot" | "dash" | "rectRounded" | "rectRot" | "star", ScriptableContext<"boxplot">>

item style used to render mean dot

Default ​

ts
circle

Inherited from ​

ScriptableAndArrayOptions.meanStyle

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:140

medianColor ​

medianColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

separate color for the median line

Default ​

ts
'transparent' takes the current borderColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.medianColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/BoxAndWiskers.ts:22

minStats? ​

optional minStats: "min" | "q1" | "whiskerMin"

statistic measure that should be used for computing the minimal data limit

Default ​

ts
'min'

Inherited from ​

IBoxplotOptions.minStats

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/data.ts:108

outlierBackgroundColor ​

outlierBackgroundColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

Default ​

ts
see rectangle.backgroundColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.outlierBackgroundColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:57

outlierBorderColor ​

outlierBorderColor: ScriptableAndArray<string, ScriptableContext<"boxplot">>

Default ​

ts
see rectangle.borderColor

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.outlierBorderColor

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:64

outlierBorderWidth ​

outlierBorderWidth: ScriptableAndArray<number, ScriptableContext<"boxplot">>

Default ​

ts
1

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.outlierBorderWidth

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:70

outlierHitRadius ​

outlierHitRadius: ScriptableAndArray<number, ScriptableContext<"boxplot">>

hit radius for hit test of outliers

Default ​

ts
4

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.outlierHitRadius

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:134

outlierRadius ​

outlierRadius: ScriptableAndArray<number, ScriptableContext<"boxplot">>

radius used to render outliers

Default ​

ts
2

Scriptable ​

Indexable ​

Inherited from ​

ScriptableAndArrayOptions.outlierRadius

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:50

outlierStyle ​

outlierStyle: ScriptableAndArray<"triangle" | "circle" | "line" | "rect" | "cross" | "crossRot" | "dash" | "rectRounded" | "rectRot" | "star", ScriptableContext<"boxplot">>

item style used to render outliers

Default ​

ts
circle

Inherited from ​

ScriptableAndArrayOptions.outlierStyle

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:32

quantiles? ​

optional quantiles: QuantileMethod

the method to compute the quantiles.

7, 'quantiles': the type-7 method as used by R 'quantiles' method. 'hinges' and 'fivenum': the method used by R 'boxplot.stats' method. 'linear': the interpolation method 'linear' as used by 'numpy.percentile' function 'lower': the interpolation method 'lower' as used by 'numpy.percentile' function 'higher': the interpolation method 'higher' as used by 'numpy.percentile' function 'nearest': the interpolation method 'nearest' as used by 'numpy.percentile' function 'midpoint': the interpolation method 'midpoint' as used by 'numpy.percentile' function

Default ​

ts
7

Inherited from ​

IBoxplotOptions.quantiles

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/data.ts:137

whiskersMode? ​

optional whiskersMode: "exact" | "nearest"

the method to compute the whiskers.

'nearest': with this mode computed whisker values will be replaced with nearest real data points 'exact': with this mode exact computed whisker values will be displayed on chart

Default ​

ts
'nearest'

Inherited from ​

IBoxplotOptions.whiskersMode

Source ​

work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/data.ts:146