@vx/stats

@vx/stats

npm install --save @vx/stats

BoxPlot

A boxplot shows the minimum, maximum, and quartiles of a dataset.

You can pass in props to target the min, max, median, and box (interquartile range) shapes using minProps, maxProps, medianProps, and boxProps.

If you are looking to add events over the each boxplot group you can pass in container={true} and containerProps={{ /** */ }}.

Properties

Name	Default	Type	Description
className		string	The className for the boxplot
left	0	number	The left offset of the boxplot
data		array	An array of data
max		number	The maximum value for boxplot
min		number	The minimum value for boxplot
firstQuartile		number	The value for the first quartile for the boxplot
thirdQuartile		number	The value for the third quartile for the boxplot
median		number	The median value for the boxplot
boxWidth		number	The width of the box
fill		string	The color of the box
fillOpacity		number	The opacity of the box
stroke		string	The color of the lines in boxplot
strokeWidth		number	Width of the lines in boxplot
rx	2	number	The x-axis radius for the box
ry	2	number	The y-axis radius for the box
container	false	boolean	Set to true and add containerProps = {{ /** */}} to add events to each boxplot group
maxProps	{}	object	Props passed to target the line shape for the maximum
minProps	{}	object	Props passed to target the line shape for the minimum
medianProps	{}	object	Props passed to target the line shape for the median
boxProps	{}	object	Props passed to target the rect shape for the box
containerProps	{}	object	Props passed to add events over each boxplot group (requires container={true})

Changelog

v0.0.181

For a summary and before + after of changes please see: https://github.com/hshoff/vx/pull/383

:boom: Breaking Changes

• [glyph][breaking] rm additionalProps, add children as fn
• [shape][breaking] rm additionalProps, add children as fn
• [geo][breaking] rm additionalProps, add children as fn
• [heatmap][breaking] rm additionalProps, add children as fn
• [stats][breaking] rm additionalProps, add children as fn
• [boxplot][breaking] rm additionalProps, add children as fn
• [voronoi][breaking] rm additionalProps, add children as fn
• [legend][breaking] rm additionalProps, add children as fn

:house: Internal

• [demo] update gallery tile examples to new apis

:trophy: Contributors

• hshoff

Changes:
 - @vx/annotation: 0.0.179 => 0.0.181
 - @vx/axis: 0.0.179 => 0.0.181
 - @vx/boxplot: 0.0.170 => 0.0.181
 - @vx/demo: 0.0.180 => 0.0.181
 - @vx/geo: 0.0.179 => 0.0.181
 - @vx/glyph: 0.0.179 => 0.0.181
 - @vx/grid: 0.0.180 => 0.0.181
 - @vx/heatmap: 0.0.179 => 0.0.181
 - @vx/hierarchy: 0.0.179 => 0.0.181
 - @vx/legend: 0.0.179 => 0.0.181
 - @vx/marker: 0.0.179 => 0.0.181
 - @vx/shape: 0.0.179 => 0.0.181
 - @vx/stats: 0.0.179 => 0.0.181
 - @vx/threshold: 0.0.179 => 0.0.181
 - @vx/voronoi: 0.0.170 => 0.0.181
 - @vx/vx: 0.0.180 => 0.0.181