@mui/x-charts 8.0.0-alpha.12 → 8.0.0-alpha.14

package/internals/plugins/featurePlugins/useChartPolarAxis/computeAxisValue.js

@@ -0,0 +1,140 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.computeAxisValue = computeAxisValue;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _d3Scale = require("@mui/x-charts-vendor/d3-scale");
+var _axis = require("../../../../models/axis");
+var _colorScale = require("../../../colorScale");
+var _useTicks = require("../../../../hooks/useTicks");
+var _getScale = require("../../../getScale");
+var _getAxisExtremum = require("./getAxisExtremum");
+const degreeToRad = (value, defaultRad) => {
+  if (value === undefined) {
+    return defaultRad;
+  }
+  return Math.PI * value / 180;
+};
+function getRange(drawingArea, axisDirection, axis) {
+  if (axisDirection === 'rotation') {
+    if (axis.scaleType === 'point') {
+      const angles = [degreeToRad(axis.startAngle, 0), degreeToRad(axis.endAngle, 2 * Math.PI)];
+      const diff = angles[1] - angles[0];
+      if (diff > Math.PI * 2 - 0.1) {
+        // If we cover a full circle, we remove a slice to avoid having data point at the same place.
+        angles[1] -= diff / axis.data.length;
+      }
+      return angles;
+    }
+    return [degreeToRad(axis.startAngle, 0), degreeToRad(axis.endAngle, 2 * Math.PI)];
+  }
+  return [0, Math.min(drawingArea.height, drawingArea.width) / 2];
+}
+const isDateData = data => data?.[0] instanceof Date;
+function createDateFormatter(axis, range) {
+  const timeScale = (0, _d3Scale.scaleTime)(axis.data, range);
+  return (v, {
+    location
+  }) => location === 'tick' ? timeScale.tickFormat(axis.tickNumber)(v) : `${v.toLocaleString()}`;
+}
+const DEFAULT_CATEGORY_GAP_RATIO = 0.2;
+const DEFAULT_BAR_GAP_RATIO = 0.1;
+function computeAxisValue({
+  drawingArea,
+  formattedSeries,
+  axis: allAxis,
+  seriesConfig,
+  axisDirection
+}) {
+  if (allAxis === undefined) {
+    return {
+      axis: {},
+      axisIds: []
+    };
+  }
+  const completeAxis = {};
+  allAxis.forEach((eachAxis, axisIndex) => {
+    const axis = eachAxis;
+    const range = getRange(drawingArea, axisDirection, axis);
+    const [minData, maxData] = (0, _getAxisExtremum.getAxisExtremum)(axis, axisDirection, seriesConfig, axisIndex, formattedSeries);
+    const data = axis.data ?? [];
+    if ((0, _axis.isBandScaleConfig)(axis)) {
+      const categoryGapRatio = axis.categoryGapRatio ?? DEFAULT_CATEGORY_GAP_RATIO;
+      const barGapRatio = axis.barGapRatio ?? DEFAULT_BAR_GAP_RATIO;
+      completeAxis[axis.id] = (0, _extends2.default)({
+        offset: 0,
+        categoryGapRatio,
+        barGapRatio
+      }, axis, {
+        data,
+        scale: (0, _d3Scale.scaleBand)(axis.data, range).paddingInner(categoryGapRatio).paddingOuter(categoryGapRatio / 2),
+        tickNumber: axis.data.length,
+        colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? (0, _colorScale.getOrdinalColorScale)((0, _extends2.default)({
+          values: axis.data
+        }, axis.colorMap)) : (0, _colorScale.getColorScale)(axis.colorMap))
+      });
+      if (isDateData(axis.data)) {
+        const dateFormatter = createDateFormatter(axis, range);
+        completeAxis[axis.id].valueFormatter = axis.valueFormatter ?? dateFormatter;
+      }
+    }
+    if ((0, _axis.isPointScaleConfig)(axis)) {
+      completeAxis[axis.id] = (0, _extends2.default)({
+        offset: 0
+      }, axis, {
+        data,
+        scale: (0, _d3Scale.scalePoint)(axis.data, range),
+        tickNumber: axis.data.length,
+        colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? (0, _colorScale.getOrdinalColorScale)((0, _extends2.default)({
+          values: axis.data
+        }, axis.colorMap)) : (0, _colorScale.getColorScale)(axis.colorMap))
+      });
+      if (isDateData(axis.data)) {
+        const dateFormatter = createDateFormatter(axis, range);
+        completeAxis[axis.id].valueFormatter = axis.valueFormatter ?? dateFormatter;
+      }
+    }
+    if (axis.scaleType === 'band' || axis.scaleType === 'point') {
+      // Could be merged with the two previous "if conditions" but then TS does not get that `axis.scaleType` can't be `band` or `point`.
+      return;
+    }
+    const scaleType = axis.scaleType ?? 'linear';
+    const domainLimit = axis.domainLimit ?? 'nice';
+    const axisExtremums = [axis.min ?? minData, axis.max ?? maxData];
+    if (typeof domainLimit === 'function') {
+      const {
+        min,
+        max
+      } = domainLimit(minData, maxData);
+      axisExtremums[0] = min;
+      axisExtremums[1] = max;
+    }
+    const rawTickNumber = (0, _useTicks.getTickNumber)((0, _extends2.default)({}, axis, {
+      range,
+      domain: axisExtremums
+    }));
+    const tickNumber = rawTickNumber / ((range[1] - range[0]) / 100);
+    const scale = (0, _getScale.getScale)(scaleType, axisExtremums, range);
+    const finalScale = domainLimit === 'nice' ? scale.nice(rawTickNumber) : scale;
+    const [minDomain, maxDomain] = finalScale.domain();
+    const domain = [axis.min ?? minDomain, axis.max ?? maxDomain];
+    completeAxis[axis.id] = (0, _extends2.default)({
+      offset: 0
+    }, axis, {
+      data,
+      scaleType: scaleType,
+      scale: finalScale.domain(domain),
+      tickNumber,
+      colorScale: axis.colorMap && (0, _colorScale.getColorScale)(axis.colorMap)
+    });
+  });
+  return {
+    axis: completeAxis,
+    axisIds: allAxis.map(({
+      id
+    }) => id)
+  };
+}

