apps/mantine.dev/src/pages/charts/area-chart.mdx
import { AreaChartDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';
export default Layout(MDX_DATA.AreaChart);
Use the AreaChart component without the type prop to render a regular area chart.
In a regular area chart, each data series is plotted independently and does
not interact with other series.
Set type="stacked" to render a stacked area chart. In this type of area chart,
stacking is applied along the vertical axis, allowing you to see the overall trend
as well as the contribution of each individual series to the total.
Set type="percent" to render a percent area chart. In this type of area chart,
the y-axis scale is always normalized to 100%, making it easier to compare the
contribution of each series in terms of percentages.
Set type="split" to render a split area chart. In this type of area chart,
the fill color is split into two colors: one for positive values and one for negative
values. Split area charts support only one data series.
Set the splitColors prop to an array of two colors to customize the fill color of a
split area chart. The first color is used for positive values and the second color
is used for negative values. The splitColors prop is ignored in other types of area charts.
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.
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.
By default, the series name is used as a label. To change it, set the label
property in the series object:
You can set individual curve types for each line in the series array. If you
do not set a curve type for a line, the series will fall back to curveType prop, or
monotone if curveType is not set.
Use the connectNulls prop to specify whether to connect a data point across null
points. By default, connectNulls is true.
To display labels on data points, set withPointLabels:
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:
Use xAxisLabel and yAxisLabel props to display axis labels:
Use xAxisProps to set padding between the chart ends and the x-axis:
Use yAxisProps to change the domain of the Y axis. For example, if you know that
your data will always be in the range of 0 to 100, you can set the domain to [0, 100]:
To display an additional Y axis on the right side of the chart, set the withRightYAxis prop.
You can pass props down to the recharts YAxis
component with the rightYAxisProps prop and assign a label to the right Y axis with
the rightYAxisLabel prop. Note that you need to bind data series to the right Y axis
by setting yAxisId in the series object.
To rotate x-axis labels, set xAxisProps.angle to the number of degrees to rotate:
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:
You can reference colors from theme the same way as in
other components, for example, blue, red.5, orange.7, etc. Any valid CSS
color value is also accepted.
You can use CSS variables in the color property. To define a CSS variable that
changes depending on the color scheme, use light/dark mixins
or the light-dark function. Example
of an area that is dark orange in light mode and lime in dark mode:
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.
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:
import { AreaChart } from '@mantine/charts';
import { data } from './data';
function Demo() {
return (
<AreaChart
h={300}
data={data}
dataKey="date"
type="stacked"
gridColor="gray.5"
textColor="gray.9"
series={[
{ name: 'Apples', color: 'indigo.6' },
{ name: 'Oranges', color: 'blue.6' },
{ name: 'Tomatoes', color: 'teal.6' },
]}
/>
);
}
By default, tooltip animation is disabled. To enable it, set the tooltipAnimationDuration
prop to a number of milliseconds to animate the tooltip position change.
Set the unit prop to render a unit label next to the y-axis ticks and tooltip values:
Use tooltipProps.content to pass a custom tooltip renderer to the recharts Tooltip
component. Note that it is required to filter the recharts payload with the getFilteredChartTooltipPayload
function to remove empty values that are used for styling purposes only.
To remove the tooltip, set withTooltip={false}. This also removes the cursor line
and disables interactions with the chart.
Use dotProps to pass props down to the recharts dot in regular state and activeDotProps
to pass props down to the recharts dot in active state (when the cursor is over the current series).
Use the strokeWidth prop to control the stroke width of all areas:
Use the fillOpacity prop to control the fill opacity of all areas:
You can pass props down to the recharts AreaChart
component with the areaChartProps prop. For example, setting areaChartProps={{ syncId: 'any-id' }}
will sync the tooltip of multiple AreaChart components with the same syncId prop.
Set orientation="vertical" to render a vertical area chart:
Set the strokeDasharray property in series to change the line style to dashed:
Use the referenceLines prop to render reference lines. Reference lines are always
rendered behind the chart.
Use the ReferenceArea component from recharts to display a reference area: