MarkElement API

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

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

Props

Name	Type	Default	Description
dataIndex*	number	-	The index to the element in the series' data array.
shape*	'circle' \| 'cross' \| 'diamond' \| 'square' \| 'star' \| 'triangle' \| 'wye'	-	The shape of the marker.
isFaded	bool	false	If `true`, the marker is faded.
isHighlighted	bool	false	If `true`, the marker is highlighted.
skipAnimation	bool	-	If `true`, animations are skipped.

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
.MuiMarkElement-animate	animate	Styles applied to the root element when animation is not skipped.
.MuiMarkElement-faded	faded	Styles applied to the root element when faded.
.MuiMarkElement-highlighted	highlighted	Styles applied to the root element when highlighted.
.MuiMarkElement-root	root	Styles applied to the root element.
.MuiMarkElement-series	series	Styles applied to the root element for a specified series. Needs to be suffixed with the series ID: `.${markElementClasses.series}-${seriesId}`.

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.