@mui/x-charts 7.7.0 → 7.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/BarChart/BarChart.js +21 -104
  2. package/BarChart/BarLabel/BarLabelPlot.d.ts +0 -3
  3. package/BarChart/BarLabel/BarLabelPlot.js +1 -24
  4. package/BarChart/BarPlot.js +2 -2
  5. package/BarChart/checkScaleErrors.d.ts +5 -9
  6. package/BarChart/types.d.ts +2 -2
  7. package/BarChart/useBarChartProps.d.ts +102 -0
  8. package/BarChart/useBarChartProps.js +143 -0
  9. package/CHANGELOG.md +82 -0
  10. package/ChartContainer/ChartContainer.d.ts +1 -1
  11. package/ChartContainer/ChartContainer.js +6 -10
  12. package/ChartContainer/useChartContainerHooks.d.ts +11 -0
  13. package/ChartContainer/useChartContainerHooks.js +34 -0
  14. package/ChartContainer/usePluginsMerge.d.ts +1 -2
  15. package/ChartsAxis/ChartsAxis.js +2 -2
  16. package/ChartsAxisHighlight/ChartsAxisHighlight.js +2 -2
  17. package/ChartsGrid/ChartsGrid.js +2 -2
  18. package/ChartsOnAxisClickHandler/ChartsOnAxisClickHandler.js +2 -2
  19. package/ChartsTooltip/ChartsAxisTooltipContent.js +2 -2
  20. package/ChartsTooltip/ChartsItemTooltipContent.js +2 -2
  21. package/ChartsVoronoiHandler/ChartsVoronoiHandler.js +2 -2
  22. package/ChartsXAxis/ChartsXAxis.js +2 -2
  23. package/ChartsYAxis/ChartsYAxis.js +2 -2
  24. package/LineChart/AreaPlot.js +2 -2
  25. package/LineChart/LineChart.js +24 -106
  26. package/LineChart/LineHighlightPlot.js +2 -2
  27. package/LineChart/LinePlot.js +2 -2
  28. package/LineChart/MarkPlot.js +2 -2
  29. package/LineChart/useLineChartProps.d.ts +117 -0
  30. package/LineChart/useLineChartProps.js +152 -0
  31. package/ScatterChart/ScatterChart.js +20 -75
  32. package/ScatterChart/ScatterPlot.js +2 -2
  33. package/ScatterChart/useScatterChartProps.d.ts +86 -0
  34. package/ScatterChart/useScatterChartProps.js +116 -0
  35. package/context/CartesianProvider/CartesianContext.d.ts +25 -0
  36. package/context/CartesianProvider/CartesianContext.js +21 -0
  37. package/context/CartesianProvider/CartesianProvider.d.ts +34 -0
  38. package/context/CartesianProvider/CartesianProvider.js +44 -0
  39. package/context/CartesianProvider/computeValue.d.ts +19 -0
  40. package/context/CartesianProvider/computeValue.js +89 -0
  41. package/context/CartesianProvider/getAxisExtremum.d.ts +4 -0
  42. package/context/CartesianProvider/getAxisExtremum.js +28 -0
  43. package/context/CartesianProvider/index.d.ts +9 -0
  44. package/context/CartesianProvider/index.js +51 -0
  45. package/context/CartesianProvider/normalizeAxis.d.ts +5 -0
  46. package/context/CartesianProvider/normalizeAxis.js +23 -0
  47. package/context/CartesianProvider/useCartesianContext.d.ts +2 -0
  48. package/context/CartesianProvider/useCartesianContext.js +17 -0
  49. package/context/ColorProvider.d.ts +2 -2
  50. package/esm/BarChart/BarChart.js +21 -104
  51. package/esm/BarChart/BarLabel/BarLabelPlot.js +0 -23
  52. package/esm/BarChart/BarPlot.js +2 -2
  53. package/esm/BarChart/useBarChartProps.js +136 -0
  54. package/esm/ChartContainer/ChartContainer.js +5 -9
  55. package/esm/ChartContainer/useChartContainerHooks.js +24 -0
  56. package/esm/ChartsAxis/ChartsAxis.js +2 -2
  57. package/esm/ChartsAxisHighlight/ChartsAxisHighlight.js +2 -2
  58. package/esm/ChartsGrid/ChartsGrid.js +2 -2
  59. package/esm/ChartsOnAxisClickHandler/ChartsOnAxisClickHandler.js +2 -2
  60. package/esm/ChartsTooltip/ChartsAxisTooltipContent.js +2 -2
  61. package/esm/ChartsTooltip/ChartsItemTooltipContent.js +2 -2
  62. package/esm/ChartsVoronoiHandler/ChartsVoronoiHandler.js +2 -2
  63. package/esm/ChartsXAxis/ChartsXAxis.js +2 -2
  64. package/esm/ChartsYAxis/ChartsYAxis.js +2 -2
  65. package/esm/LineChart/AreaPlot.js +2 -2
  66. package/esm/LineChart/LineChart.js +24 -106
  67. package/esm/LineChart/LineHighlightPlot.js +2 -2
  68. package/esm/LineChart/LinePlot.js +2 -2
  69. package/esm/LineChart/MarkPlot.js +2 -2
  70. package/esm/LineChart/useLineChartProps.js +144 -0
  71. package/esm/ScatterChart/ScatterChart.js +20 -75
  72. package/esm/ScatterChart/ScatterPlot.js +2 -2
  73. package/esm/ScatterChart/useScatterChartProps.js +108 -0
  74. package/esm/context/CartesianProvider/CartesianContext.js +13 -0
  75. package/esm/context/CartesianProvider/CartesianProvider.js +37 -0
  76. package/esm/context/CartesianProvider/computeValue.js +82 -0
  77. package/esm/context/CartesianProvider/getAxisExtremum.js +21 -0
  78. package/esm/context/CartesianProvider/index.js +10 -0
  79. package/esm/context/CartesianProvider/normalizeAxis.js +15 -0
  80. package/esm/context/CartesianProvider/useCartesianContext.js +8 -0
  81. package/esm/hooks/useAxisEvents.js +2 -2
  82. package/esm/hooks/useColorScale.js +3 -3
  83. package/esm/hooks/useScale.js +3 -4
  84. package/esm/internals/components/ChartsAxesGradients/ChartsAxesGradients.js +2 -2
  85. package/esm/internals/index.js +6 -2
  86. package/hooks/useAxisEvents.js +2 -2
  87. package/hooks/useColorScale.js +3 -3
  88. package/hooks/useDrawingArea.d.ts +2 -8
  89. package/hooks/useScale.js +3 -6
  90. package/index.js +1 -1
  91. package/internals/components/ChartsAxesGradients/ChartsAxesGradients.d.ts +2 -1
  92. package/internals/components/ChartsAxesGradients/ChartsAxesGradients.js +2 -2
  93. package/internals/index.d.ts +7 -1
  94. package/internals/index.js +49 -5
  95. package/models/plugin.d.ts +4 -1
  96. package/modern/BarChart/BarChart.js +21 -104
  97. package/modern/BarChart/BarLabel/BarLabelPlot.js +0 -23
  98. package/modern/BarChart/BarPlot.js +2 -2
  99. package/modern/BarChart/useBarChartProps.js +136 -0
  100. package/modern/ChartContainer/ChartContainer.js +5 -9
  101. package/modern/ChartContainer/useChartContainerHooks.js +24 -0
  102. package/modern/ChartsAxis/ChartsAxis.js +2 -2
  103. package/modern/ChartsAxisHighlight/ChartsAxisHighlight.js +2 -2
  104. package/modern/ChartsGrid/ChartsGrid.js +2 -2
  105. package/modern/ChartsOnAxisClickHandler/ChartsOnAxisClickHandler.js +2 -2
  106. package/modern/ChartsTooltip/ChartsAxisTooltipContent.js +2 -2
  107. package/modern/ChartsTooltip/ChartsItemTooltipContent.js +2 -2
  108. package/modern/ChartsVoronoiHandler/ChartsVoronoiHandler.js +2 -2
  109. package/modern/ChartsXAxis/ChartsXAxis.js +2 -2
  110. package/modern/ChartsYAxis/ChartsYAxis.js +2 -2
  111. package/modern/LineChart/AreaPlot.js +2 -2
  112. package/modern/LineChart/LineChart.js +24 -106
  113. package/modern/LineChart/LineHighlightPlot.js +2 -2
  114. package/modern/LineChart/LinePlot.js +2 -2
  115. package/modern/LineChart/MarkPlot.js +2 -2
  116. package/modern/LineChart/useLineChartProps.js +144 -0
  117. package/modern/ScatterChart/ScatterChart.js +20 -75
  118. package/modern/ScatterChart/ScatterPlot.js +2 -2
  119. package/modern/ScatterChart/useScatterChartProps.js +108 -0
  120. package/modern/context/CartesianProvider/CartesianContext.js +13 -0
  121. package/modern/context/CartesianProvider/CartesianProvider.js +37 -0
  122. package/modern/context/CartesianProvider/computeValue.js +82 -0
  123. package/modern/context/CartesianProvider/getAxisExtremum.js +21 -0
  124. package/modern/context/CartesianProvider/index.js +10 -0
  125. package/modern/context/CartesianProvider/normalizeAxis.js +15 -0
  126. package/modern/context/CartesianProvider/useCartesianContext.js +8 -0
  127. package/modern/hooks/useAxisEvents.js +2 -2
  128. package/modern/hooks/useColorScale.js +3 -3
  129. package/modern/hooks/useScale.js +3 -4
  130. package/modern/index.js +1 -1
  131. package/modern/internals/components/ChartsAxesGradients/ChartsAxesGradients.js +2 -2
  132. package/modern/internals/index.js +6 -2
  133. package/package.json +3 -3
  134. package/context/CartesianContextProvider.d.ts +0 -61
  135. package/context/CartesianContextProvider.js +0 -220
  136. package/esm/context/CartesianContextProvider.js +0 -211
  137. package/modern/context/CartesianContextProvider.js +0 -211
