Tooltip chart

Introduction Examples Documentation Props

Introduction

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.

Examples

Voronoi container

This demonstrates how to use a voronoi container to display tooltips

Data label

This demonstrates an alternate way of applying tooltips using data labels

Legend

This demonstrates an approach for applying tooltips to a legend using a custom label component

Left aligned

This demonstrates how to customize tooltip label alignment using theme properties

CSS overflow

This demonstrates an alternate way of applying tooltips using CSS overflow instead of constrainToVisibleArea

Wrapped chart

This demonstrates an alternate way of applying tooltips by wrapping charts with the Tooltip component

Documentation

Tips

See Victory's FAQ

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 ChartTooltip props, see VictoryTooltip

Props

ChartTooltip properties
Name	Type	Required	Default	Description
active	boolean	No		The active prop specifies whether the tooltip component should be displayed.
activateData	boolean	No		When true, tooltip events will set the active prop on both data and label elements.
angle	string \| number	No		The angle prop specifies the angle to rotate the tooltip around its origin point.
center	{ x: number; y: number }	No		The center prop determines the position of the center of the tooltip flyout. This prop should be given as an object that describes the desired x and y svg coordinates of the center of the tooltip. This prop is useful for positioning the flyout of a tooltip independent from the pointer. When ChartTooltip is used with ChartVoronoiContainer, the center prop is what enables the mouseFollowTooltips option. When this prop is set, non-zero pointerLength values will no longer be respected.
centerOffset	{ x: number \| Function; y: number \| Function }	No		The centerOffset prop determines the position of the center of the tooltip flyout in relation to the flyout pointer. This prop should be given as an object of x and y, where each is either a numeric offset value or a function that returns a numeric value. When this prop is set, non-zero pointerLength values will no longer be respected.
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.
cornerRadius	NumberOrCallback	No		The cornerRadius prop determines corner radius of the flyout container. This prop may be given as a positive number or a function of datum.
data	any[]	No		Victory components can pass a data prop to their label component. This can be useful in custom components that need to make use of the entire dataset.
datum	{}	No		Victory components can pass a datum prop to their label component. This can be used to calculate functional styles, and determine text.
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.
events	{}	No		The events prop attaches arbitrary event handlers to the label component. This prop should be given as an object of event names and corresponding event handlers. When events are provided via Victory’s event system, event handlers will be called with the event, the props of the component is attached to, and an eventKey. Examples: events={{onClick: (evt) => alert("x: " + evt.clientX)}}
flyoutComponent	React.ReactElement<any>	No		The flyoutComponent prop takes a component instance which will be used to create the flyout path for each tooltip. The new element created from the passed flyoutComponent will be supplied with the following properties: x, y, dx, dy, index, datum, cornerRadius, pointerLength, pointerWidth, width, height, orientation, 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 flyoutComponent is omitted, a default Flyout component will be created with props described above. Examples: flyoutComponent={<Flyout x={50} y={50}/>}, flyoutComponent={<MyCustomFlyout/>}
flyoutHeight	NumberOrCallback	No		The flyoutHeight prop defines the height of the tooltip flyout. This prop may be given as a positive number or a function of datum. If this prop is not set, height will be determined based on an approximate text size calculated from the text and style props provided to ChartTooltip.
flyoutStyle	VictoryStyleObject	No		The style prop applies SVG style properties to the rendered flyout container. These props will be passed to the flyoutComponent.
flyoutWidth	NumberOrCallback	No		The flyoutWidth prop defines the width of the tooltip flyout. This prop may be given as a positive number or a function of datum. If this prop is not set, flyoutWidth will be determined based on an approximate text size calculated from the text and style props provided to VictoryTooltip.
groupComponent	React.ReactElement<any>	No		The groupComponent prop takes a component instance which will be used to create group elements for use within container elements. This prop defaults to a <g> tag.}
horizontal	boolean	No		The horizontal prop determines whether to plot the flyouts to the left / right of the (x, y) coordinate rather than top / bottom. This is useful when an orientation prop is not provided, and data will determine the default orientation. i.e. negative values result in a left orientation and positive values will result in a right orientation by default.
index	number \| string	No		The index prop represents the index of the datum in the data array.
labelComponent	React.ReactElement<any>	No		The labelComponent prop takes a component instance which will be used to render each tooltip label. The new element created from the passed labelComponent will be supplied with the following properties: x, y, index, datum, verticalAnchor, textAnchor, 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 the props described above. Examples: labelComponent={<ChartLabel dy={20}/>}, labelComponent={<MyCustomLabel/>}
orientation	OrientationTypes	No		The orientation prop determines which side of the (x, y) coordinate the tooltip should be rendered on. This prop can be given as “top”, “bottom”, “left”, “right”, or as a function of datum that returns one of these values. If this prop is not provided it will be determined from the sign of the datum, and the value of the horizontal prop.
pointerLength	NumberOrCallback	No		The pointerLength prop determines the length of the triangular pointer extending from the flyout. This prop may be given as a positive number or a function of datum.
pointerOrientation	'top' \| 'bottom' \| 'left' \| 'right' \| Function	No		This prop determines which side of the tooltip flyout the pointer should originate on. When this prop is not set, it will be determined based on the overall orientation of the flyout in relation to its data point, and any center or centerOffset values.
pointerWidth	NumberOrCallback	No		The pointerWidth prop determines the width of the base of the triangular pointer extending from the flyout. This prop may be given as a positive number or a function of datum.
renderInPortal	boolean	No		When renderInPortal is true, rendered tooltips will be wrapped in VictoryPortal and rendered within the Portal element within ChartContainer. Note: This prop should not be set to true when using a custom container element.
style	React.CSSProperties	No		The style prop applies CSS properties to the rendered `<text>` element.
text	StringOrNumberOrCallback \| string[] \| number[]	No		The text prop defines the text ChartTooltip will render. The text prop may be given as a string, number, or function of datum. When ChartLabel is used as the labelComponent, strings may include newline characters, which ChartLabel will split in to separate <tspan/> elements.
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}
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.