SankeyChart API

API reference docs for the React SankeyChart 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:

Import

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

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

Props

Name	Type	Default	Description
series*	SankeySeries	-	The series to display in the Sankey chart. A single object is expected.
classes	Partial	-	Classes applied to the various elements. See CSS classes API below for more details.
colors	Array<string> \| func	rainbowSurgePalette	Color palette used to colorize multiple series.
desc	string	-	The description of the chart. Used to provide an accessible description for the chart.
disableKeyboardNavigation	bool	-	If `true`, disables keyboard navigation for the chart.
experimentalFeatures	{}	-	Options to enable features planned for the next major.
height	number	-	The height of the chart in px. If not defined, it takes the height of the parent element.
highlightedItem	{ nodeId: number \| string, seriesId: string, subType: 'node' } \| { nodeId: number \| string, seriesId: string, subType: 'node', type: 'sankey' } \| { seriesId: string, sourceId: number \| string, subType: 'link', targetId: number \| string } \| { seriesId: string, sourceId: number \| string, subType: 'link', targetId: number \| string, type: 'sankey' }	-	The highlighted item. Used when the highlight is controlled.
id	string	-	This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.
loading	bool	false	If `true`, a loading overlay is displayed.
localeText	Partial	-	Localized text for chart components.
margin	number \| { bottom?: number, left?: number, right?: number, top?: number }	-	The margin between the SVG and the drawing area. It's used for leaving some space for extra information such as the x- and y-axis or legend. Accepts a `number` to be used on all sides or an object with the optional properties: `top`, `bottom`, `left`, and `right`.
onHighlightChange	func	-	The callback fired when the highlighted item changes. Signature:`function(highlightedItem: HighlightItemIdentifierWithType<SeriesType> \| null) => void` `highlightedItem` The newly highlighted item.
onLinkClick	func	-	Callback fired when a sankey item is clicked. Signature:`function(event: React.MouseEvent<SVGElement, MouseEvent>, link: SankeyLinkIdentifierWithData) => void` `event` The event source of the callback. `link` The sankey link identifier.
onNodeClick	func	-	Callback fired when a sankey item is clicked. Signature:`function(event: React.MouseEvent<SVGElement, MouseEvent>, node: SankeyNodeIdentifierWithData) => void` `event` The event source of the callback. `node` The sankey node identifier.
onTooltipItemChange	func	-	The callback fired when the tooltip item changes. Signature:`function(tooltipItem: SeriesItemIdentifier<SeriesType> \| null) => void` `tooltipItem` The newly highlighted item.
seriesConfig	ChartSeriesConfig & ChartSeriesConfig<'sankey'>	-	The configuration for the series types. This is used to define how each series type should be processed, colored, and displayed.
slotProps	SankeyChartSlotProps	{}	The props used for each component slot.
slots	SankeyChartSlots	{}	Overridable component slots. See Slots API below for more details.
title	string	-	The title of the chart. Used to provide an accessible label for the chart.
tooltipItem	{ nodeId: number \| string, seriesId: string, subType: 'node' } \| { nodeId: number \| string, seriesId: string, subType: 'node', type: 'sankey' } \| { seriesId: string, sourceId: number \| string, subType: 'link', targetId: number \| string } \| { seriesId: string, sourceId: number \| string, subType: 'link', targetId: number \| string, type: 'sankey' }	-	The tooltip item. Used when the tooltip is controlled.
width	number	-	The width of the chart in px. If not defined, it takes the width of the parent element.

The component cannot hold a ref.

Slots

Slot name	Default component	Description
baseButton
baseIconButton
loadingOverlay	`ChartsLoadingOverlay`	Overlay component rendered when the chart is in a loading state.
noDataOverlay	`ChartsNoDataOverlay`	Overlay component rendered when the chart has no data to display.
toolbar	`ChartsToolbar`	Custom component for the toolbar.
tooltip	`ChartsTooltipRoot`	Custom component for the tooltip popper.

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.