Scatter Chart

import { ScatterChartDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';

export default Layout(MDX_DATA.ScatterChart);

Usage

Multiple series

Legend

To display the chart legend, set the withLegend prop. When one of the items in the legend is hovered, the corresponding data series is highlighted in the chart.

Legend position

You can pass props down to the recharts Legend component with the legendProps prop. For example, setting legendProps={{ verticalAlign: 'bottom', height: 50 }} will render the legend at the bottom of the chart and set its height to 50px.

X and Y axis props

Use xAxisProps and yAxisProps to pass props down to the recharts XAxis and YAxis components. For example, these props can be used to change the orientation of the axis:

Value formatter

To format values in the tooltip and axis ticks, use the valueFormat prop. It accepts a function that takes a number value as an argument and returns a formatted value or an object with x and y keys to format x and y values separately:

Point labels

Set the pointLabels prop to x or y to display labels on data points for the corresponding axis:

Grid and text colors

Use --chart-grid-color and --chart-text-color to change colors of grid lines and text within the chart. With CSS modules, you can change colors depending on color scheme:

If your application has only one color scheme, you can use the gridColor and textColor props instead of CSS variables:

tsx

import { ScatterChart } from '@mantine/charts';
import { data } from './data';

function Demo() {
  return (
    <ScatterChart
      h={350}
      data={data}
      dataKey={{ x: 'age', y: 'BMI' }}
      gridColor="gray.5"
      textColor="gray.9"
    />
  );
}

Stroke dash array

Set the strokeDasharray prop to control the stroke dash array of the grid and cursor lines. The value represents the lengths of alternating dashes and gaps. For example, strokeDasharray="10 5" will render a dashed line with 10px dashes and 5px gaps.

Units

Set the unit prop to render a unit label next to the axis ticks and tooltip values:

To customize labels displayed in the tooltip, use the labels prop:

Use tooltipProps.content to pass a custom tooltip renderer to the recharts Tooltip component:

To remove the tooltip, set withTooltip={false}. This also removes the cursor line and disables interactions with the chart.

By default, tooltip animation is disabled. To enable it, set the tooltipAnimationDuration prop to a number of milliseconds to animate the tooltip position change.

Customize dots

You can use any shape as a dot by passing props to the recharts Scatter component:

Reference lines

Use the referenceLines prop to render reference lines. Reference lines are always rendered behind the chart.