ChartsReferenceLine API

API reference docs for the React ChartsReferenceLine 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 - Axis

Import

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

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

Props

Name	Type	Default	Description
axisId	number \| string	The `id` of the first defined axis.	The id of the axis used for the reference value.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
label	string	-	The label to display along the reference line.
labelAlign	'end' \| 'middle' \| 'start'	'middle'	The alignment if the label is in the chart drawing area.
labelStyle	object	-	The style applied to the label.
lineStyle	object	-	The style applied to the line.
spacing	number \| { x?: number, y?: number }	5	Additional space around the label in px. Can be a number or an object `{ x, y }` to distinguish space with the reference line and space with axes.
x	Date \| number \| string	-	The x value associated with the reference line. If defined the reference line will be vertical.
y	Date \| number \| string	-	The y value associated with the reference line. If defined the reference line will be horizontal.

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
.MuiChartsReferenceLine-horizontal	horizontal	Styles applied to the root element if the reference line is horizontal.
.MuiChartsReferenceLine-label	label	Styles applied to the reference label.
.MuiChartsReferenceLine-line	line	Styles applied to the reference line.
.MuiChartsReferenceLine-root	root	Styles applied to the root element.
.MuiChartsReferenceLine-vertical	vertical	Styles applied to the root element if the reference line is vertical.

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.