FunnelPlot API

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

Props of the native component are also available.

Name Type Default Description

onItemClick

Name	Type	Default	Description
onItemClick	func	-	Callback fired when a funnel item is clicked. Signature:`function(event: React.MouseEvent<SVGElement, MouseEvent>, funnelItemIdentifier: FunnelItemIdentifier) => void` `event` The event source of the callback. `funnelItemIdentifier` The funnel item identifier.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.

func

Callback fired when a funnel item is clicked.

Signature:function(event: React.MouseEvent<SVGElement, MouseEvent>, funnelItemIdentifier: FunnelItemIdentifier) => void

slotProps

object

{}

The props used for each component slot.

slots

object

{}

Overridable component slots.

See Slots API below for more details.

The component cannot hold a ref.

Slot name	Class name	Default component	Description
funnelSection		`FunnelSection`	Custom component for funnel section.
funnelSectionLabel		`FunnelSectionLabel`	Custom component for funnel section label.

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