@@ -0,0 +1,82 @@
1
+ import _extends from "@babel/runtime/helpers/esm/extends";
2
+ import { scaleBand, scalePoint } from 'd3-scale';
3
+ import { DEFAULT_X_AXIS_KEY, DEFAULT_Y_AXIS_KEY } from '../../constants';
4
+ import { isBandScaleConfig, isPointScaleConfig } from '../../models/axis';
5
+ import { getColorScale, getOrdinalColorScale } from '../../internals/colorScale';
6
+ import { getTickNumber } from '../../hooks/useTicks';
7
+ import { getScale } from '../../internals/getScale';
8
+ import { getAxisExtremum } from './getAxisExtremum';
9
+ const getRange = (drawingArea, axisName, isReverse) => {
10
+ const range = axisName === 'x' ? [drawingArea.left, drawingArea.left + drawingArea.width] : [drawingArea.top + drawingArea.height, drawingArea.top];
11
+ return isReverse ? range.reverse() : range;
12
+ };
13
+ const DEFAULT_CATEGORY_GAP_RATIO = 0.2;
14
+ const DEFAULT_BAR_GAP_RATIO = 0.1;
15
+ export function computeValue(drawingArea, formattedSeries, inAxis, extremumGetters, axisName) {
16
+ const DEFAULT_AXIS_KEY = axisName === 'x' ? DEFAULT_X_AXIS_KEY : DEFAULT_Y_AXIS_KEY;
17
+ const allAxis = [...(inAxis?.map((axis, index) => _extends({
18
+ id: `defaultized-${axisName}-axis-${index}`
19
+ }, axis)) ?? []), ...(inAxis === undefined || inAxis.findIndex(({
20
+ id
21
+ }) => id === DEFAULT_AXIS_KEY) === -1 ? [{
22
+ id: DEFAULT_AXIS_KEY,
23
+ scaleType: 'linear'
24
+ }] : [])];
25
+ const completeAxis = {};
26
+ allAxis.forEach((axis, axisIndex) => {
27
+ const isDefaultAxis = axisIndex === 0;
28
+ const [minData, maxData] = getAxisExtremum(axis, extremumGetters, isDefaultAxis, formattedSeries);
29
+ const range = getRange(drawingArea, axisName, axis.reverse);
30
+ if (isBandScaleConfig(axis)) {
31
+ const categoryGapRatio = axis.categoryGapRatio ?? DEFAULT_CATEGORY_GAP_RATIO;
32
+ const barGapRatio = axis.barGapRatio ?? DEFAULT_BAR_GAP_RATIO;
33
+ // Reverse range because ordinal scales are presented from top to bottom on y-axis
34
+ const scaleRange = axisName === 'x' ? range : [range[1], range[0]];
35
+ completeAxis[axis.id] = _extends({
36
+ categoryGapRatio,
37
+ barGapRatio
38
+ }, axis, {
39
+ scale: scaleBand(axis.data, scaleRange).paddingInner(categoryGapRatio).paddingOuter(categoryGapRatio / 2),
40
+ tickNumber: axis.data.length,
41
+ colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? getOrdinalColorScale(_extends({
42
+ values: axis.data
43
+ }, axis.colorMap)) : getColorScale(axis.colorMap))
44
+ });
45
+ }
46
+ if (isPointScaleConfig(axis)) {
47
+ const scaleRange = axisName === 'x' ? range : [...range].reverse();
48
+ completeAxis[axis.id] = _extends({}, axis, {
49
+ scale: scalePoint(axis.data, scaleRange),
50
+ tickNumber: axis.data.length,
51
+ colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? getOrdinalColorScale(_extends({
52
+ values: axis.data
53
+ }, axis.colorMap)) : getColorScale(axis.colorMap))
54
+ });
55
+ }
56
+ if (axis.scaleType === 'band' || axis.scaleType === 'point') {
57
+ // Could be merged with the two previous "if conditions" but then TS does not get that `axis.scaleType` can't be `band` or `point`.
58
+ return;
59
+ }
60
+ const scaleType = axis.scaleType ?? 'linear';
61
+ const extremums = [axis.min ?? minData, axis.max ?? maxData];
62
+ const tickNumber = getTickNumber(_extends({}, axis, {
63
+ range,
64
+ domain: extremums
65
+ }));
66
+ const scale = getScale(scaleType, extremums, range).nice(tickNumber);
67
+ const [minDomain, maxDomain] = scale.domain();
68
+ const domain = [axis.min ?? minDomain, axis.max ?? maxDomain];
69
+ completeAxis[axis.id] = _extends({}, axis, {
70
+ scaleType: scaleType,
71
+ scale: scale.domain(domain),
72
+ tickNumber,
73
+ colorScale: axis.colorMap && getColorScale(axis.colorMap)
74
+ });
75
+ });
76
+ return {
77
+ axis: completeAxis,
78
+ axisIds: allAxis.map(({
79
+ id
80
+ }) => id)
81
+ };
82
+ }
@@ -0,0 +1,21 @@
1
+ const axisExtremumCallback = (acc, chartType, axis, getters, isDefaultAxis, formattedSeries) => {
2
+ const getter = getters[chartType];
3
+ const series = formattedSeries[chartType]?.series ?? {};
4
+ const [minChartTypeData, maxChartTypeData] = getter?.({
5
+ series,
6
+ axis,
7
+ isDefaultAxis
8
+ }) ?? [null, null];
9
+ const [minData, maxData] = acc;
10
+ if (minData === null || maxData === null) {
11
+ return [minChartTypeData, maxChartTypeData];
12
+ }
13
+ if (minChartTypeData === null || maxChartTypeData === null) {
14
+ return [minData, maxData];
15
+ }
16
+ return [Math.min(minChartTypeData, minData), Math.max(maxChartTypeData, maxData)];
17
+ };
18
+ export const getAxisExtremum = (axis, getters, isDefaultAxis, formattedSeries) => {
19
+ const charTypes = Object.keys(getters);
20
+ return charTypes.reduce((acc, charType) => axisExtremumCallback(acc, charType, axis, getters, isDefaultAxis, formattedSeries), [null, null]);
21
+ };
@@ -0,0 +1,10 @@
1
+ import { computeValue } from './computeValue';
2
+ import { normalizeAxis } from './normalizeAxis';
3
+ export * from './CartesianProvider';
4
+ export * from './CartesianContext';
5
+ export * from './useCartesianContext';
6
+ const cartesianProviderUtils = {
7
+ computeValue,
8
+ normalizeAxis
9
+ };
10
+ export { cartesianProviderUtils };
@@ -0,0 +1,15 @@
1
+ import _extends from "@babel/runtime/helpers/esm/extends";
2
+ export const normalizeAxis = (axis, dataset, axisName) => {
3
+ return axis?.map(axisConfig => {
4
+ const dataKey = axisConfig.dataKey;
5
+ if (dataKey === undefined || axisConfig.data !== undefined) {
6
+ return axisConfig;
7
+ }
8
+ if (dataset === undefined) {
9
+ throw Error(`MUI X Charts: ${axisName}-axis uses \`dataKey\` but no \`dataset\` is provided.`);
10
+ }
11
+ return _extends({}, axisConfig, {
12
+ data: dataset.map(d => d[dataKey])
13
+ });
14
+ });
15
+ };
@@ -0,0 +1,8 @@
1
+ import * as React from 'react';
2
+ import { CartesianContext } from './CartesianContext';
3
+ export const useCartesianContext = () => {
4
+ const {
5
+ data
6
+ } = React.useContext(CartesianContext);
7
+ return data;
8
+ };
@@ -1,6 +1,6 @@
1
1
  import * as React from 'react';
