chartjs-chart-boxplot

Appearance

chartjs-chart-boxplot / BoxPlotControllerDatasetOptions

Interface: BoxPlotControllerDatasetOptions ​

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/controllers/BoxPlotController.ts:71

Extends ​

  • ControllerDatasetOptions.Pick<BarControllerDatasetOptions, "barPercentage" | "barThickness" | "categoryPercentage" | "maxBarThickness" | "minBarLength">.IBoxplotOptions.ScriptableAndArrayOptions<IBoxAndWhiskersOptions, ScriptableContext<"boxplot">>.ScriptableAndArrayOptions<CommonHoverOptions, ScriptableContext<"boxplot">>.AnimationOptions<"boxplot">

Properties ​

backgroundColor ​

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

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

Default ​

ts
see rectangle
scriptable
indexable

Inherited from ​

IStatsBaseOptions.backgroundColor

borderColor ​

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

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

Default ​

ts
see rectangle
scriptable
indexable

Inherited from ​

IStatsBaseOptions.borderColor

borderWidth ​

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

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

Default ​

ts
1
scriptable
indexable

Inherited from ​

IStatsBaseOptions.borderWidth

coef? ​

optional coef: number

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

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

hitPadding ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:133

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

Default ​

ts
2
scriptable
indexable

Inherited from ​

IStatsBaseOptions.hitPadding

itemBackgroundColor ​

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

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

background color for items

Default ​

ts
see rectangle.backgroundColor
scriptable
indexable

Inherited from ​

IStatsBaseOptions.itemBackgroundColor

itemBorderColor ​

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

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

border color for items

Default ​

ts
see rectangle.borderColor
scriptable
indexable

Inherited from ​

IStatsBaseOptions.itemBorderColor

itemBorderWidth ​

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

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

border width for items

Default ​

ts
0
scriptable
indexable

Inherited from ​

IStatsBaseOptions.itemBorderWidth

itemHitRadius ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:125

hit radius for hit test of items

Default ​

ts
0
scriptable
indexable

Inherited from ​

IStatsBaseOptions.itemHitRadius

itemRadius ​

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

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

radius used to render items

Default ​

ts
0 so disabled
scriptable
indexable

Inherited from ​

IStatsBaseOptions.itemRadius

itemStyle ​

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

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

item style used to render items

Default ​

ts
circle

Inherited from ​

IStatsBaseOptions.itemStyle

lowerBackgroundColor ​

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

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

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

Default ​

ts
'transparent' takes the current borderColor
scriptable
indexable

Inherited from ​

IBoxAndWhiskersOptions.lowerBackgroundColor

maxStats? ​

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

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

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

Default ​

ts
'max'

Inherited from ​

IBoxplotOptions.maxStats

meanBackgroundColor ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:173

background color for mean dot

Default ​

ts
see rectangle.backgroundColor
scriptable
indexable

Inherited from ​

IStatsBaseOptions.meanBackgroundColor

meanBorderColor ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:181

border color for mean dot

Default ​

ts
see rectangle.borderColor
scriptable
indexable

Inherited from ​

IStatsBaseOptions.meanBorderColor

meanBorderWidth ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:189

border width for mean dot

Default ​

ts
0
scriptable
indexable

Inherited from ​

IStatsBaseOptions.meanBorderWidth

meanRadius ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:165

radius used to mean dots

Default ​

ts
3
scriptable
indexable

Inherited from ​

IStatsBaseOptions.meanRadius

meanStyle ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:147

item style used to render mean dot

Default ​

ts
circle

Inherited from ​

IStatsBaseOptions.meanStyle

medianColor ​

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

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

separate color for the median line

Default ​

ts
'transparent' takes the current borderColor
scriptable
indexable

Inherited from ​

IBoxAndWhiskersOptions.medianColor

minStats? ​

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

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

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

Default ​

ts
'min'

Inherited from ​

IBoxplotOptions.minStats

outlierBackgroundColor ​

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

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

Default ​

ts
see rectangle.backgroundColor
scriptable
indexable

Inherited from ​

IStatsBaseOptions.outlierBackgroundColor

outlierBorderColor ​

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

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

Default ​

ts
see rectangle.borderColor
scriptable
indexable

Inherited from ​

IStatsBaseOptions.outlierBorderColor

outlierBorderWidth ​

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

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

Default ​

ts
1
scriptable
indexable

Inherited from ​

IStatsBaseOptions.outlierBorderWidth

outlierHitRadius ​

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

Defined in: work/chartjs-chart-boxplot/chartjs-chart-boxplot/src/elements/base.ts:141

hit radius for hit test of outliers

Default ​

ts
4
scriptable
indexable

Inherited from ​

IStatsBaseOptions.outlierHitRadius

outlierRadius ​

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

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

radius used to render outliers

Default ​

ts
2
scriptable
indexable

Inherited from ​

IStatsBaseOptions.outlierRadius

outlierStyle ​

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

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

item style used to render outliers

Default ​

ts
circle

Inherited from ​

IStatsBaseOptions.outlierStyle

quantiles? ​

optional quantiles: QuantileMethod

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

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

whiskersMode? ​

optional whiskersMode: "exact" | "nearest"

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

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