VictoryBoxPlot

VictoryBoxPlot renders a box plot to describe the distribution of a set of data. Data for VictoryBoxPlot may be given with summary statistics pre-calculated (min, median, max, q1, q3), or as an array of raw data. VictoryBoxPlot can be composed with VictoryChart to create box plot charts.

type: boolean || object

VictoryBoxPlot uses the standard animate prop. Read about it here

See the Animations Guide for more detail on animations and transitions

animate={{
  duration: 2000,
  onLoad: { duration: 1000 }
}}

type: number

The boxWidth prop specifies how wide each box should be. If the whiskerWidth prop is not set, this prop will also determine the width of the whisker crosshair.

type: array[string] || { x: array[string], y: array[string] }

VictoryBoxPlot uses the standard categories prop. Read about it here

categories={{ x: ["dogs", "cats", "mice"] }}

type: element

VictoryBoxPlot uses the standard containerComponent prop. Read about it here

containerComponent={<VictoryVoronoiContainer/>}

type: array[object]

The data prop for VictoryBoxPlot may be given in a a variety of formats:

• As an array of standard data objects with values specified for x and y When given in this format, repeated values for x will be used for calculating summary statistics

data={[
  { x: 1, y: 2 },
  { x: 1, y: 3 },
  { x: 1, y: 5 },
  { x: 2, y: 1 },
  { x: 2, y: 4 },
  { x: 2, y: 5 },
  ...
]}

• As an array of data objects where y is given as an array of values When given in this format, array values are used for calculating summary statistics.

data={[
  { x: 1, y: [1, 2, 3, 5] },
  { x: 2, y: [3, 2, 8, 10] },
  { x: 3, y: [2, 8, 6, 5] },
  { x: 4, y: [1, 3, 2, 9] }
]}

• As an array of data objects with pre-calculated summary statistics(min, median, max, q1, q3) When given in this format, VictoryBoxPlot will not perform statistical analysis. Pre-calculating summary statistics for large datasets will improve performance.