package/internals/plugins/featurePlugins/useChartPolarAxis/defaultizeAxis.d.ts

@@ -0,0 +1,5 @@
+import { MakeOptional } from '@mui/x-internals/types';
+import { ScaleName } from "../../../../models/index.js";
+import { PolarAxisConfig } from "../../../../models/axis.js";
+import { DatasetType } from "../../../../models/seriesType/config.js";
+export declare function defaultizeAxis<TScale extends ScaleName = ScaleName>(inAxis: MakeOptional<PolarAxisConfig<TScale, any>, 'id'>[] | undefined, dataset: Readonly<DatasetType> | undefined, axisName: 'rotation' | 'radius'): PolarAxisConfig<TScale, any>[];

package/internals/plugins/featurePlugins/useChartPolarAxis/defaultizeAxis.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.defaultizeAxis = defaultizeAxis;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _constants = require("../../../../constants");
+function defaultizeAxis(inAxis, dataset, axisName) {
+  const DEFAULT_AXIS_KEY = axisName === 'rotation' ? _constants.DEFAULT_ROTATION_AXIS_KEY : 5;
+  const inputAxes = inAxis && inAxis.length > 0 ? inAxis : [{
+    id: DEFAULT_AXIS_KEY
+  }];
+  return inputAxes.map((axisConfig, index) => {
+    const id = `defaultized-${axisName}-axis-${index}`;
+    const dataKey = axisConfig.dataKey;
+    if (dataKey === undefined || axisConfig.data !== undefined) {
+      return (0, _extends2.default)({
+        id
+      }, axisConfig);
+    }
+    if (dataset === undefined) {
+      throw new Error(`MUI X: ${axisName}-axis uses \`dataKey\` but no \`dataset\` is provided.`);
+    }
+    return (0, _extends2.default)({
+      id,
+      data: dataset.map(d => d[dataKey])
+    }, axisConfig);
+  });
+}

package/internals/plugins/featurePlugins/useChartPolarAxis/getAxisExtremum.d.ts

@@ -0,0 +1,5 @@
+import { AxisConfig } from "../../../../models/axis.js";
+import { PolarChartSeriesType } from "../../../../models/seriesType/config.js";
+import { ChartSeriesConfig } from "../../models/seriesConfig/index.js";
+import { ProcessedSeries } from "../../corePlugins/useChartSeries/useChartSeries.types.js";
+export declare const getAxisExtremum: <TSeriesType extends PolarChartSeriesType>(axis: AxisConfig, axisDirection: "rotation" | "radius", seriesConfig: ChartSeriesConfig<TSeriesType>, axisIndex: number, formattedSeries: ProcessedSeries<TSeriesType>) => number[];

package/internals/plugins/featurePlugins/useChartPolarAxis/getAxisExtremum.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAxisExtremum = void 0;
+var _isPolar = require("../../../isPolar");
+const axisExtremumCallback = (acc, chartType, axis, axisDirection, seriesConfig, axisIndex, formattedSeries) => {
+  const getter = axisDirection === 'rotation' ? seriesConfig[chartType].rotationExtremumGetter : seriesConfig[chartType].radiusExtremumGetter;
+  const series = formattedSeries[chartType]?.series ?? {};
+  const [minChartTypeData, maxChartTypeData] = getter?.({
+    series,
+    axis,
+    axisIndex,
+    isDefaultAxis: axisIndex === 0
+  }) ?? [Infinity, -Infinity];
+  const [minData, maxData] = acc;
+  return [Math.min(minChartTypeData, minData), Math.max(maxChartTypeData, maxData)];
+};
+const getAxisExtremum = (axis, axisDirection, seriesConfig, axisIndex, formattedSeries) => {
+  const polarSeriesTypes = Object.keys(seriesConfig).filter(_isPolar.isPolarSeriesType);
+  const extremums = polarSeriesTypes.reduce((acc, charType) => axisExtremumCallback(acc, charType, axis, axisDirection, seriesConfig, axisIndex, formattedSeries), [Infinity, -Infinity]);
+  if (Number.isNaN(extremums[0]) || Number.isNaN(extremums[1])) {
+    return [Infinity, -Infinity];
+  }
+  return extremums;
+};
+exports.getAxisExtremum = getAxisExtremum;

