ChartsGrid API

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

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

Props

Props of the native component are also available.

Name Type Description

classes

Name	Type	Description
classes	object	Override or extend the styles applied to the component. See CSS classes API below for more details.
horizontal	bool	Displays horizontal grid.
vertical	bool	Displays vertical grid.

object

Override or extend the styles applied to the component.

See CSS classes API below for more details.

horizontal

bool

Displays horizontal grid.

vertical

bool

Displays vertical grid.

The component cannot hold a ref.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiChartsGrid-horizontalLine	horizontalLine	Styles applied to x-axes.
.MuiChartsGrid-line	line	Styles applied to every line element.
.MuiChartsGrid-root	root	Styles applied to the root element.
.MuiChartsGrid-verticalLine	verticalLine	Styles applied to y-axes.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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.