Sparkline chart
IntroductionExamplesDocumentationPropsIntroduction
Note: PatternFly React charts live in its own package at @patternfly/react-charts!
PatternFly React charts are based on the Victory chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
Learn to build a sparkline chart using a Katacoda tutorial starting with a simple chart, adding tooltips, and concluding by changing the theme color. You'll learn how to use React chart components together to build a consistent user experience.
Examples
Documentation
Tips
- See Victory's FAQ
- For single data points or zero values, you may want to set the
domainprop - Use
ChartGroupin place ofChartwhen an axis and labels are not desired - Themes are inherited, so a default theme may override
themeColorfor a child component - The
themeandthemeColorprops should be applied at the most top level component
Note
Currently, the generated documention below is not able to resolve type definitions from Victory imports. For the components used in the examples above, Victory pass-thru props are also documented here:
- For
ChartAreaprops, see VictoryArea - For
ChartGroupprops, see VictoryGroup - For
ChartLabelprops, see VictoryLabel - For
ChartVoronoiContainerprops, see VictoryVoronoiContainer
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| animate | AnimatePropTypeInterface | No | type: boolean || object The animate prop specifies props for VictoryAnimation to use. The animate prop should also be used to specify enter and exit transition configurations with the `onExit` and `onEnter` namespaces respectively. @example {duration: 500, onExit: () => {}, onEnter: {duration: 500, before: () => ({y: 0})})} | |
| categories | CategoryPropType | No | The categories prop specifies how categorical data for a chart should be ordered. This prop should be given as an array of string values, or an object with these arrays of values specified for x and y. If this prop is not set, categorical data will be plotted in the order it was given in the data array @example ["dogs", "cats", "mice"] | |
| containerComponent | React.ReactElement<any> | No | <ChartContainer /> | The containerComponent prop takes an entire component which will be used to create a container element for standalone charts. The new element created from the passed containerComponent wil be provided with these props from ChartArea: height, width, children (the chart itself) and style. Props that are not provided by the child chart component include title and desc, both of which are intended to add accessibility to Victory components. The more descriptive these props are, the more accessible your data will be for people using screen readers. 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 dataComponent is not provided, ChartArea will use the default ChartContainer component. @example <ChartContainer title="Chart of Dog Breeds" desc="This chart shows..." /> |
| data | any[] | No | The data prop specifies the data to be plotted. Data should be in the form of an array of data points, or an array of arrays of data points for multiple datasets. Each data point may be any format you wish (depending on the `x` and `y` accessor props), but by default, an object with x and y properties is expected. @example [{x: 1, y: 2}, {x: 2, y: 3}], [[1, 2], [2, 3]], [[{x: "a", y: 1}, {x: "b", y: 2}], [{x: "a", y: 2}, {x: "b", y: 3}]] | |
| dataComponent | React.ReactElement<any> | No | The dataComponent prop takes an entire component which will be used to create an area. The new element created from the passed dataComponent will be provided with the following properties calculated by ChartArea: a scale, style, events, interpolation, and an array of modified data objects (including x, y, and calculated y0 and y1). 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 dataComponent is not provided, ChartArea will use its default Area component. | |
| domain | DomainPropType | No | The domain prop describes the range of values your chart will cover. This prop can be given as a array of the minimum and maximum expected values for your bar chart, or as an object that specifies separate arrays for x and y. If this prop is not provided, a domain will be calculated from data, or other available information. @example [-1, 1], {x: [0, 100], y: [0, 1]} | |
| domainPadding | DomainPaddingPropType | No | The domainPadding prop specifies a number of pixels of padding to add to the beginning and end of a domain. This prop is useful for explicitly spacing ticks farther from the origin to prevent crowding. This prop should be given as an object with numbers specified for x and y. | |
| eventKey | StringOrNumberOrCallback | No | Similar to data accessor props `x` and `y`, this prop may be used to functionally assign eventKeys to data | |
| events | EventPropTypeInterface<'data' | 'labels' | 'parent', 'all'>[] | No | The event prop take an array of event objects. Event objects are composed of a target, an eventKey, and eventHandlers. Targets may be any valid style namespace for a given component, so "data" and "labels" are all valid targets for ChartArea events. Since ChartArea only renders a single element, the eventKey property is not used. The eventHandlers object should be given as an object whose keys are standard event names (i.e. onClick) and whose values are event callbacks. The return value of an event handler is used to modify elemnts. The return value should be given as an object or an array of objects with optional target and eventKey keys, and a mutation key whose value is a function. The target and eventKey keys will default to those corresponding to the element the event handler was attached to. The mutation function will be called with the calculated props for the individual selected element (i.e. an area), and the object returned from the mutation function will override the props of the selected element via object assignment. @example events={[ { target: "data", eventHandlers: { onClick: () => { return [ { mutation: (props) => { return {style: merge({}, props.style, {fill: "orange"})}; } }, { target: "labels", mutation: () => { return {text: "hey"}; } } ]; } } } ]} | |
| externalEventMutations | any[] | No | ChartArea uses the standard externalEventMutations prop. | |
| groupComponent | React.ReactElement<any> | No | The groupComponent prop takes an entire component which will be used to create group elements for use within container elements. This prop defaults to a <g> tag on web, and a react-native-svg <G> tag on mobile | |
| height | number | No | The height props specifies the height the svg viewBox of the chart container. This value should be given as a number of pixels | |
| horizontal | boolean | No | The horizontal prop determines whether data will be plotted horizontally. When this prop is set to true, the independent variable will be plotted on the y axis and the dependent variable will be plotted on the x axis. | |
| interpolation | InterpolationPropType | No | The interpolation prop determines how data points should be connected when plotting a line | |
| labelComponent | React.ReactElement<any> | No | The labelComponent prop takes in an entire label component which will be used to create a label for the area. The new element created from the passed labelComponent will be supplied with the following properties: x, y, index, data, verticalAnchor, textAnchor, angle, style, text, 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 labelComponent is omitted, a new ChartLabel will be created with props described above. This labelComponent prop should be used to provide a series label for ChartArea. If individual labels are required for each data point, they should be created by composing ChartArea with VictoryScatter | |
| labels | string[] | number[] | Function | No | The labels prop defines labels that will appear above each bar in your chart. This prop should be given as an array of values or as a function of data. If given as an array, the number of elements in the array should be equal to the length of the data array. Labels may also be added directly to the data object like data={[{x: 1, y: 1, label: "first"}]}. @example ["spring", "summer", "fall", "winter"], (datum) => datum.title | |
| maxDomain | number | { x?: number; y?: number } | No | The maxDomain prop defines a maximum domain value for a chart. This prop is useful in situations where the maximum domain of a chart is static, while the minimum value depends on data or other variable information. If the domain prop is set in addition to maximumDomain, domain will be used. note: The x value supplied to the maxDomain prop refers to the independent variable, and the y value refers to the dependent variable. This may cause confusion in horizontal charts, as the independent variable will corresponds to the y axis. examples: maxDomain={0} maxDomain={{ y: 0 }} | |
| minDomain | number | { x?: number; y?: number } | No | The minDomain prop defines a minimum domain value for a chart. This prop is useful in situations where the minimum domain of a chart is static, while the maximum value depends on data or other variable information. If the domain prop is set in addition to minimumDomain, domain will be used. note: The x value supplied to the minDomain prop refers to the independent variable, and the y value refers to the dependent variable. This may cause confusion in horizontal charts, as the independent variable will corresponds to the y axis. examples: minDomain={0} minDomain={{ y: 0 }} | |
| name | string | No | The name prop is used to reference a component instance when defining shared events. | |
| origin | { x: number; y: number } | No | Victory components will pass an origin prop is to define the center point in svg coordinates for polar charts. **This prop should not be set manually.** | |
| padding | PaddingProps | No | The padding props specifies the amount of padding in number of pixels between the edge of the chart and any rendered child components. This prop can be given as a number or as an object with padding specified for top, bottom, left and right. | |
| polar | boolean | No | Victory components can pass a boolean polar prop to specify whether a label is part of a polar chart. **This prop should not be set manually.** | |
| range | [number, number] | { x?: [number, number]; y?: [number, number] } | No | The range prop describes the dimensions over which data may be plotted. For cartesian coordinate systems, this corresponds to minimum and maximum svg coordinates in the x and y dimension. In polar coordinate systems this corresponds to a range of angles and radii. When this value is not given it will be calculated from the width, height, and padding, or from the startAngle and endAngle in the case of polar charts. All components in a given chart must share the same range, so setting this prop on children nested within Chart or ChartGroup will have no effect. This prop is usually not set manually. examples: Cartesian: range={{ x: [50, 250], y: [50, 250] }} Polar: range={{ x: [0, 360], y: [0, 250] }} | |
| samples | number | No | The samples prop specifies how many individual points to plot when plotting y as a function of x. Samples is ignored if x props are provided instead. | |
| scale | ScalePropType | D3Scale | { x?: ScalePropType | D3Scale; y?: ScalePropType | D3Scale; } | No | The scale prop determines which scales your chart should use. This prop can be given as a string specifying a supported scale ("linear", "time", "log", "sqrt"), as a d3 scale function, or as an object with scales specified for x and y @example d3Scale.time(), {x: "linear", y: "log"} | |
| sharedEvents | any | No | The sharedEvents prop is used internally to coordinate events between components. It should not be set manually. | |
| singleQuadrantDomainPadding | boolean | { x: boolean; y: boolean } | No | By default domainPadding is coerced to existing quadrants. This means that if a given domain only includes positive values, no amount of padding applied by domainPadding will result in a domain with negative values. This is the desired behavior in most cases. For users that need to apply padding without regard to quadrant, the singleQuadrantDomainPadding prop may be used. This prop may be given as a boolean or an object with boolean values specified for "x" and/or "y". When this prop is false (or false for a given dimension), padding will be applied without regard to quadrant. If this prop is not specified, domainPadding will be coerced to existing quadrants. note: The x value supplied to the singleQuadrantDomainPadding prop refers to the independent variable, and the y value refers to the dependent variable. This may cause confusion in horizontal charts, as the independent variable will corresponds to the y axis. examples: singleQuadrantDomainPadding={false} singleQuadrantDomainPadding={{ x: false }} | |
| sortKey | string | string[] | Function | No | Use the sortKey prop to indicate how data should be sorted. This prop is given directly to the lodash sortBy function to be executed on the final dataset. | |
| sortOrder | 'ascending' | 'descending' | No | The sortOrder prop specifies whether sorted data should be returned in ascending or descending order. | |
| standalone | boolean | No | The standalone prop determines whether the component will render a standalone svg or a <g> tag that will be included in an external svg. Set standalone to false to compose ChartArea with other components within an enclosing <svg> tag. | |
| style | VictoryStyleInterface | No | The style prop specifies styles for your ChartArea. Any valid inline style properties will be applied. Height, width, and padding should be specified via the height, width, and padding props, as they are used to calculate the alignment of components within chart. @example {data: {fill: "red"}, labels: {fontSize: 12}} | |
| theme | ChartThemeDefinition | No | getTheme(themeColor, themeVariant) | The theme prop takes a style object with nested data, labels, and parent objects. You can create this object yourself, or you can use a theme provided by When using ChartArea as a solo component, implement the theme directly on ChartArea. If you are wrapping ChartArea in ChartChart or ChartGroup, please call the theme on the outermost wrapper component instead. |
| themeColor | string | No | Specifies the theme color. Valid values are 'blue', 'green', 'multi', etc. Note: Not compatible with theme prop @example themeColor={ChartThemeColor.blue} | |
| themeVariant | string | No | Specifies the theme variant. Valid values are 'dark' or 'light' Note: Not compatible with theme prop @example themeVariant={ChartThemeVariant.light} | |
| width | number | No | The width props specifies the width of the svg viewBox of the chart container This value should be given as a number of pixels | |
| x | DataGetterPropType | No | The x prop specifies how to access the X value of each data point. If given as a function, it will be run on each data point, and returned value will be used. If given as an integer, it will be used as an array index for array-type data points. If given as a string, it will be used as a property key for object-type data points. If given as an array of strings, or a string containing dots or brackets, it will be used as a nested object property path (for details see Lodash docs for _.get). If `null` or `undefined`, the data value will be used as is (identity function/pass-through). @example 0, 'x', 'x.value.nested.1.thing', 'x[2].also.nested', null, d => Math.sin(d) | |
| y | DataGetterPropType | No | The y prop specifies how to access the Y value of each data point. If given as a function, it will be run on each data point, and returned value will be used. If given as an integer, it will be used as an array index for array-type data points. If given as a string, it will be used as a property key for object-type data points. If given as an array of strings, or a string containing dots or brackets, it will be used as a nested object property path (for details see Lodash docs for _.get). If `null` or `undefined`, the data value will be used as is (identity function/pass-through). @example 0, 'y', 'y.value.nested.1.thing', 'y[2].also.nested', null, d => Math.sin(d) | |
| y0 | DataGetterPropType | No | Use y0 data accessor prop to determine how the component defines the baseline y0 data. This prop is useful for defining custom baselines for components like ChartArea. This prop may be given in a variety of formats. @example 'last_quarter_profit', () => 10, 1, 'employees.salary', ["employees", "salary"] |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| children | React.ReactNode | React.ReactNode[] | No | The children prop specifies the child or children that will be rendered within the container. This prop should not be set manually. It will be set by whatever Victory component is rendering the container. | |
| className | string | No | The className prop specifies a className that will be applied to the outer-most div rendered by ChartContainer | |
| containerId | number | string | No | The containerId prop may be used to set a deterministic id for the container. When a containerId is not manually set, a unique id will be generated. It is usually necessary to set deterministic ids for automated testing. | |
| containerRef | Function | No | The containerRef prop may be used to attach a ref to the outermost element rendered by the container. @example containerRef={(ref) => { this.chartRef = ref; }} | |
| desc | string | No | The desc prop specifies the description of the chart/SVG to assist with accessibility for screen readers. The more info about the chart provided in the description, the more usable it will be for people using screen readers. This prop defaults to an empty string. @example "Golden retreivers make up 30%, Labs make up 25%, and other dog breeds are not represented above 5% each." | |
| events | React.DOMAttributes<any> | No | The events prop attaches arbitrary event handlers to the container component. Event handlers passed from other Victory components are called with their corresponding events as well as scale, style, width, height, and data when applicable. Use the invert method to convert event coordinate information to data. `scale.x.invert(evt.offsetX)`. @example {{ onClick: (evt) => alert(`x: ${evt.clientX}, y: ${evt.clientY}`)}} | |
| height | number | No | The height props specifies the height the svg viewBox of the container. This value should be given as a number of pixels. If no height prop is given, the height prop from the child component passed will be used. | |
| responsive | boolean | No | The responsive prop specifies whether the rendered container should be a responsive container with a viewBox attribute, or a static container with absolute width and height. | |
| style | React.CSSProperties | No | The style prop specifies styles for your ChartContainer. Any valid inline style properties will be applied. Height and width should be specified via the height and width props, as they are used to calculate the alignment of components within the container. Styles from the child component will also be passed, if any exist. @example {border: 1px solid red} | |
| theme | ChartThemeDefinition | No | getTheme(themeColor, themeVariant) | The theme prop specifies a theme to use for determining styles and layout properties for a component. Any styles or props defined in theme may be overwritten by props specified on the component instance. |
| themeColor | string | No | Specifies the theme color. Valid values are 'blue', 'green', 'multi', etc. Note: Not compatible with theme prop @example themeColor={ChartThemeColor.blue} | |
| themeVariant | string | No | Specifies the theme variant. Valid values are 'dark' or 'light' Note: Not compatible with theme prop @example themeVariant={ChartThemeVariant.light} | |
| title | string | No | The title prop specifies the title to be applied to the SVG to assist accessibility for screen readers. The more descriptive this title is, the more useful it will be. If no title prop is passed, it will default to Chart. @example "Popularity of Dog Breeds by Percentage" | |
| width | number | No | The width props specifies the width of the svg viewBox of the container This value should be given as a number of pixels. If no width prop is given, the width prop from the child component passed will be used. |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| allowZoom | boolean | No | false | Specifies the zoom capability of the container component. A value of true allows the chart to zoom in and out. Zoom events are controlled by scrolling. When zoomed in, panning events are controlled by dragging. By default this value is set to false. Note: Only compatible with charts that display an x, y axis |
| animate | AnimatePropTypeInterface | No | The animate prop specifies props for VictoryAnimation to use. The animate prop should also be used to specify enter and exit transition configurations with the `onExit` and `onEnter` namespaces respectively. @example {duration: 500, onExit: () => {}, onEnter: {duration: 500, before: () => ({y: 0})})} | |
| ariaDesc | string | No | The ariaDesc prop specifies the description of the chart/SVG to assist with accessibility for screen readers. Note: Overridden by the desc prop of containerComponent | |
| ariaTitle | string | No | The ariaTitle prop specifies the title to be applied to the SVG to assist accessibility for screen readers. Note: Overridden by the title prop of containerComponent | |
| categories | CategoryPropType | No | The categories prop specifies how categorical data for a chart should be ordered. This prop should be given as an array of string values, or an object with these arrays of values specified for x and y. If this prop is not set, categorical data will be plotted in the order it was given in the data array @example ["dogs", "cats", "mice"] | |
| children | React.ReactNode | No | The children to render with the chart | |
| color | string | No | The color prop is an optional prop that defines a single color to be applied to the children of ChartGroup. The color prop will override colors specified via colorScale. | |
| colorScale | ColorScalePropType | No | The colorScale prop is an optional prop that defines the color scale the chart's bars will be created on. This prop should be given as an array of CSS colors, or as a string corresponding to one of the built in color scales. ChartGroup will automatically assign values from this color scale to the bars unless colors are explicitly provided in the `dataAttributes` prop. | |
| containerComponent | React.ReactElement<any> | No | allowZoom ? <VictoryZoomContainer /> : <ChartContainer /> | The containerComponent prop takes an entire component which will be used to create a container element for standalone charts. The new element created from the passed containerComponent wil be provided with these props from ChartGroup: height, width, children (the chart itself) and style. Props that are not provided by the child chart component include title and desc, both of which are intended to add accessibility to Victory components. The more descriptive these props are, the more accessible your data will be for people using screen readers. 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 dataComponent is not provided, ChartGroup will use the default ChartContainer component. @example <ChartContainer title="Chart of Dog Breeds" desc="This chart shows..." /> |
| data | any[] | No | The data prop specifies the data to be plotted. Data should be in the form of an array of data points, or an array of arrays of data points for multiple datasets. Each data point may be any format you wish (depending on the `x` and `y` accessor props), but by default, an object with x and y properties is expected. @example [{x: 1, y: 2}, {x: 2, y: 3}], [[1, 2], [2, 3]], [[{x: "a", y: 1}, {x: "b", y: 2}], [{x: "a", y: 2}, {x: "b", y: 3}]] | |
| domain | DomainPropType | No | The domain prop describes the range of values your chart will cover. This prop can be given as a array of the minimum and maximum expected values for your bar chart, or as an object that specifies separate arrays for x and y. If this prop is not provided, a domain will be calculated from data, or other available information. @example [-1, 1], {x: [0, 100], y: [0, 1]} | |
| domainPadding | DomainPaddingPropType | No | The domainPadding prop specifies a number of pixels of padding to add to the beginning and end of a domain. This prop is useful for explicitly spacing ticks farther from the origin to prevent crowding. This prop should be given as an object with numbers specified for x and y. | |
| eventKey | StringOrNumberOrCallback | No | Similar to data accessor props `x` and `y`, this prop may be used to functionally assign eventKeys to data | |
| events | EventPropTypeInterface<'data' | 'labels' | 'parent', 'all'>[] | No | The event prop take an array of event objects. Event objects are composed of a target, an eventKey, and eventHandlers. Targets may be any valid style namespace for a given component, so "data" and "labels" are all valid targets for ChartGroup events. Since ChartGroup only renders a single element, the eventKey property is not used. The eventHandlers object should be given as an object whose keys are standard event names (i.e. onClick) and whose values are event callbacks. The return value of an event handler is used to modify elemnts. The return value should be given as an object or an array of objects with optional target and eventKey keys, and a mutation key whose value is a function. The target and eventKey keys will default to those corresponding to the element the event handler was attached to. The mutation function will be called with the calculated props for the individual selected element (i.e. an area), and the object returned from the mutation function will override the props of the selected element via object assignment. @example events={[ { target: "data", eventHandlers: { onClick: () => { return [ { mutation: (props) => { return {style: merge({}, props.style, {fill: "orange"})}; } }, { target: "labels", mutation: () => { return {text: "hey"}; } } ]; } } } ]} | |
| externalEventMutations | any[] | No | ChartGroup uses the standard externalEventMutations prop. | |
| groupComponent | React.ReactElement<any> | No | The groupComponent prop takes an entire component which will be used to create group elements for use within container elements. This prop defaults to a <g> tag on web, and a react-native-svg <G> tag on mobile | |
| height | number | No | The height props specifies the height the svg viewBox of the chart container. This value should be given as a number of pixels | |
| horizontal | boolean | No | The horizontal prop determines whether data will be plotted horizontally. When this prop is set to true, the independent variable will be plotted on the y axis and the dependent variable will be plotted on the x axis. | |
| labelComponent | React.ReactElement<any> | No | The labelComponent prop takes in an entire label component which will be used to create a label for the area. The new element created from the passed labelComponent will be supplied with the following properties: x, y, index, data, verticalAnchor, textAnchor, angle, style, text, 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 labelComponent is omitted, a new ChartLabel will be created with props described above. This labelComponent prop should be used to provide a series label for ChartGroup. If individual labels are required for each data point, they should be created by composing ChartGroup with VictoryScatter | |
| labels | string[] | ((data: any) => string) | No | The labels prop defines labels that will appear above each bar in your chart. This prop should be given as an array of values or as a function of data. If given as an array, the number of elements in the array should be equal to the length of the data array. Labels may also be added directly to the data object like data={[{x: 1, y: 1, label: "first"}]}. @example ["spring", "summer", "fall", "winter"], (datum) => datum.title | |
| maxDomain | number | { x?: number; y?: number } | No | The maxDomain prop defines a maximum domain value for a chart. This prop is useful in situations where the maximum domain of a chart is static, while the minimum value depends on data or other variable information. If the domain prop is set in addition to maximumDomain, domain will be used. note: The x value supplied to the maxDomain prop refers to the independent variable, and the y value refers to the dependent variable. This may cause confusion in horizontal charts, as the independent variable will corresponds to the y axis. examples: maxDomain={0} maxDomain={{ y: 0 }} | |
| minDomain | number | { x?: number; y?: number } | No | The minDomain prop defines a minimum domain value for a chart. This prop is useful in situations where the minimum domain of a chart is static, while the maximum value depends on data or other variable information. If the domain prop is set in addition to minimumDomain, domain will be used. note: The x value supplied to the minDomain prop refers to the independent variable, and the y value refers to the dependent variable. This may cause confusion in horizontal charts, as the independent variable will corresponds to the y axis. examples: minDomain={0} minDomain={{ y: 0 }} | |
| name | string | No | The name prop is used to reference a component instance when defining shared events. | |
| offset | number | No | The offset prop determines the number of pixels each element in a group should be offset from its original position of the on the independent axis. In the case of groups of bars, this number should be equal to the width of the bar plus the desired spacing between bars. | |
| origin | { x: number; y: number } | No | Victory components will pass an origin prop is to define the center point in svg coordinates for polar charts. **This prop should not be set manually.** | |
| padding | PaddingProps | No | The padding props specifies the amount of padding in number of pixels between the edge of the chart and any rendered child components. This prop can be given as a number or as an object with padding specified for top, bottom, left and right. | |
| polar | boolean | No | Victory components can pass a boolean polar prop to specify whether a label is part of a polar chart. **This prop should not be set manually.** | |
| range | [number, number] | { x?: [number, number]; y?: [number, number] } | No | The range prop describes the dimensions over which data may be plotted. For cartesian coordinate systems, this corresponds to minimum and maximum svg coordinates in the x and y dimension. In polar coordinate systems this corresponds to a range of angles and radii. When this value is not given it will be calculated from the width, height, and padding, or from the startAngle and endAngle in the case of polar charts. All components in a given chart must share the same range, so setting this prop on children nested within Chart, ChartGroup will have no effect. This prop is usually not set manually. examples: Cartesian: range={{ x: [50, 250], y: [50, 250] }} Polar: range={{ x: [0, 360], y: [0, 250] }} | |
| samples | number | No | The samples prop specifies how many individual points to plot when plotting y as a function of x. Samples is ignored if x props are provided instead. | |
| scale | ScalePropType | D3Scale | { x?: ScalePropType | D3Scale; y?: ScalePropType | D3Scale; } | No | The scale prop determines which scales your chart should use. This prop can be given as a string specifying a supported scale ("linear", "time", "log", "sqrt"), as a d3 scale function, or as an object with scales specified for x and y @example d3Scale.time(), {x: "linear", y: "log"} | |
| sharedEvents | any | No | The sharedEvents prop is used internally to coordinate events between components. It should not be set manually. | |
| singleQuadrantDomainPadding | boolean | { x: boolean; y: boolean } | No | By default domainPadding is coerced to existing quadrants. This means that if a given domain only includes positive values, no amount of padding applied by domainPadding will result in a domain with negative values. This is the desired behavior in most cases. For users that need to apply padding without regard to quadrant, the singleQuadrantDomainPadding prop may be used. This prop may be given as a boolean or an object with boolean values specified for "x" and/or "y". When this prop is false (or false for a given dimension), padding will be applied without regard to quadrant. If this prop is not specified, domainPadding will be coerced to existing quadrants. note: The x value supplied to the singleQuadrantDomainPadding prop refers to the independent variable, and the y value refers to the dependent variable. This may cause confusion in horizontal charts, as the independent variable will corresponds to the y axis. examples: singleQuadrantDomainPadding={false} singleQuadrantDomainPadding={{ x: false }} | |
| sortKey | string | string[] | Function | No | Use the sortKey prop to indicate how data should be sorted. This prop is given directly to the lodash sortBy function to be executed on the final dataset. | |
| sortOrder | 'ascending' | 'descending' | No | The sortOrder prop specifies whether sorted data should be returned in ascending or descending order. | |
| standalone | boolean | No | The standalone prop determines whether the component will render a standalone svg or a <g> tag that will be included in an external svg. Set standalone to false to compose ChartGroup with other components within an enclosing <svg> tag. | |
| style | VictoryStyleInterface | No | The style prop specifies styles for your ChartGroup. Any valid inline style properties will be applied. Height, width, and padding should be specified via the height, width, and padding props, as they are used to calculate the alignment of components within chart. @example {data: {fill: "red"}, labels: {fontSize: 12}} | |
| theme | ChartThemeDefinition | No | getTheme(themeColor, themeVariant) | The theme prop specifies a theme to use for determining styles and layout properties for a component. Any styles or props defined in theme may be overwritten by props specified on the component instance. |
| themeColor | string | No | Specifies the theme color. Valid values are 'blue', 'green', 'multi', etc. Note: Not compatible with theme prop @example themeColor={ChartThemeColor.blue} | |
| themeVariant | string | No | Specifies the theme variant. Valid values are 'dark' or 'light' Note: Not compatible with theme prop @example themeVariant={ChartThemeVariant.light} | |
| width | number | No | The width props specifies the width of the svg viewBox of the chart container This value should be given as a number of pixels | |
| x | DataGetterPropType | No | The x prop specifies how to access the X value of each data point. If given as a function, it will be run on each data point, and returned value will be used. If given as an integer, it will be used as an array index for array-type data points. If given as a string, it will be used as a property key for object-type data points. If given as an array of strings, or a string containing dots or brackets, it will be used as a nested object property path (for details see Lodash docs for _.get). If `null` or `undefined`, the data value will be used as is (identity function/pass-through). @example 0, 'x', 'x.value.nested.1.thing', 'x[2].also.nested', null, d => Math.sin(d) | |
| y | DataGetterPropType | No | The y prop specifies how to access the Y value of each data point. If given as a function, it will be run on each data point, and returned value will be used. If given as an integer, it will be used as an array index for array-type data points. If given as a string, it will be used as a property key for object-type data points. If given as an array of strings, or a string containing dots or brackets, it will be used as a nested object property path (for details see Lodash docs for _.get). If `null` or `undefined`, the data value will be used as is (identity function/pass-through). @example 0, 'y', 'y.value.nested.1.thing', 'y[2].also.nested', null, d => Math.sin(d) | |
| y0 | DataGetterPropType | No | Use y0 data accessor prop to determine how the component defines the baseline y0 data. This prop is useful for defining custom baselines for components like ChartBar or ChartArea. This prop may be given in a variety of formats. @example 'last_quarter_profit', () => 10, 1, 'employees.salary', ["employees", "salary"] |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| active | boolean | No | The active prop specifies whether the label is active or not. The active prop is set by defaultEvents in components like ChartTooltip and VictorySelectionContainer. The active prop is used when evaluating functional styles and props. | |
| angle | string | number | No | Specifies the angle to rotate the text by. | |
| capHeight | StringOrNumberOrCallback | No | The capHeight prop defines a text metric for the font being used: the expected height of capital letters. This is necessary because of SVG, which (a) positions the *bottom* of the text at `y`, and (b) has no notion of line height. The value should ideally use the same units as `lineHeight` and `dy`, preferably ems. If given a unitless number, it is assumed to be ems. | |
| children | StringOrNumberOrCallback | No | The children of this component define the content of the label. This makes using the component similar to normal HTML spans or labels. strings, numbers, and functions of data / value are supported. | |
| className | string | No | The className prop specifies a class name that will be applied to the rendered text element. | |
| data | any[] | No | Labels that apply to an entire data series will recieve the entire series as `data` instead of an individual datum prop. | |
| datum | {} | No | Victory components can pass a datum prop to their label component. This can be used to calculate functional styles, and determine child text | |
| desc | string | No | The desc prop specifies the description of the chart/SVG to assist with accessibility for screen readers. The more descriptive this title is, the more useful it will be for people using screen readers. | |
| direction | 'rtl' | 'ltr' | 'inherit' | No | The direction prop determines which text direction to apply to the rendered text element | |
| dx | StringOrNumberOrCallback | No | The dx prop defines a horizontal shift from the `x` coordinate. | |
| dy | StringOrNumberOrCallback | No | The dy prop defines a vertical shift from the `y` coordinate. Since this component already accounts for `capHeight`, `lineHeight`, and `verticalAnchor`, this will usually not be necessary. | |
| events | React.DOMAttributes<any> | No | The events prop attaches arbitrary event handlers to the label component. Event handlers are currently only called with their corresponding events. | |
| index | string | number | No | The index prop represents the index of the datum in the data array. This prop should not be set manually. | |
| labelPlacement | 'parallel' | 'perpendicular' | 'vertical' | No | The labelPlacement prop is used to specify the placement of labels relative to the data point they represent. This prop may be given as “vertical”, “parallel” or “perpendicular”. This props is particularly useful in polar charts, where it may be desireable to position a label either parallel or perpendicular to its corresponding angle. When this prop is not set, perpendicular label placement will be used for polar charts, and vertical label placement will be used for cartesian charts. | |
| lineHeight | StringOrNumberOrCallback | No | The lineHeight prop defines how much space a single line of text should take up. Note that SVG has no notion of line-height, so the positioning may differ slightly from what you would expect with CSS, but the result is similar: a roughly equal amount of extra space is distributed above and below the line of text. The value should ideally use the same units as `capHeight` and `dy`, preferably ems. If given a unitless number, it is assumed to be ems. | |
| origin | { x: number; y: number } | No | Victory components will pass an origin prop is to define the center point in svg coordinates for polar charts. **This prop should not be set manually.** | |
| polar | boolean | No | Victory components can pass a boolean polar prop to specify whether a label is part of a polar chart. **This prop should not be set manually.** | |
| renderInPortal | boolean | No | The renderInPortal prop specifies whether ChartLabel should render text in place or within a VictoryPortal. Setting renderInPortal to true is equivalent to wrapping ChartLabel in a VictoryPortal. This prop is false by default. | |
| scale | { x?: any; y?: any } | No | Victory components can pass a scale prop to their label component. This can be used to calculate the position of label elements from datum. This prop should not be set manually. | |
| style | React.CSSProperties | React.CSSProperties[] | No | The style prop applies CSS properties to the rendered `<text>` element. | |
| text | string[] | StringOrNumberOrCallback | No | The text prop defines the text ChartLabel will render. The text prop may be given as a string, number, a function of datum, or an array of any of these. Strings may include newline characters, which ChartLabel will split into separate <tspan/> elements. When text is given as an array, separate <tspan/> elements will be created for each element in the array. | |
| textAnchor | TextAnchorType | (() => TextAnchorType) | No | The textAnchor prop defines how the text is horizontally positioned relative to the given `x` and `y` coordinates. | |
| transform | string | {} | (() => string) | No | The transform prop applies a transform to the rendered `<text>` element. In addition to being a string, it can be an object containing transform definitions for easier authoring. | |
| verticalAnchor | VerticalAnchorType | (() => VerticalAnchorType) | No | The verticalAnchor prop defines how the text is vertically positioned relative to the given `x` and `y` coordinates | |
| x | number | No | The x prop defines the x coordinate to use as a basis for horizontal positioning. | |
| y | number | No | The y prop defines the y coordinate to use as a basis for vertical positioning. |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| activateData | boolean | No | When the activateData prop is set to true, the active prop will be set to true on all data components within a voronoi area. When this prop is set to false, the onActivated and onDeactivated callbacks will still fire, but no mutations to data components will occur via Victory’s event system. | |
| activateLabels | boolean | No | When the activateLabels prop is set to true, the active prop will be set to true on all labels corresponding to points within a voronoi area. When this prop is set to false, the onActivated and onDeactivated callbacks will still fire, but no mutations to label components will occur via Victory’s event system. Labels defined directly on ChartVoronoiContainer via the labels prop will still appear when this prop is set to false. | |
| allowTooltip | boolean | No | true | Specifies the tooltip capability of the container component. A value of true allows the chart to add a ChartTooltip component to the labelComponent property. This is a shortcut to display tooltips when the labels property is also provided. |
| className | string | No | The className prop specifies a className that will be applied to the outer-most div rendered by the container | |
| constrainToVisibleArea | boolean | No | false | The constrainToVisibleArea prop determines whether to coerce tooltips so that they fit within the visible area of the chart. When this prop is set to true, tooltip pointers will still point to the correct data point, but the center of the tooltip will be shifted to fit within the overall width and height of the svg Victory renders. |
| disable | boolean | No | When the disable prop is set to true, ChartVoronoiContainer events will not fire. | |
| labels | (point: any, index: number, points: any[]) => string | No | When a labels prop is provided to ChartVoronoiContainer it will render a label component rather than activating labels on the child components it renders. This is useful for creating multi- point tooltips. This prop should be given as a function which will be called once for each active point. The labels function will be called with the arguments point, index, and points, where point refers to a single active point, index refers to the position of that point in the array of active points, and points is an array of all active points. | |
| labelComponent | React.ReactElement<any> | No | allowTooltip ? <ChartTooltip /> : undefined | The labelComponent prop specified the component that will be rendered when labels are defined on ChartVoronoiContainer. If the labels prop is omitted, no label component will be rendered. |
| mouseFollowTooltips | boolean | No | When the mouseFollowTooltip prop is set on VictoryVoronoiContainer, The position of the center of the tooltip follows the position of the mouse. | |
| onActivated | (points: any[], props: VictoryVoronoiContainerProps) => void | No | The onActivated prop accepts a function to be called whenever new data points are activated. The function is called with the parameters points (an array of active data objects) and props (the props used by ChartVoronoiContainer). | |
| onDeactivated | (points: any[], props: VictoryVoronoiContainerProps) => void | No | The onDeactivated prop accepts a function to be called whenever points are deactivated. The function is called with the parameters points (an array of the newly-deactivated data objects) and props (the props used by ChartVoronoiContainer). | |
| radius | number | No | When the radius prop is set, the voronoi areas associated with each data point will be no larger than the given radius. This prop should be given as a number. | |
| responsive | boolean | No | The responsive prop specifies whether the rendered container should be a responsive container with a viewBox attribute, or a static container with absolute width and height. @default true | |
| style | React.CSSProperties | No | The style prop specifies styles for your VictoryContainer. Any valid inline style properties will be applied. Height and width should be specified via the height and width props, as they are used to calculate the alignment of components within the container. Styles from the child component will also be passed, if any exist. @example {border: 1px solid red} | |
| theme | ChartThemeDefinition | No | getTheme(themeColor, themeVariant) | The theme prop specifies a theme to use for determining styles and layout properties for a component. Any styles or props defined in theme may be overwritten by props specified on the component instance. |
| themeColor | string | No | Specifies the theme color. Valid values are 'blue', 'green', 'multi', etc. Note: Not compatible with theme prop @example themeColor={ChartThemeColor.blue} | |
| themeVariant | string | No | Specifies the theme variant. Valid values are 'dark' or 'light' Note: Not compatible with theme prop @example themeVariant={ChartThemeVariant.light} | |
| voronoiBlacklist | string[] | No | The voronoiBlacklist prop is used to specify a list of components to ignore when calculating a shared voronoi diagram. Components with a name prop matching an element in the voronoiBlacklist array will be ignored by ChartVoronoiContainer. Ignored components will never be flagged as active, and will not contribute date to shared tooltips or labels. | |
| voronoiDimension | 'x' | 'y' | No | When the voronoiDimension prop is set, voronoi selection will only take the given dimension into account. For example, when dimension is set to “x”, all data points matching a particular x mouse position will be activated regardless of y value. When this prop is not given, voronoi selection is determined by both x any y values. | |
| voronoiPadding | number | No | When the voronoiPadding prop is given, the area of the chart that will trigger voronoi events is reduced by the given padding on every side. By default, no padding is applied, and the entire range of a given chart may trigger voronoi events. This prop should be given as a number. |
