SankeyTooltip API

API reference docs for the React SankeyTooltip component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Charts - Sankey

Import

import { SankeyTooltip } from '@mui/x-charts-pro/SankeyChart';
// or
import { SankeyTooltip } from '@mui/x-charts-pro';
// or
import { SankeyTooltip } from '@mui/x-charts-premium/SankeyChart';
// or
import { SankeyTooltip } from '@mui/x-charts-premium';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
anchor	'chart' \| 'node' \| 'pointer'	'pointer'	Determine if the tooltip should be placed on the pointer location or on the node.
classes	Partial	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
position	'bottom' \| 'left' \| 'right' \| 'top'	-	Determines the tooltip position relatively to the anchor.
slotProps	ChartsTooltipContainerSlotProps	{}	The props used for each component slot.
slots	ChartsTooltipContainerSlots	{}	Overridable component slots. See Slots API below for more details.
trigger	'item' \| 'none'	'item'	Select the kind of tooltip to display - 'item': Shows data about the item below the mouse. - 'none': Does not display tooltip

The component cannot hold a ref.

Slots

Slot name	Class name	Default component	Description
root		`'div'`	The component that renders the root.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.