Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add example for custom legend #16169

Merged
merged 3 commits into from
Jan 14, 2025
Merged

[docs] Add example for custom legend #16169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8caf8cd
[docs] Remove broken links
alexfauquette Jan 14, 2025
7fb765a
[docs] Give example for custom legend
alexfauquette Jan 14, 2025
21f4efc
Merge remote-tracking branch 'upstream/master' into add-useLegendDemo
alexfauquette Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions docs/data/charts/legend/CustomLegend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
import * as React from 'react';
import Box from '@mui/material/Box';
import Stack from '@mui/material/Stack';
import Typography from '@mui/material/Typography';
import { useTheme } from '@mui/material/styles';
import { useLegend } from '@mui/x-charts/hooks';
import { LineChart } from '@mui/x-charts/LineChart';

function LineWithMark({ color, size }) {
return (
<svg
viewBox="0 0 24 24"
width={size}
height={size}
stroke={color}
strokeWidth={3}
strokeLinecap="round"
fill="none"
>
<path d="M 1 12.5 L 7 12.5 M 17 12.5 L 23 12.5" />
<circle cx={12} cy={12.5} r={5} />
</svg>
);
}

function DashedLine({ color, size }) {
return (
<svg
viewBox="0 0 24 24"
width={size}
height={size}
stroke={color}
strokeWidth={3}
fill="none"
>
<path d="M 1 12.5 L 23 12.5" strokeDasharray="5 3" />
</svg>
);
}

function MyCustomLegend() {
const { items } = useLegend();
return (
<Stack direction="row" gap={3}>
{items.map((item) => {
const { label, id, color, seriesId } = item;
return (
<Box key={id} sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
{seriesId === 'avg' ? (
<DashedLine color={color} size={20} />
) : (
<LineWithMark color={color} size={20} />
)}
<Typography sx={{ display: 'inline-block' }}>{`${label}`}</Typography>
</Box>
);
})}
</Stack>
);
}

const dataset = [
{ month: 'Jan', '1991_2020_avg': 4.1, 2023: 3.9 },
{ month: 'Fev', '1991_2020_avg': 4.7, 2023: 8.9 },
{ month: 'Mar', '1991_2020_avg': 7.5, 2023: 9.5 },
{ month: 'Apr', '1991_2020_avg': 10.6, 2023: 11.5 },
{ month: 'May', '1991_2020_avg': 13.8, 2023: 15.5 },
{ month: 'Jun', '1991_2020_avg': 16.7, 2023: 16.4 },
{ month: 'Jul', '1991_2020_avg': 18.9, 2023: 19.5 },
{ month: 'Aug', '1991_2020_avg': 18.8, 2023: 20.5 },
{ month: 'Sep', '1991_2020_avg': 15.8, 2023: 16.4 },
{ month: 'Oct', '1991_2020_avg': 11.9, 2023: 13.2 },
{ month: 'Nov', '1991_2020_avg': 7.6, 2023: 8.1 },
{ month: 'Dec', '1991_2020_avg': 4.7, 2023: 6.1 },
];

export default function CustomLegend() {
const theme = useTheme();

return (
<Box
sx={{ height: 300, width: '100%', display: 'flex', flexDirection: 'column' }}
>
<LineChart
dataset={dataset}
series={[
{
id: 'avg',
label: 'temp. avg. 1991-2020 (°C)',
dataKey: '1991_2020_avg',
showMark: false,
color: theme.palette.text.primary,
},
{
id: '2023-temp',
label: 'temp. 2023 (°C)',
dataKey: '2023',
color: theme.palette.primary.main,
},
]}
xAxis={[{ dataKey: 'month', scaleType: 'band', id: 'x-axis' }]}
sx={{
[`& .MuiLineElement-series-avg`]: {
strokeDasharray: '10 5',
},
}}
slots={{ legend: MyCustomLegend }}
/>
</Box>
);
}
116 changes: 116 additions & 0 deletions docs/data/charts/legend/CustomLegend.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
import * as React from 'react';
import Box from '@mui/material/Box';
import Stack from '@mui/material/Stack';
import Typography from '@mui/material/Typography';
import { useTheme } from '@mui/material/styles';
import { useLegend } from '@mui/x-charts/hooks';
import { LineChart } from '@mui/x-charts/LineChart';

