SankeyPlot API

API reference docs for the React SankeyPlot 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 { SankeyPlot } from '@mui/x-charts-pro/SankeyChart';
// or
import { SankeyPlot } from '@mui/x-charts-pro';

Renders a Sankey diagram plot.

Props of the native component are also available.

Name Type Description

classes

Name	Type	Description
classes	object	Classes applied to the various elements. See CSS classes API below for more details.
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.

object

Classes applied to the various elements.

See CSS classes API below for more details.

onLinkClick

func

Callback fired when a sankey item is clicked.

Signature:function(event: React.MouseEvent<SVGElement, MouseEvent>, link: SankeyLinkIdentifierWithData) => void

onNodeClick

func

Callback fired when a sankey item is clicked.

Signature:function(event: React.MouseEvent<SVGElement, MouseEvent>, node: SankeyNodeIdentifierWithData) => void

The component cannot hold a ref.

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