VictoryHistogram

VictoryHistogram renders a dataset as series of bars representing "bins", allowing the ability to view distribution of the data. The data passed in will be "binned" according to the bin prop that is provided (if any), allowing for flexibility in how these bins are determined. VictoryHistogram can be composed with VictoryChart to create histogram charts.

VictoryHistogram is intended to be used with quantitative data. Please use VictoryBar for qualitative or categorical data.

animate

type: boolean || object

VictoryHistogram 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 }
}}

bins

type: number || array[numbers] || array[dates]

default: undefined

VictoryHistogram uses d3.bin to do binning.

The bins prop is used to specify how the data will be binned. There are a few options for this, the first being passing no value, ie the default behavior, which is letting d3.bin generate the buckets based on the data. The second is passing a number, which specifies approximately the number of bins to generate, this is not a guarantee (see d3.bin for more details). The last options are passing an array of numbers or dates (depending on the data), this array represents an array of thresholds. So for example if the bin prop provided is [0, 10, 20, 35], this would result in 3 bins, that would look like [0, 10) , [10, 20), [20, 35].

This prop allows for a lot of flexibility in how the data is displayed. For example it is possible to have uneven sized bins if so desired. It is also possible to group the data by days, weeks, or years.

binSpacing

type: number

The binSpacing prop is used to specify space between each bin. binSpacing represents the number of pixels that will be between each bin (including at the beginning and end of the bins). By default, bins are rendered with no spacing.

containerComponent

type: element

VictoryHistogram uses the standard containerComponent prop. Read about it here

containerComponent={<VictoryVoronoiContainer/>}

cornerRadius

type: function || number || { top, bottom, topLeft, topRight, bottomLeft, bottomRight }

The cornerRadius prop specifies a radius to apply to each bar. If this prop is given as a single number, the radius will only be applied to the top of each bar. When this prop is given as a function, it will be evaluated for each bar with the props object corresponding to that bar.

data

type: array[object]

VictoryHistogram uses the standard data prop, except for it only expects each object within the array to have x properties. The x data accessor prop can be used to defined a custom data format. Read about it here

Because each bar represents a bin rather than a particular data point (like with VictoryScatter for example), when accessing datum via a prop that passes datum such as style, datum will have properties x, x0, x1, y, and binnedData. x is the midpoint between the bin, x0 is the beginning of the bin, x1 is the end of the bin, y is the aggregate amount of data points within that bin, and binnedData is an array of the original data points that were grouped into this bin.

VictoryHistogram is intended to be used with quantitative data. Please use VictoryBar for qualitative or categorical data.

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

dataComponent

type: element

VictoryHistogram uses the standard dataComponent prop. Read about it here

VictoryHistogram supplies the following props to its dataComponent: barWidth, cornerRadius, data, datum, horizontal, index, padding, origin, scale, style, width, height, x, y, y0, x0.

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

default: <Bar />

dataComponent={<Bar events={{ onClick: handleClick }}/>}

domain

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

VictoryHistogram uses the standard domain prop. Read about it here

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

domainPadding

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

VictoryHistogram uses the standard domainPadding prop. Read about it here

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

eventKey

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

VictoryHistogram 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";

events

type: array[object]

VictoryHistogram uses the standard events prop. Read about it here

See the Events Guide for more information on defining events.

externalEventMutations

type: array[object]

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

groupComponent

type: element

VictoryHistogram uses the standard groupComponent prop. Read about it here

default: <g/>

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

height

type: number

VictoryHistogram uses the standard height prop. Read about it here

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

height={400}

horizontal

type: boolean

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

default: horizontal={false}

labelComponent

type: element

VictoryHistogram uses the standard labelComponent prop. Read about it here

default: <VictoryLabel/>

labels

type: array || function

VictoryHistogram uses the standard labels prop. Read about it here

maxDomain

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

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

minDomain

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

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

name

type: string

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

name = "series-1";

padding

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

VictoryHistogram uses the standard padding prop. Read about it here

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

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

polar

type: boolean

note: Polar Charts are not yet supported for VictoryHistogram

range

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

scale

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

VictoryHistogram 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"}}

sharedEvents

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

singleQuadrantDomainPadding

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

VictoryHistogram uses the standard singleQuadrantDomainPadding prop. Read about it here

sortKey

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

VictoryHistogram uses the standard sortKey prop. Read about it here

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

sortKey = "x";

sortOrder

type: "ascending" || "descending"

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

default: sortOrder="ascending"

standalone

type: boolean

VictoryHistogram uses the standard standalone prop. Read about it here

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

default: standalone={true}

style

type: { parent: object, data: object, labels: object }

VictoryHistogram uses the standard style prop. Read about it here

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

theme

type: object

VictoryHistogram 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}

width

type: number

VictoryHistogram uses the standard width prop. Read about it here

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

width={400}

x

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

VictoryHistogram 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";