type IconProps = {
color: string;
size: number;
};

function LineWithMark({ color, size }: IconProps) {
return (
<svg
viewBox="0 0 24 24"
width={size}
height={size}
stroke={color}
strokeWidth={3}
strokeLinecap="round"
fill="none"
>
<path d="M 1 12.5 L 7 12.5 M 17 12.5 L 23 12.5" />
<circle cx={12} cy={12.5} r={5} />
</svg>
);
}

function DashedLine({ color, size }: IconProps) {
return (
<svg
viewBox="0 0 24 24"
width={size}
height={size}
stroke={color}
strokeWidth={3}
fill="none"
>
<path d="M 1 12.5 L 23 12.5" strokeDasharray="5 3" />
</svg>
);
}

function MyCustomLegend() {
const { items } = useLegend();
return (
<Stack direction="row" gap={3}>
{items.map((item) => {
const { label, id, color, seriesId } = item;
return (
<Box key={id} sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
{seriesId === 'avg' ? (
<DashedLine color={color} size={20} />
) : (
<LineWithMark color={color} size={20} />
)}
<Typography sx={{ display: 'inline-block' }}>{`${label}`}</Typography>
</Box>
);
})}
</Stack>
);
}

const dataset = [
{ month: 'Jan', '1991_2020_avg': 4.1, 2023: 3.9 },
{ month: 'Fev', '1991_2020_avg': 4.7, 2023: 8.9 },
{ month: 'Mar', '1991_2020_avg': 7.5, 2023: 9.5 },
{ month: 'Apr', '1991_2020_avg': 10.6, 2023: 11.5 },
{ month: 'May', '1991_2020_avg': 13.8, 2023: 15.5 },
{ month: 'Jun', '1991_2020_avg': 16.7, 2023: 16.4 },
{ month: 'Jul', '1991_2020_avg': 18.9, 2023: 19.5 },
{ month: 'Aug', '1991_2020_avg': 18.8, 2023: 20.5 },
{ month: 'Sep', '1991_2020_avg': 15.8, 2023: 16.4 },
{ month: 'Oct', '1991_2020_avg': 11.9, 2023: 13.2 },
{ month: 'Nov', '1991_2020_avg': 7.6, 2023: 8.1 },
{ month: 'Dec', '1991_2020_avg': 4.7, 2023: 6.1 },
];

export default function CustomLegend() {
const theme = useTheme();

return (
<Box
sx={{ height: 300, width: '100%', display: 'flex', flexDirection: 'column' }}
>
<LineChart
dataset={dataset}
series={[
{
id: 'avg',
label: 'temp. avg. 1991-2020 (°C)',
dataKey: '1991_2020_avg',
showMark: false,
color: theme.palette.text.primary,
},
{
id: '2023-temp',
label: 'temp. 2023 (°C)',
dataKey: '2023',
color: theme.palette.primary.main,
},
]}
xAxis={[{ dataKey: 'month', scaleType: 'band', id: 'x-axis' }]}
sx={{
[`& .MuiLineElement-series-avg`]: {
strokeDasharray: '10 5',
},
}}
slots={{ legend: MyCustomLegend }}
/>
</Box>
);
}
13 changes: 11 additions & 2 deletions docs/data/charts/legend/legend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ In chart components, the legend links series with `label` properties and their c

This section explains how to customize the legend using classes and properties.

In order to fully customize the legend with custom components, see an example at the [HTML components docs](/x/react-charts/components/#html-components).

### Dimensions

Much of the customization can be done using CSS properties.
Expand Down Expand Up @@ -80,6 +78,17 @@ Make sure that the legend container has a fixed height or width to enable scroll

{{"demo": "ScrollableLegend.js"}}

### Custom component

For advanced customization, you can create your own legend with `useLegend`.
This hook returns the items that the default legend would plot.
Allowing you to focus on the rendering.

This demo show how to use it with slots.
Another demo in [HTML components docs](/x/react-charts/components/#html-components) shows how to use it with composition.

{{"demo": "CustomLegend.js"}}

## Color legend

To display legend associated to a [colorMap](https://mui.com/x/react-charts/styling/#values-color), you can use:
Expand Down
Loading