VictoryArea

VictoryArea renders a dataset as a single area path. Since VictoryArea renders only a single element to represent a dataset rather than individual elements for each data point, some of its behavior is different from other Victory components. Pay special attention to style and events props, and take advantage of VictoryVoronoiContainer to enable tooltips. VictoryArea can be composed with VictoryChart to create area charts.

type: boolean || object

VictoryArea uses the standard animate prop. Read about it in detail

See the Animations Guide for more detail on animations and transitions

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

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

VictoryArea uses the standard categories prop. Read about it in detail

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

type: element

VictoryArea uses the standard containerComponent prop. Read about it in detail

containerComponent={<VictoryVoronoiContainer/>}

type: array[object]

VictoryArea uses the standard data prop. Read about it in detail

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

type: element

VictoryArea uses the standard dataComponent prop. Read about it detail

VictoryArea supplies the following props to its dataComponent: data, events, groupComponent, interpolation, origin (for polar charts), polar, scale, style

note: Because VictoryArea renders a single element to represent the entire dataset, the dataComponent it renders will not have access to datum like the dataComponent elements rendered by other Victory components such as VictoryScatter.

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

default: <Area/>

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

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

VictoryArea uses the standard domain prop. Read about it in detail

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

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

VictoryArea uses the standard domainPadding prop. Read about it in detail

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

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

VictoryArea uses the standard eventKey prop. This prop is not commonly used. Read about the eventKey prop in more detail here

note: VictoryArea only renders one element per dataset, so only one event key will be generated.

eventKey = "x";

type: array[object]

VictoryArea uses the standard events prop. Read about it in detail

See the Events Guide for more information on defining events.

note: VictoryArea will use the special eventKey "all" rather than referring to data by index, as it renders only one element for an entire dataset

type: array[object]

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

type: element

VictoryArea uses the standard groupComponent prop. Read about it in detail

note: VictoryArea uses VictoryClipContainer as its default groupComponent VictoryClipContainer renders a <g> tag with a clipPath def. This allows continuous data components to transition smoothly when new data points enter and exit. Supplying a custom groupComponent to VictoryArea may result in broken animations.

default: <VictoryClipContainer/>

type: number

VictoryArea uses the standard height prop. Read about it here

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

height={400}

type: boolean

VictoryArea uses the standard horizontal prop. Read about it in detail

type: options || function

The interpolation prop determines how data points should be connected when creating a path. Victory uses d3-shape for interpolating curves.

Polar area charts may use the following interpolation options: "basis", "cardinal", "catmullRom", "linear"

Cartesian area charts may use the following interpolation options: "basis", "cardinal", "catmullRom", "linear", "monotoneX", "monotoneY", "natural", "step", "stepAfter", "stepBefore"

You can also provide a function if you need to adjust parameters for d3-shape curves or to use a custom curve function.

Explore all the interpolation options.

default: "linear"

type: element

VictoryArea uses the standard labelComponent prop. Read about it in detail

note: To enable tooltips on VictoryArea, it is necessary to use VictoryVoronoiContainer

default: <VictoryLabel renderInPortal/>

type: array || function

VictoryArea uses the standard labels prop. Read about it here

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

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

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

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

VictoryArea uses the standard padding prop. Read about it here

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

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

type: boolean

VictoryArea uses the standard polar prop. Read about it here

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

VictoryArea uses the standard samples prop. Read about it here

default: samples={50}

samples={100}

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

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

VictoryArea uses the standard singleQuadrantDomainPadding prop. Read about it here

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

VictoryArea 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

VictoryArea uses the standard standalone prop. Read about it here

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

default: standalone={true}

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

VictoryArea uses the standard style prop. Read about it here

note: Since VictoryArea renders a single element to represent an entire dataset, it is not possible to use functional styles to change the style of the line as a function of an individual datum. Instead, try using gradient fills for styling continuous data.

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

type: object

VictoryArea 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

VictoryArea uses the standard width prop. Read about it here

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

width={400}

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

VictoryArea 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

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

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

VictoryArea uses the standard y0 data accessor prop to set a baseline. Read about it here

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