package/internals/plugins/featurePlugins/useChartPolarAxis/index.d.ts

@@ -0,0 +1,3 @@
+export { useChartPolarAxis } from "./useChartPolarAxis.js";
+export type * from './useChartPolarAxis.types';
+export * from "./useChartPolarAxis.selectors.js";

package/internals/plugins/featurePlugins/useChartPolarAxis/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  useChartPolarAxis: true
+};
+Object.defineProperty(exports, "useChartPolarAxis", {
+  enumerable: true,
+  get: function () {
+    return _useChartPolarAxis.useChartPolarAxis;
+  }
+});
+var _useChartPolarAxis = require("./useChartPolarAxis");
+var _useChartPolarAxis2 = require("./useChartPolarAxis.selectors");
+Object.keys(_useChartPolarAxis2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _useChartPolarAxis2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _useChartPolarAxis2[key];
+    }
+  });
+});

package/internals/plugins/featurePlugins/useChartPolarAxis/useChartPolarAxis.d.ts

@@ -0,0 +1,3 @@
+import { ChartPlugin } from "../../models/index.js";
+import { UseChartPolarAxisSignature } from "./useChartPolarAxis.types.js";
+export declare const useChartPolarAxis: ChartPlugin<UseChartPolarAxisSignature<any>>;

package/internals/plugins/featurePlugins/useChartPolarAxis/useChartPolarAxis.js

@@ -0,0 +1,65 @@
+"use strict";
+'use client';
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useChartPolarAxis = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var React = _interopRequireWildcard(require("react"));
+var _warning = require("@mui/x-internals/warning");
+var _useSelector = require("../../../store/useSelector");
+var _useChartDimensions = require("../../corePlugins/useChartDimensions/useChartDimensions.selectors");
+var _useChartSeries = require("../../corePlugins/useChartSeries/useChartSeries.selectors");
+var _defaultizeAxis = require("./defaultizeAxis");
+const useChartPolarAxis = ({
+  params,
+  store,
+  seriesConfig
+}) => {
+  const {
+    rotationAxis,
+    radiusAxis,
+    dataset
+  } = params;
+  if (process.env.NODE_ENV !== 'production') {
+    const ids = [...(rotationAxis ?? []), ...(radiusAxis ?? [])].filter(axis => axis.id).map(axis => axis.id);
+    const duplicates = new Set(ids.filter((id, index) => ids.indexOf(id) !== index));
+    if (duplicates.size > 0) {
+      (0, _warning.warnOnce)([`MUI X: The following axis ids are duplicated: ${Array.from(duplicates).join(', ')}.`, `Please make sure that each axis has a unique id.`].join('\n'), 'error');
+    }
+  }
+  const drawingArea = (0, _useSelector.useSelector)(store, _useChartDimensions.selectorChartDrawingArea);
+  const formattedSeries = (0, _useSelector.useSelector)(store, _useChartSeries.selectorChartSeriesState);
+
+  // The effect do not track any value defined synchronously during the 1st render by hooks called after `useChartPolarAxis`
+  // As a consequence, the state generated by the 1st run of this useEffect will always be equal to the initialization one
+  const isFirstRender = React.useRef(true);
+  React.useEffect(() => {
+    if (isFirstRender.current) {
+      isFirstRender.current = false;
+      return;
+    }
+    store.update(prev => (0, _extends2.default)({}, prev, {
+      polarAxis: (0, _extends2.default)({}, prev.polarAxis, {
+        rotation: (0, _defaultizeAxis.defaultizeAxis)(rotationAxis, dataset, 'rotation'),
+        radius: (0, _defaultizeAxis.defaultizeAxis)(radiusAxis, dataset, 'radius')
+      })
+    }));
+  }, [seriesConfig, drawingArea, formattedSeries, rotationAxis, radiusAxis, dataset, store]);
+  return {};
+};
+exports.useChartPolarAxis = useChartPolarAxis;
+useChartPolarAxis.params = {
+  rotationAxis: true,
+  radiusAxis: true,
+  dataset: true
+};
+useChartPolarAxis.getInitialState = params => ({
+  polarAxis: {
+    rotation: (0, _defaultizeAxis.defaultizeAxis)(params.rotationAxis, params.dataset, 'rotation'),
+    radius: (0, _defaultizeAxis.defaultizeAxis)(params.radiusAxis, params.dataset, 'radius')
+  }
+});