ChartsSurface API

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

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

It provides the drawing area for the chart elements. It is the root <svg> of all the chart elements.

It also provides the title and desc elements for the chart.

Props

Props of the native component are also available.

Name	Type	Default	Description
disableAxisListener	bool	false	If `true`, the charts will not listen to the mouse move event. It might break interactive features, but will improve performance.

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.