Skip to content

AreaPlot API

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

Demos

Import

import { AreaPlot } from '@mui/x-charts/LineChart';
// or
import { AreaPlot } from '@mui/x-charts';
// or
import { AreaPlot } from '@mui/x-charts-pro';

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

Props

NameTypeDefaultDescription
onItemClickfunc-

Callback fired when a line area item is clicked.

Signature:function(event: React.MouseEvent, lineItemIdentifier: LineItemIdentifier) => void
  • event The event source of the callback.
  • lineItemIdentifier The line item identifier.
skipAnimationboolfalse

If true, animations are skipped.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

The component cannot hold a ref.

Slots

Slot nameClass nameDefault componentDescription
areaAnimatedAreaThe component that renders the area.