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.

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

[charts] Defaultize axis on top level useChartContainerProps #13817

Merged
merged 1 commit into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ const ChartContainerPro = React.forwardRef(function ChartContainer(
zAxisContextProps,
highlightedProviderProps,
chartsSurfaceProps,
xAxis,
yAxis,
} = useChartContainerProps(props, ref);

useLicenseVerifier('x-charts-pro', releaseInfo);
Expand All @@ -41,7 +43,7 @@ const ChartContainerPro = React.forwardRef(function ChartContainer(
<DrawingProvider {...drawingProviderProps}>
<ColorProvider {...colorProviderProps}>
<SeriesContextProvider {...seriesContextProps}>
<ZoomProvider xAxis={props.xAxis} yAxis={props.yAxis}>
<ZoomProvider xAxis={xAxis} yAxis={yAxis}>
<CartesianContextProviderPro {...cartesianContextProps}>
<ZAxisContextProvider {...zAxisContextProps}>
<InteractionProvider>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,43 @@ import {
} from '@mui/x-charts/internals';
import { useZoom } from '../ZoomProvider/useZoom';

const { normalizeAxis, computeValue } = cartesianProviderUtils;
const { computeValue } = cartesianProviderUtils;

export interface CartesianContextProviderProProps extends CartesianContextProviderProps {}

function CartesianContextProviderPro(props: CartesianContextProviderProProps) {
const {
xAxis: inXAxis,
yAxis: inYAxis,
dataset,
xExtremumGetters,
yExtremumGetters,
children,
} = props;
const { xAxis, yAxis, dataset, xExtremumGetters, yExtremumGetters, children } = props;

const formattedSeries = useSeries();
const drawingArea = useDrawingArea();
const { zoomData } = useZoom();

const xAxis = React.useMemo(() => normalizeAxis(inXAxis, dataset, 'x'), [inXAxis, dataset]);

const yAxis = React.useMemo(() => normalizeAxis(inYAxis, dataset, 'y'), [inYAxis, dataset]);

const xValues = React.useMemo(
() => computeValue(drawingArea, formattedSeries, xAxis, xExtremumGetters, 'x', zoomData),
[drawingArea, formattedSeries, xAxis, xExtremumGetters, zoomData],
() =>
computeValue({
drawingArea,
formattedSeries,
axis: xAxis,
extremumGetters: xExtremumGetters,
dataset,
axisDirection: 'x',
zoomData,
}),
[drawingArea, formattedSeries, xAxis, xExtremumGetters, dataset, zoomData],
);

const yValues = React.useMemo(
() => computeValue(drawingArea, formattedSeries, yAxis, yExtremumGetters, 'y', zoomData),
[drawingArea, formattedSeries, yAxis, yExtremumGetters, zoomData],
() =>
computeValue({
drawingArea,
formattedSeries,
axis: yAxis,
extremumGetters: yExtremumGetters,
dataset,
axisDirection: 'y',
zoomData,
}),
[drawingArea, formattedSeries, yAxis, yExtremumGetters, dataset, zoomData],
);

const value = React.useMemo(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,6 @@ export type DefaultizedZoomOptions = Required<ZoomOptions> & {
};

export type AxisConfigForZoom = {
id?: AxisId;
id: AxisId;
zoom?: ZoomOptions | boolean;
};
12 changes: 3 additions & 9 deletions packages/x-charts-pro/src/context/ZoomProvider/ZoomProvider.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
import * as React from 'react';
import { cartesianProviderUtils } from '@mui/x-charts/internals';
import { ZoomContext, ZoomState } from './ZoomContext';
import { defaultizeZoom } from './defaultizeZoom';
import { AxisConfigForZoom, ZoomData } from './Zoom.types';

const { defaultizeAxis } = cartesianProviderUtils;

type ZoomProviderProps = {
children: React.ReactNode;
/**
Expand All @@ -22,22 +19,19 @@ type ZoomProviderProps = {
yAxis?: AxisConfigForZoom[];
};

export function ZoomProvider({ children, xAxis: inXAxis, yAxis: inYAxis }: ZoomProviderProps) {
export function ZoomProvider({ children, xAxis, yAxis }: ZoomProviderProps) {
const [isInteracting, setIsInteracting] = React.useState<boolean>(false);

const options = React.useMemo(
() =>
[
...defaultizeZoom(defaultizeAxis(inXAxis, 'x'), 'x'),
...defaultizeZoom(defaultizeAxis(inYAxis, 'y'), 'y'),
].reduce(
[...defaultizeZoom(xAxis, 'x'), ...defaultizeZoom(yAxis, 'y')].reduce(
(acc, v) => {
acc[v.axisId] = v;
return acc;
},
{} as ZoomState['options'],
),
[inXAxis, inYAxis],
[xAxis, yAxis],
);

const [zoomData, setZoomData] = React.useState<ZoomData[]>(() =>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { MakeRequired, isDefined } from '@mui/x-charts/internals';
import { isDefined } from '@mui/x-charts/internals';
import { AxisConfigForZoom, DefaultizedZoomOptions } from './Zoom.types';

const defaultZoomOptions = {
Expand All @@ -11,7 +11,7 @@ const defaultZoomOptions = {
};

export const defaultizeZoom = (
axis: MakeRequired<AxisConfigForZoom, 'id'>[] | undefined,
axis: AxisConfigForZoom[] | undefined,
axisDirection: 'x' | 'y',
): DefaultizedZoomOptions[] => {
if (!axis) {
Expand Down
16 changes: 15 additions & 1 deletion packages/x-charts/src/ChartContainer/ChartContainer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,30 @@ import {
import { ChartsPluginType } from '../models/plugin';
import { ChartSeriesType } from '../models/seriesType/config';
import { useChartContainerProps } from './useChartContainerProps';
import { AxisConfig, ChartsXAxisProps, ChartsYAxisProps, ScaleName } from '../models/axis';
import { MakeOptional } from '../models/helpers';

export type ChartContainerProps = Omit<
ChartsSurfaceProps &
Omit<SeriesContextProviderProps, 'seriesFormatters'> &
Omit<DrawingProviderProps, 'svgRef'> &
Omit<CartesianContextProviderProps, 'xExtremumGetters' | 'yExtremumGetters'> &
Pick<CartesianContextProviderProps, 'dataset'> &
ZAxisContextProviderProps &
HighlightedProviderProps,
'children'
> & {
/**
* The configuration of the x-axes.
* If not provided, a default axis config is used.
* An array of [[AxisConfig]] objects.
*/
xAxis?: MakeOptional<AxisConfig<ScaleName, any, ChartsXAxisProps>, 'id'>[];
/**
* The configuration of the y-axes.
* If not provided, a default axis config is used.
* An array of [[AxisConfig]] objects.
*/
yAxis?: MakeOptional<AxisConfig<ScaleName, any, ChartsYAxisProps>, 'id'>[];
children?: React.ReactNode;
/**
* An array of plugins defining how to preprocess data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import type { ChartContainerProps } from './ChartContainer';
import { useChartContainerHooks } from './useChartContainerHooks';
import { HighlightedProviderProps } from '../context';
import { ChartsSurfaceProps } from '../ChartsSurface';
import { useDefaultizeAxis } from './useDefaultizeAxis';

export const useChartContainerProps = (
props: ChartContainerProps,
Expand Down Expand Up @@ -43,6 +44,8 @@ export const useChartContainerProps = (
colorProcessors,
} = useChartContainerHooks(ref, plugins);

const [defaultizedXAxis, defaultizedYAxis] = useDefaultizeAxis(xAxis, yAxis);

const drawingProviderProps: Omit<DrawingProviderProps, 'children'> = {
width,
height,
Expand All @@ -62,8 +65,8 @@ export const useChartContainerProps = (
};

const cartesianContextProps: Omit<CartesianContextProviderProps, 'children'> = {
xAxis,
yAxis,
xAxis: defaultizedXAxis,
yAxis: defaultizedYAxis,
dataset,
xExtremumGetters,
yExtremumGetters,
Expand Down Expand Up @@ -99,5 +102,7 @@ export const useChartContainerProps = (
zAxisContextProps,
highlightedProviderProps,
chartsSurfaceProps,
xAxis: defaultizedXAxis,
yAxis: defaultizedYAxis,
};
};
30 changes: 30 additions & 0 deletions packages/x-charts/src/ChartContainer/useDefaultizeAxis.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import * as React from 'react';
import { DEFAULT_X_AXIS_KEY, DEFAULT_Y_AXIS_KEY } from '../constants';
import { MakeOptional } from '../models/helpers';
import { AxisConfig, ScaleName } from '../models';
import { ChartsAxisProps } from '../models/axis';

const defaultizeAxis = (
inAxis: MakeOptional<AxisConfig<ScaleName, any, ChartsAxisProps>, 'id'>[] | undefined,
axisName: 'x' | 'y',
) => {
const DEFAULT_AXIS_KEY = axisName === 'x' ? DEFAULT_X_AXIS_KEY : DEFAULT_Y_AXIS_KEY;

return [
...(inAxis?.map((axis, index) => ({ id: `defaultized-${axisName}-axis-${index}`, ...axis })) ??
[]),
...(inAxis === undefined || inAxis.findIndex(({ id }) => id === DEFAULT_AXIS_KEY) === -1
? [{ id: DEFAULT_AXIS_KEY, scaleType: 'linear' as const }]
: []),
];
};

export const useDefaultizeAxis = (
inXAxis: MakeOptional<AxisConfig<ScaleName, any, ChartsAxisProps>, 'id'>[] | undefined,
inYAxis: MakeOptional<AxisConfig<ScaleName, any, ChartsAxisProps>, 'id'>[] | undefined,
) => {
const xAxis = React.useMemo(() => defaultizeAxis(inXAxis, 'x'), [inXAxis]);
const yAxis = React.useMemo(() => defaultizeAxis(inYAxis, 'y'), [inYAxis]);

return [xAxis, yAxis];
};
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import * as React from 'react';
import { AxisConfig, ChartsXAxisProps, ChartsYAxisProps, ScaleName } from '../../models/axis';
import { DatasetType } from '../../models/seriesType/config';
import { MakeOptional } from '../../models/helpers';
import { useDrawingArea } from '../../hooks/useDrawingArea';
import { useSeries } from '../../hooks/useSeries';
import { CartesianContext } from './CartesianContext';
import { normalizeAxis } from './normalizeAxis';
import { computeValue } from './computeValue';
import { ExtremumGettersConfig } from '../../models';

Expand All @@ -15,13 +13,13 @@ export type CartesianContextProviderProps = {
* If not provided, a default axis config is used.
* An array of [[AxisConfig]] objects.
*/
xAxis?: MakeOptional<AxisConfig<ScaleName, any, ChartsXAxisProps>, 'id'>[];
xAxis: AxisConfig<ScaleName, any, ChartsXAxisProps>[];
/**
* The configuration of the y-axes.
* If not provided, a default axis config is used.
* An array of [[AxisConfig]] objects.
*/
yAxis?: MakeOptional<AxisConfig<ScaleName, any, ChartsYAxisProps>, 'id'>[];
yAxis: AxisConfig<ScaleName, any, ChartsYAxisProps>[];
/**
* An array of objects that can be used to populate series and axes data using their `dataKey` property.
*/
Expand All @@ -38,30 +36,35 @@ export type CartesianContextProviderProps = {
};

function CartesianContextProvider(props: CartesianContextProviderProps) {
const {
xAxis: inXAxis,
yAxis: inYAxis,
dataset,
xExtremumGetters,
yExtremumGetters,
children,
} = props;
const { xAxis, yAxis, dataset, xExtremumGetters, yExtremumGetters, children } = props;

const formattedSeries = useSeries();
const drawingArea = useDrawingArea();

const xAxis = React.useMemo(() => normalizeAxis(inXAxis, dataset, 'x'), [inXAxis, dataset]);

const yAxis = React.useMemo(() => normalizeAxis(inYAxis, dataset, 'y'), [inYAxis, dataset]);

const xValues = React.useMemo(
() => computeValue(drawingArea, formattedSeries, xAxis, xExtremumGetters, 'x'),
[drawingArea, formattedSeries, xAxis, xExtremumGetters],
() =>
computeValue({
drawingArea,
formattedSeries,
axis: xAxis,
extremumGetters: xExtremumGetters,
dataset,
axisDirection: 'x',
}),
[drawingArea, formattedSeries, xAxis, xExtremumGetters, dataset],
);

const yValues = React.useMemo(
() => computeValue(drawingArea, formattedSeries, yAxis, yExtremumGetters, 'y'),
[drawingArea, formattedSeries, yAxis, yExtremumGetters],
() =>
computeValue({
drawingArea,
formattedSeries,
axis: yAxis,
extremumGetters: yExtremumGetters,
dataset,
axisDirection: 'y',
}),
[drawingArea, formattedSeries, yAxis, yExtremumGetters, dataset],
);

const value = React.useMemo(
Expand Down
Loading