2
2
  import { InteractionContext } from '../context/InteractionProvider';
3
- import { CartesianContext } from '../context/CartesianContextProvider';
3
+ import { useCartesianContext } from '../context/CartesianProvider';
4
4
  import { isBandScale } from '../internals/isBandScale';
5
5
  import { getSVGPoint } from '../internals/utils';
6
6
  import { useSvgRef } from './useSvgRef';
@@ -21,7 +21,7 @@ export const useAxisEvents = disableAxisListener => {
21
21
  yAxis,
22
22
  xAxisIds,
23
23
  yAxisIds
24
- } = React.useContext(CartesianContext);
24
+ } = useCartesianContext();
25
25
  const {
26
26
  dispatch
27
27
  } = React.useContext(InteractionContext);
@@ -1,11 +1,11 @@
1
1
  import * as React from 'react';
2
- import { CartesianContext } from '../context/CartesianContextProvider';
2
+ import { useCartesianContext } from '../context/CartesianProvider';
3
3
  import { ZAxisContext } from '../context/ZAxisContextProvider';
4
4
  export function useXColorScale(identifier) {
5
5
  const {
6
6
  xAxis,
7
7
  xAxisIds
8
- } = React.useContext(CartesianContext);
8
+ } = useCartesianContext();
9
9
  const id = typeof identifier === 'string' ? identifier : xAxisIds[identifier ?? 0];