data={[
  { x: 1, min: 2, median: 5, max: 10, q1: 3, q3: 7 },
  { x: 2, min: 1, median: 4, max: 9, q1: 3, q3: 6 },
  { x: 3, min: 1, median: 6, max: 12, q1: 4, q3: 10 },

Use the x, y, min, max, median, q1, and q3 data accessor props to specify custom data formats. Refer to the Data Accessors Guide for more detail.

type: array[low, high] || { x: [low, high], y: [low, high] }

VictoryBoxPlot uses the standard domain prop. Read about it here

domain={{x: [0, 100], y: [0, 1]}}

type: number || array[left, right] || { x: [left, right], y: [bottom, top] }

VictoryBoxPlot uses the standard domainPadding prop. Read about it here

domainPadding={{x: [10, -10], y: 5}}

type: string || integer || array[string] || function

VictoryBoxPlot uses the standard eventKey prop to specify how event targets are addressed. This prop is not commonly used. Read about the eventKey prop in more detail here

eventKey = "x";

type array[object]

VictoryBoxPlot uses the standard events prop. Read about it here

See the Events Guide for more information on defining events.

note: valid event targets for VictoryBoxPlot are: "min", "minLabels", "grid", "ticks", and "tickLabels".

type: array[object]

VictoryBoxPlot uses the standard externalEventMutations prop. Read about it in detail

type: element

VictoryBoxPlot uses the standard groupComponent prop. Read about it here

default: <g/>

groupComponent={<g transform="translate(10, 10)" />}

type: number

VictoryBoxPlot uses the standard height prop. Read about it here

default (provided by default theme): height={300}

height={400}

type: boolean

The horizontal prop determines whether boxes will be laid vertically or horizontally. The boxes will be vertical if this prop is false or unspecified, or horizontal if the prop is set to true.

type: "top" || "bottom" || "left" || "right" || { min, max, median, q1, q3 }

The labelOrientation prop determines where labels are placed relative to their corresponding data. If this prop is not set, it will be set to "top" for horizontal charts, and "right" for vertical charts.

type: boolean

When the boolean labels prop is set to true, the values for min, max, median, q1, and q3 will be displayed for each box. For more granular label control, use the individual minLabels, maxLabels, medianLabels, q1Labels, and q3Labels props.

type: string || array[string] || function

Use the max data accessor prop to define the max value of a box plot.

string: specify which property in an array of data objects should be used as the max value

examples: max="max_value"

function: use a function to translate each element in a data array into a max value

examples: max={() => 10}

path string or path array: specify which property in an array of nested data objects should be used as a max value

examples: max="bonds.max", max={["bonds", "max"]}

type: element

The maxComponent prop takes a component instance which will be responsible for rendering an element to represent the maximum value of the box plot. The new element created from the passed maxComponent will be provided with the following props calculated by VictoryBoxPlot: datum, index, scale, style, events, majorWhisker and minorWhisker. The majorWhisker and minorWhisker props are given as objects with values for x1, y1, x2 and y2 that describes the lines that make up the major and minor whisker. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If a maxComponent is not provided, VictoryBoxPlot will use its default Whisker component.

See the Custom Components Guide for more detail on creating your own components

default: maxComponent={<Whisker/>}

maxComponent={<Whisker events={{ onClick: handleClick }}/>}

type: element

The maxLabelComponent prop takes a component instance which will be used to render the label corresponding to the maximum value for each box. The new element created from the passed maxLabelComponent will be supplied with the following props: x, y, datum, index, scale, verticalAnchor, textAnchor, angle, transform, style and events. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If maxLabelComponent is omitted, a new VictoryLabel will be created with props described above.

See the Custom Components Guide for more detail on creating your own components

default: maxLabelComponent={<VictoryLabel/>}

maxLabelComponent={<VictoryLabel dy={20}/>}

type: array || function || boolean

The maxLabels prop defines the labels that will appear above each point. This prop should be given as a boolean, an array or as a function of the props corresponding to that label. When given as a boolean value, the max value of each datum will be used for the label.

examples:

• maxLabels
• maxLabels={["first", "second", "third"]}
• maxLabels={({ datum }) => Math.round(datum.max)}

type: number || { x: number, y: number }

VictoryBoxPlot uses the standard maxDomain prop. Read about it in detail

type: string || array[string] || function

Use the median data accessor prop to define the median value of a box plot.

string: specify which property in an array of data objects should be used as the median value

examples: median="median_value"

function: use a function to translate each element in a data array into a median value

examples: median={() => 10}

path string or path array: specify which property in an array of nested data objects should be used as a median value

examples: median="bonds.median", median={["bonds", "median"]}

type: element

The medianComponent prop takes a component instance which will be responsible for rendering an element to represent the median value of the box plot. The new element created from the passed medianComponent will be provided with the following props calculated by VictoryBoxPlot: datum, index, scale, style, events, x1, y1, x2 and y2 Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If a medianComponent is not provided, VictoryBoxPlot will use its default Line component.

See the Custom Components Guide for more detail on creating your own components

default: medianComponent={<LineSegment/>}

medianComponent={<LineSegment events={{ onClick: handleClick }}/>}

type: element

The medianLabelComponent prop takes a component instance which will be used to render the label corresponding to the median value for each box. The new element created from the passed medianLabelComponent will be supplied with the following props: x, y, datum, index, scale, verticalAnchor, textAnchor, angle, transform, style and events. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If medianLabelComponent is omitted, a new VictoryLabel will be created with props described above.

See the Custom Components Guide for more detail on creating your own components

default: medianLabelComponent={<VictoryLabel/>}

medianLabelComponent={<VictoryLabel dy={20}/>}

type: array || function || boolean

The medianLabels prop defines the labels that will appear above each point. This prop should be given as a boolean, an array or as a function of the props corresponding to that label. When given as a boolean value, the median value of each datum will be used for the label.

examples:

• medianLabels
• medianLabels={["first", "second", "third"]}
• medianLabels={({ datum }) => Math.round(datum.median)}

type: string || array[string] || function

Use the min data accessor prop to define the min value of a box plot.

string: specify which property in an array of data objects should be used as the min value

examples: min="min_value"

function: use a function to translate each element in a data array into a min value

examples: min={() => 10}

path string or path array: specify which property in an array of nested data objects should be used as a min value

examples: min="bonds.min", min={["bonds", "min"]}

type: element

The minComponent prop takes a component instance which will be responsible for rendering an element to represent the minimum value of the box plot. The new element created from the passed minComponent will be provided with the following props calculated by VictoryBoxPlot: datum, index, scale, style, events, majorWhisker and minorWhisker. The majorWhisker and minorWhisker props are given as objects with values for x1, y1, x2 and y2 that describes the lines that make up the major and minor whisker. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If a minComponent is not provided, VictoryBoxPlot will use its default Whisker component.

See the Custom Components Guide for more detail on creating your own components

default: minComponent={<Whisker/>}

minComponent={<Whisker events={{ onClick: handleClick }}/>}

type: element

The minLabelComponent prop takes a component instance which will be used to render the label corresponding to the minimum value for each box. The new element created from the passed minLabelComponent will be supplied with the following props: x, y, datum, index, scale, verticalAnchor, textAnchor, angle, transform, style and events. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If minLabelComponent is omitted, a new VictoryLabel will be created with props described above.

See the Custom Components Guide for more detail on creating your own components

default: minLabelComponent={<VictoryLabel/>}

minLabelComponent={<VictoryLabel dy={20}/>}

type: array || function || boolean

The minLabels prop defines the labels that will appear above each point. This prop should be given as a boolean, an array or as a function of the props corresponding to that label. When given as a boolean value, the min value of each datum will be used for the label.

examples:

• minLabels
• minLabels={["first", "second", "third"]}
• minLabels={({ datum }) => Math.round(datum.min)}

type: number || { x: number, y: number }

VictoryBoxPlot uses the standard minDomain prop. Read about it in detail

type: string

The name prop is used to reference a component instance when defining shared events.

name = "series-1";

type: { x: number, y: number }

The origin prop is only used by polar charts, and is usually controlled by VictoryChart. It will not typically be necessary to set an origin prop manually

Read about the origin prop in detail

type: number || { top: number, bottom: number, left: number, right: number }

VictoryBoxPlot uses the standard padding prop. Read about it here

default (provided by default theme): padding={50}

padding={{ top: 20, bottom: 60 }}

type: boolean

VictoryBoxPlot uses the standard polar prop. Read about it here

note: Polar Charts are not yet supported for VictoryBoxPlot

type: string || array[string] || function

Use the q1 data accessor prop to define the q1 value of a box plot.

string: specify which property in an array of data objects should be used as the q1 value

examples: q1="q1_value"

function: use a function to translate each element in a data array into a q1 value

examples: q1={() => 10}

path string or path array: specify which property in an array of nested data objects should be used as a q1 value

examples: q1="bonds.q1", q1={["bonds", "q1"]}

type: element

The q1Component prop takes a component instance which will be responsible for rendering an element to represent the q1 value of the box plot. The new element created from the passed q1Component will be provided with the following props calculated by VictoryBoxPlot: datum, index, scale, style, events, x, y, width and height Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If a q1Component is not provided, VictoryBoxPlot will use its default Box component.

See the Custom Components Guide for more detail on creating your own components

default: q1Component={<Box/>}

q1Component={<Box events={{ onClick: handleClick }}/>}

type: element

The q1LabelComponent prop takes a component instance which will be used to render the label corresponding to the q1 value for each box. The new element created from the passed q1LabelComponent will be supplied with the following props: x, y, datum, index, scale, verticalAnchor, textAnchor, angle, transform, style and events. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If q1LabelComponent is omitted, a new VictoryLabel will be created with props described above.

See the Custom Components Guide for more detail on creating your own components

default: q1LabelComponent={<VictoryLabel/>}

q1LabelComponent={<VictoryLabel dy={20}/>}

type: array || function || boolean

The q1Labels prop defines the labels that will appear above each point. This prop should be given as a boolean, an array or as a function of the props corresponding to that label. When given as a boolean value, the q1 value of each datum will be used for the label.

examples:

• q1Labels
• q1Labels={["first", "second", "third"]}
• q1Labels={({ datum }) => Math.round(datum.q1)}

type: string || array[string] || function

Use the q3 data accessor prop to define the q3 value of a box plot.

string: specify which property in an array of data objects should be used as the q3 value

examples: q3="q3_value"

function: use a function to translate each element in a data array into a q3 value

examples: q3={() => 10}

path string or path array: specify which property in an array of nested data objects should be used as a q3 value

examples: q3="bonds.q3", q3={["bonds", "q3"]}

type: element

The q3Component prop takes a component instance which will be responsible for rendering an element to represent the q3 value of the box plot. The new element created from the passed q3Component will be provided with the following props calculated by VictoryBoxPlot: datum, index, scale, style, events, x, y, width and height Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If a q3Component is not provided, VictoryBoxPlot will use its default Box component.

See the Custom Components Guide for more detail on creating your own components

default: q3Component={<Box/>}

q3Component={<Box events={{ onClick: handleClick }}/>}

type: element

The q3LabelComponent prop takes a component instance which will be used to render the label corresponding to the q3 value for each box. The new element created from the passed q3LabelComponent will be supplied with the following props: x, y, datum, index, scale, verticalAnchor, textAnchor, angle, transform, style and events. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If q3LabelComponent is omitted, a new VictoryLabel will be created with props described above.

See the Custom Components Guide for more detail on creating your own components

default: q3LabelComponent={<VictoryLabel/>}

q3LabelComponent={<VictoryLabel dy={20}/>}

type: array || function || boolean

The q3Labels prop defines the labels that will appear above each point. This prop should be given as a boolean, an array or as a function of the props corresponding to that label. When given as a boolean value, the q3 value of each datum will be used for the label.

examples:

• q3Labels
• q3Labels={["first", "second", "third"]}
• q3Labels={({ datum }) => Math.round(datum.q3)}

type: array[low, high] || { x: [low, high], y: [low, high] }

The range prop is usually controlled by VictoryChart. It will not typically be necessary to set a range prop manually

Read about the range prop in detail

type: number

VictoryBoxPlot uses the standard samples prop. Read about it here

default: samples={50}

samples={100}

type: scale || { x: scale, y: scale }

VictoryBoxPlot uses the standard scale prop. Read about it here Options for scale include "linear", "time", "log", "sqrt" and the d3-scale functions that correspond to these options.

default: scale="linear"

scale={{x: "linear", y: "log"}}

The sharedEvents prop is used internally to coordinate events between components. It should not be set manually.

type: boolean || { x: boolean, y: boolean }

VictoryBoxPlot uses the standard singleQuadrantDomainPadding prop. Read about it here

type: string || integer || array[string] || function

VictoryBoxPlot uses the standard sortKey prop. Read about it here

See the Data Accessors Guide for more detail on formatting and processing data.

sortKey = "x";

type: "ascending" || "descending"

The sortOrder prop specifies whether sorted data should be returned in ascending or descending order.

default: sortOrder="ascending"

type: boolean

VictoryBoxPlot uses the standard standalone prop. Read about it here

note: When VictoryBoxPlot is nested within a component like VictoryChart, this prop will be set to false

default: standalone={true}

type: {
  parent: object,
  max: object,
  maxLabels: object,
  min: object,
  minLabels: object,
  median: object,
  medianLabels: object,
  q1: object,
  q1Labels: object,
  q3: object,
  q3Labels: object
}

The style prop defines the style of the component. The style prop should be given as an object with styles defined for parent, max, maxLabels, min, minLabels,median, medianLabels,q1, q1Labels,q3, q3Labels. Any valid svg styles are supported, but width, height, and padding should be specified via props as they determine relative layout for components in VictoryChart. Functional styles may be defined for style properties, and they will be evaluated with the props corresponding to each element.

note: When a component is rendered as a child of another Victory component, or within a custom <svg> element with standalone={false} parent styles will be applied to the enclosing <g> tag. Many styles that can be applied to a parent <svg> will not be expressed when applied to a <g>.

note: custom angle and verticalAnchor properties may be included in labels styles.

default (provided by default theme): See grayscale theme for more detail

type: object

VictoryBoxPlot uses the standard theme prop. Read about it here

See the Themes Guide for information about creating custom themes.

default: theme={VictoryTheme.grayscale}

theme={VictoryTheme.material}

type: number

The whiskerWidth prop specifies how wide each whisker crosshair should be. If the whiskerWidth prop is not set, the width of the whisker crosshair will match the width of the box.

type: number

VictoryBoxPlot uses the standard width prop. Read about it here

default (provided by default theme): width={450}

width={400}

type: string || integer || array[string] || function

VictoryBoxPlot uses the standard x data accessor prop. Read about it here

See the Data Accessors Guide for more detail on formatting and processing data.

x = "employee.name";

type: string || integer || array[string] || function

VictoryBoxPlot uses the standard y data accessor prop. Read about it here

See the Data Accessors Guide for more detail on formatting and processing data.

y={(d) => d.value + d.error}