ChartsClipPath API

API reference docs for the React ChartsClipPath 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 - Custom components

Import

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

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

Props

Name	Type	Description
id*	string	The id of the clip path.
offset	{ bottom?: number, left?: number, right?: number, top?: number }	Offset, in pixels, of the clip path rectangle from the drawing area. A positive value will move the rectangle outside the drawing area.

The component cannot hold a ref.

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.