10
10
  return xAxis[id].colorScale;
11
11
  }
@@ -13,7 +13,7 @@ export function useYColorScale(identifier) {
13
13
  const {
14
14
  yAxis,
15
15
  yAxisIds
16
- } = React.useContext(CartesianContext);
16
+ } = useCartesianContext();
17
17
  const id = typeof identifier === 'string' ? identifier : yAxisIds[identifier ?? 0];
18
18
  return yAxis[id].colorScale;
19
19
  }
@@ -1,5 +1,4 @@
1
- import * as React from 'react';
2
- import { CartesianContext } from '../context/CartesianContextProvider';
1
+ import { useCartesianContext } from '../context/CartesianProvider';
3
2
  import { isBandScale } from '../internals/isBandScale';
4
3
  /**
5
4
  * For a given scale return a function that map value to their position.
@@ -17,7 +16,7 @@ export function useXScale(identifier) {
17
16
  const {
18
17
  xAxis,
19
18
  xAxisIds
20
- } = React.useContext(CartesianContext);
19
+ } = useCartesianContext();
21
20
  const id = typeof identifier === 'string' ? identifier : xAxisIds[identifier ?? 0];
22
21
  return xAxis[id].scale;
23
22
  }
@@ -25,7 +24,7 @@ export function useYScale(identifier) {
25
24
  const {
26
25
  yAxis,
27
26
  yAxisIds
28
- } = React.useContext(CartesianContext);
27
+ } = useCartesianContext();
29
28
  const id = typeof identifier === 'string' ? identifier : yAxisIds[identifier ?? 0];
30
29
  return yAxis[id].scale;
31
30
  }
package/modern/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @mui/x-charts v7.7.0
2
+ * @mui/x-charts v7.7.1
3
3
  *
4
4
  * @license MIT
5
5
  * This source code is licensed under the MIT license found in the
@@ -1,5 +1,5 @@
1
1
  import * as React from 'react';
2
- import { CartesianContext } from '../../../context/CartesianContextProvider';
2
+ import { useCartesianContext } from '../../../context/CartesianProvider';
3
3
  import { DrawingContext } from '../../../context/DrawingProvider';
4
4
  import { useDrawingArea } from '../../../hooks';
5
5
  import ChartsPiecewiseGradient from './ChartsPiecewiseGradient';
@@ -28,7 +28,7 @@ export function ChartsAxesGradients() {
28
28
  xAxis,
29
29
  yAxisIds,
30
30
  yAxis
31
- } = React.useContext(CartesianContext);
31
+ } = useCartesianContext();
32
32
  return /*#__PURE__*/_jsxs("defs", {
33
33
  children: [yAxisIds.filter(axisId => yAxis[axisId].colorMap !== undefined).map(axisId => {
34
34
  const gradientId = getGradientId(axisId, 'y');
@@ -6,6 +6,10 @@ export * from '../ResponsiveChartContainer/ResizableContainer';
6
6
  // hooks
7
7
  export { useReducedMotion } from '../hooks/useReducedMotion';
8
8
  export { useSeries } from '../hooks/useSeries';
9
+ export { useChartContainerHooks } from '../ChartContainer/useChartContainerHooks';
10
+ export { useScatterChartProps } from '../ScatterChart/useScatterChartProps';
11
+ export { useLineChartProps } from '../LineChart/useLineChartProps';
12
+ export { useBarChartProps } from '../BarChart/useBarChartProps';
9
13
 
10
14
  // utils
11
15
  export * from './defaultizeValueFormatter';
@@ -13,12 +17,12 @@ export * from './configInit';
13
17
 
14
18
  // contexts
15
19
 
16
- export * from '../context/CartesianContextProvider';
20
+ export * from '../context/CartesianProvider';
17
21
  export * from '../context/DrawingProvider';
22
+ export * from '../context/ColorProvider';
18
23
  export * from '../context/InteractionProvider';
19
24
  export * from '../context/SeriesContextProvider';
20
25
  export * from '../context/ZAxisContextProvider';
21
-
22
26
  // series configuration
23
27
  export * from '../models/seriesType/config';
24
28
  export * from '../models/seriesType/common';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mui/x-charts",
3
- "version": "7.7.0",
3
+ "version": "7.7.1",
4
4
  "description": "The community edition of the Charts components (MUI X).",
5
5
  "author": "MUI Team",
6
6
  "main": "./index.js",
@@ -31,8 +31,8 @@
31
31
  "dependencies": {
32
32
  "@babel/runtime": "^7.24.7",
33
33
  "@mui/base": "^5.0.0-beta.40",
34
- "@mui/system": "^5.15.15",
35
- "@mui/utils": "^5.15.14",
34
+ "@mui/system": "^5.15.20",
35
+ "@mui/utils": "^5.15.20",
36
36
  "@react-spring/rafz": "^9.7.3",
37
37
  "@react-spring/web": "^9.7.3",
38
38
  "clsx": "^2.1.1",
@@ -1,61 +0,0 @@
1
- import * as React from 'react';
2
- import { AxisConfig, AxisDefaultized, ChartsXAxisProps, ChartsYAxisProps, ScaleName } from '../models/axis';
3
- import { CartesianChartSeriesType, ChartSeriesType, DatasetType, ExtremumGetter } from '../models/seriesType/config';
4
- import { MakeOptional } from '../models/helpers';
5
- export type ExtremumGettersConfig<T extends ChartSeriesType = CartesianChartSeriesType> = {
6
- [K in T]?: ExtremumGetter<K>;
7
- };
8
- export type CartesianContextProviderProps = {
9
- /**
10
- * The configuration of the x-axes.
11
- * If not provided, a default axis config is used.
12
- * An array of [[AxisConfig]] objects.
13
- */
14
- xAxis?: MakeOptional<AxisConfig<ScaleName, any, ChartsXAxisProps>, 'id'>[];
15
- /**
16
- * The configuration of the y-axes.
17
- * If not provided, a default axis config is used.
18
- * An array of [[AxisConfig]] objects.
19
- */
20
- yAxis?: MakeOptional<AxisConfig<ScaleName, any, ChartsYAxisProps>, 'id'>[];
21
- /**
22
- * An array of objects that can be used to populate series and axes data using their `dataKey` property.
23
- */
24
- dataset?: DatasetType;
25
- /**
26
- * An object with x-axis extremum getters per series type.
27
- */
28
- xExtremumGetters: ExtremumGettersConfig;
29
- /**
30
- * An object with y-axis extremum getters per series type.
31
- */
32
- yExtremumGetters: ExtremumGettersConfig;
33
- children: React.ReactNode;
34
- };
35
- type DefaultizedAxisConfig<AxisProps> = {
36
- [axisKey: string]: AxisDefaultized<ScaleName, any, AxisProps>;
37
- };
38
- export declare const CartesianContext: React.Context<{
39
- /**
40
- * Mapping from x-axis key to scaling configuration.
41
- */
42
- xAxis: {
43
- DEFAULT_X_AXIS_KEY: AxisDefaultized<ScaleName, any, ChartsXAxisProps>;
44
- } & DefaultizedAxisConfig<ChartsXAxisProps>;
45
- /**
46
- * Mapping from y-axis key to scaling configuration.
47
- */
48
- yAxis: {
49
- DEFAULT_X_AXIS_KEY: AxisDefaultized<ScaleName, any, ChartsYAxisProps>;
50
- } & DefaultizedAxisConfig<ChartsYAxisProps>;
51
- /**
52
- * The x-axes IDs sorted by order they got provided.
53
- */
54
- xAxisIds: string[];
55
- /**
56
- * The y-axes IDs sorted by order they got provided.
57
- */
58
- yAxisIds: string[];
59
- }>;
60
- declare function CartesianContextProvider(props: CartesianContextProviderProps): React.JSX.Element;
61
- export { CartesianContextProvider };
@@ -1,220 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports.CartesianContext = void 0;
8
- exports.CartesianContextProvider = CartesianContextProvider;
9
- var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
10
- var React = _interopRequireWildcard(require("react"));
11
- var _d3Scale = require("d3-scale");
12
- var _axis = require("../models/axis");
13
- var _getScale = require("../internals/getScale");
14
- var _constants = require("../constants");
15
- var _useTicks = require("../hooks/useTicks");
16
- var _useDrawingArea = require("../hooks/useDrawingArea");
17
- var _colorScale = require("../internals/colorScale");
18
- var _useSeries = require("../hooks/useSeries");
19
- var _jsxRuntime = require("react/jsx-runtime");
20
- function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
21
- function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
22
- const DEFAULT_CATEGORY_GAP_RATIO = 0.2;
23
- const DEFAULT_BAR_GAP_RATIO = 0.1;
24
- const CartesianContext = exports.CartesianContext = /*#__PURE__*/React.createContext({
25
- xAxis: {},
26
- yAxis: {},
27
- xAxisIds: [],
28
- yAxisIds: []
29
- });
30
- if (process.env.NODE_ENV !== 'production') {
31
- CartesianContext.displayName = 'CartesianContext';
32
- }
33
- function CartesianContextProvider(props) {
34
- const {
35
- xAxis: inXAxis,
36
- yAxis: inYAxis,
37
- dataset,
38
- xExtremumGetters,
39
- yExtremumGetters,
40
- children
41
- } = props;
42
- const formattedSeries = (0, _useSeries.useSeries)();
43
- const drawingArea = (0, _useDrawingArea.useDrawingArea)();
44
- const xAxis = React.useMemo(() => inXAxis?.map(axisConfig => {
45
- const dataKey = axisConfig.dataKey;
46
- if (dataKey === undefined || axisConfig.data !== undefined) {
47
- return axisConfig;
48
- }
49
- if (dataset === undefined) {
50
- throw Error('MUI X Charts: x-axis uses `dataKey` but no `dataset` is provided.');
51
- }
52
- return (0, _extends2.default)({}, axisConfig, {
53
- data: dataset.map(d => d[dataKey])
54
- });
55
- }), [inXAxis, dataset]);
56
- const yAxis = React.useMemo(() => inYAxis?.map(axisConfig => {
57
- const dataKey = axisConfig.dataKey;
58
- if (dataKey === undefined || axisConfig.data !== undefined) {
59
- return axisConfig;
60
- }
61
- if (dataset === undefined) {
62
- throw Error('MUI X Charts: y-axis uses `dataKey` but no `dataset` is provided.');
63
- }
64
- return (0, _extends2.default)({}, axisConfig, {
65
- data: dataset.map(d => d[dataKey])
66
- });
67
- }), [inYAxis, dataset]);
68
- const value = React.useMemo(() => {
69
- const axisExtremumCallback = (acc, chartType, axis, getters, isDefaultAxis) => {
70
- const getter = getters[chartType];
71
- const series = formattedSeries[chartType]?.series ?? {};
72
- const [minChartTypeData, maxChartTypeData] = getter?.({
73
- series,
74
- axis,
75
- isDefaultAxis
76
- }) ?? [null, null];
77
- const [minData, maxData] = acc;
78
- if (minData === null || maxData === null) {
79
- return [minChartTypeData, maxChartTypeData];
80
- }
81
- if (minChartTypeData === null || maxChartTypeData === null) {
82
- return [minData, maxData];
83
- }
84
- return [Math.min(minChartTypeData, minData), Math.max(maxChartTypeData, maxData)];
85
- };
86
- const getAxisExtremum = (axis, getters, isDefaultAxis) => {
87
- const charTypes = Object.keys(getters);
88
- return charTypes.reduce((acc, charType) => axisExtremumCallback(acc, charType, axis, getters, isDefaultAxis), [null, null]);
89
- };
90
- const allXAxis = [...(xAxis?.map((axis, index) => (0, _extends2.default)({
91
- id: `defaultized-x-axis-${index}`
92
- }, axis)) ?? []),
93
- // Allows to specify an axis with id=DEFAULT_X_AXIS_KEY
94
- ...(xAxis === undefined || xAxis.findIndex(({
95
- id
96
- }) => id === _constants.DEFAULT_X_AXIS_KEY) === -1 ? [{
97
- id: _constants.DEFAULT_X_AXIS_KEY,
98
- scaleType: 'linear'
99
- }] : [])];
100
- const completedXAxis = {};
101
- allXAxis.forEach((axis, axisIndex) => {
102
- const isDefaultAxis = axisIndex === 0;
103
- const [minData, maxData] = getAxisExtremum(axis, xExtremumGetters, isDefaultAxis);
104
- const range = axis.reverse ? [drawingArea.left + drawingArea.width, drawingArea.left] : [drawingArea.left, drawingArea.left + drawingArea.width];
105
- if ((0, _axis.isBandScaleConfig)(axis)) {
106
- const categoryGapRatio = axis.categoryGapRatio ?? DEFAULT_CATEGORY_GAP_RATIO;
107
- const barGapRatio = axis.barGapRatio ?? DEFAULT_BAR_GAP_RATIO;
108
- completedXAxis[axis.id] = (0, _extends2.default)({
109
- categoryGapRatio,
110
- barGapRatio
111
- }, axis, {
112
- scale: (0, _d3Scale.scaleBand)(axis.data, range).paddingInner(categoryGapRatio).paddingOuter(categoryGapRatio / 2),
113
- tickNumber: axis.data.length,
114
- colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? (0, _colorScale.getOrdinalColorScale)((0, _extends2.default)({
115
- values: axis.data
116
- }, axis.colorMap)) : (0, _colorScale.getColorScale)(axis.colorMap))
117
- });
118
- }
119
- if ((0, _axis.isPointScaleConfig)(axis)) {
120
- completedXAxis[axis.id] = (0, _extends2.default)({}, axis, {
121
- scale: (0, _d3Scale.scalePoint)(axis.data, range),
122
- tickNumber: axis.data.length,
123
- colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? (0, _colorScale.getOrdinalColorScale)((0, _extends2.default)({
124
- values: axis.data
125
- }, axis.colorMap)) : (0, _colorScale.getColorScale)(axis.colorMap))
126
- });
127
- }
128
- if (axis.scaleType === 'band' || axis.scaleType === 'point') {
129
- // Could be merged with the two previous "if conditions" but then TS does not get that `axis.scaleType` can't be `band` or `point`.
130
- return;
131
- }
132
- const scaleType = axis.scaleType ?? 'linear';
133
- const extremums = [axis.min ?? minData, axis.max ?? maxData];
134
- const tickNumber = (0, _useTicks.getTickNumber)((0, _extends2.default)({}, axis, {
135
- range,
136
- domain: extremums
137
- }));
138
- const niceScale = (0, _getScale.getScale)(scaleType, extremums, range).nice(tickNumber);
139
- const niceDomain = niceScale.domain();
140
- const domain = [axis.min ?? niceDomain[0], axis.max ?? niceDomain[1]];
141
- completedXAxis[axis.id] = (0, _extends2.default)({}, axis, {
142
- scaleType,
143
- scale: niceScale.domain(domain),
144
- tickNumber,
145
- colorScale: axis.colorMap && (0, _colorScale.getColorScale)(axis.colorMap)
146
- });
147
- });
148
- const allYAxis = [...(yAxis?.map((axis, index) => (0, _extends2.default)({
149
- id: `defaultized-y-axis-${index}`
150
- }, axis)) ?? []), ...(yAxis === undefined || yAxis.findIndex(({
151
- id
152
- }) => id === _constants.DEFAULT_Y_AXIS_KEY) === -1 ? [{
153
- id: _constants.DEFAULT_Y_AXIS_KEY,
154
- scaleType: 'linear'
155
- }] : [])];
156
- const completedYAxis = {};
157
- allYAxis.forEach((axis, axisIndex) => {
158
- const isDefaultAxis = axisIndex === 0;
159
- const [minData, maxData] = getAxisExtremum(axis, yExtremumGetters, isDefaultAxis);
160
- const range = axis.reverse ? [drawingArea.top, drawingArea.top + drawingArea.height] : [drawingArea.top + drawingArea.height, drawingArea.top];
161
- if ((0, _axis.isBandScaleConfig)(axis)) {
162
- const categoryGapRatio = axis.categoryGapRatio ?? DEFAULT_CATEGORY_GAP_RATIO;
163
- completedYAxis[axis.id] = (0, _extends2.default)({
164
- categoryGapRatio,
165
- barGapRatio: 0
166
- }, axis, {
167
- scale: (0, _d3Scale.scaleBand)(axis.data, [range[1], range[0]]).paddingInner(categoryGapRatio).paddingOuter(categoryGapRatio / 2),
168
- tickNumber: axis.data.length,
169
- colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? (0, _colorScale.getOrdinalColorScale)((0, _extends2.default)({
170
- values: axis.data
171
- }, axis.colorMap)) : (0, _colorScale.getColorScale)(axis.colorMap))
172
- });
173
- }
174
- if ((0, _axis.isPointScaleConfig)(axis)) {
175
- completedYAxis[axis.id] = (0, _extends2.default)({}, axis, {
176
- scale: (0, _d3Scale.scalePoint)(axis.data, [range[1], range[0]]),
177
- tickNumber: axis.data.length,
178
- colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? (0, _colorScale.getOrdinalColorScale)((0, _extends2.default)({
179
- values: axis.data
180
- }, axis.colorMap)) : (0, _colorScale.getColorScale)(axis.colorMap))
181
- });
182
- }
183
- if (axis.scaleType === 'band' || axis.scaleType === 'point') {
184
- // Could be merged with the two previous "if conditions" but then TS does not get that `axis.scaleType` can't be `band` or `point`.
185
- return;
186
- }
187
- const scaleType = axis.scaleType ?? 'linear';
188
- const extremums = [axis.min ?? minData, axis.max ?? maxData];
189
- const tickNumber = (0, _useTicks.getTickNumber)((0, _extends2.default)({}, axis, {
190
- range,
191
- domain: extremums
192
- }));
193
- const niceScale = (0, _getScale.getScale)(scaleType, extremums, range).nice(tickNumber);
194
- const niceDomain = niceScale.domain();
195
- const domain = [axis.min ?? niceDomain[0], axis.max ?? niceDomain[1]];
196
- completedYAxis[axis.id] = (0, _extends2.default)({}, axis, {
197
- scaleType,
198
- scale: niceScale.domain(domain),
199
- tickNumber,
200
- colorScale: axis.colorMap && (0, _colorScale.getColorScale)(axis.colorMap)
201
- });
202
- });
203
- return {
204
- xAxis: completedXAxis,
205
- yAxis: completedYAxis,
206
- xAxisIds: allXAxis.map(({
207
- id
208
- }) => id),
209
- yAxisIds: allYAxis.map(({
210
- id
211
- }) => id)
212
- };
213
- }, [drawingArea.height, drawingArea.left, drawingArea.top, drawingArea.width, formattedSeries, xAxis, xExtremumGetters, yAxis, yExtremumGetters]);
214
-
215
- // @ts-ignore
216
- return /*#__PURE__*/(0, _jsxRuntime.jsx)(CartesianContext.Provider, {
217
- value: value,
218
- children: children
219
- });
220
- }