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

package/esm/internals/plugins/featurePlugins/useChartInteraction/useChartInteraction.selectors.d.ts

@@ -31,7 +31,7 @@ export declare const selectorChartsInteractionIsInitialized: ((state: import("..
 };
 export declare const selectorChartsInteractionItem: ((state: import("../../corePlugins/useChartId/useChartId.types").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types").UseChartSeriesState<keyof import("../../..").ChartsSeriesConfig> & Partial<import("./useChartInteraction.types").UseChartInteractionState> & {
   cacheKey: import("../../models").ChartStateCacheKey;
-}) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null) & {
+}) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null) & {
   clearCache: () => void;
   resultsCount: () => number;
   resetResultsCount: () => void;
@@ -39,16 +39,16 @@ export declare const selectorChartsInteractionItem: ((state: import("../../coreP
   resultFunc: (resultFuncArgs_0: {
     item: null | import("../../..").ChartItemIdentifier<import("../../..").ChartSeriesType>;
     axis: AxisInteractionData;
-  } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null;
+  } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null;
   memoizedResultFunc: ((resultFuncArgs_0: {
     item: null | import("../../..").ChartItemIdentifier<import("../../..").ChartSeriesType>;
     axis: AxisInteractionData;
-  } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null) & {
+  } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null) & {
     clearCache: () => void;
     resultsCount: () => number;
     resetResultsCount: () => void;
   };
-  lastResult: () => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null;
+  lastResult: () => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null;
   dependencies: [ChartOptionalRootSelector<UseChartInteractionSignature>];
   recomputations: () => number;
   resetRecomputations: () => void;
@@ -220,8 +220,8 @@ export declare const selectorChartsInteractionItemIsDefined: ((state: import("..
   resultsCount: () => number;
   resetResultsCount: () => void;
 } & {
-  resultFunc: (resultFuncArgs_0: import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null) => boolean;
-  memoizedResultFunc: ((resultFuncArgs_0: import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null) => boolean) & {
+  resultFunc: (resultFuncArgs_0: import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null) => boolean;
+  memoizedResultFunc: ((resultFuncArgs_0: import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null) => boolean) & {
     clearCache: () => void;
     resultsCount: () => number;
     resetResultsCount: () => void;
@@ -229,7 +229,7 @@ export declare const selectorChartsInteractionItemIsDefined: ((state: import("..
   lastResult: () => boolean;
   dependencies: [((state: import("../../corePlugins/useChartId/useChartId.types").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types").UseChartSeriesState<keyof import("../../..").ChartsSeriesConfig> & Partial<import("./useChartInteraction.types").UseChartInteractionState> & {
     cacheKey: import("../../models").ChartStateCacheKey;
-  }) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null) & {
+  }) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null) & {
     clearCache: () => void;
     resultsCount: () => number;
     resetResultsCount: () => void;
@@ -237,16 +237,16 @@ export declare const selectorChartsInteractionItemIsDefined: ((state: import("..
     resultFunc: (resultFuncArgs_0: {
       item: null | import("../../..").ChartItemIdentifier<import("../../..").ChartSeriesType>;
       axis: AxisInteractionData;
-    } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null;
+    } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null;
     memoizedResultFunc: ((resultFuncArgs_0: {
       item: null | import("../../..").ChartItemIdentifier<import("../../..").ChartSeriesType>;
       axis: AxisInteractionData;
-    } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null) & {
+    } | undefined) => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null) & {
       clearCache: () => void;
       resultsCount: () => number;
       resetResultsCount: () => void;
     };
-    lastResult: () => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | null;
+    lastResult: () => import("../../../..").ScatterItemIdentifier | import("../../../..").LineItemIdentifier | import("../../../..").BarItemIdentifier | import("../../../..").PieItemIdentifier | import("../../../..").RadarItemIdentifier | null;
     dependencies: [ChartOptionalRootSelector<UseChartInteractionSignature>];
     recomputations: () => number;
     resetRecomputations: () => void;

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

@@ -0,0 +1,27 @@
+import { AxisConfig, ScaleName } from "../../../../models/index.js";
+import { ChartsAxisProps, ChartsYAxisProps, ChartsRotationAxisProps, ChartsRadiusAxisProps, PolarAxisDefaultized, AxisId } from "../../../../models/axis.js";
+import { ChartSeriesType } from "../../../../models/seriesType/config.js";
+import type { ChartDrawingArea } from '../../../../hooks';
+import { ChartSeriesConfig } from "../../models/seriesConfig/index.js";
+import { ProcessedSeries } from "../../corePlugins/useChartSeries/useChartSeries.types.js";
+export type DefaultizedAxisConfig<AxisProps extends ChartsRotationAxisProps | ChartsRadiusAxisProps> = {
+  [axisId: AxisId]: PolarAxisDefaultized<ScaleName, any, AxisProps>;
+};
+type ComputeResult<T extends ChartsAxisProps> = {
+  axis: DefaultizedAxisConfig<T>;
+  axisIds: string[];
+};
+type ComputeCommonParams<T extends ChartSeriesType = ChartSeriesType> = {
+  drawingArea: ChartDrawingArea;
+  formattedSeries: ProcessedSeries<T>;
+  seriesConfig: ChartSeriesConfig<T>;
+};
+export declare function computeAxisValue<T extends ChartSeriesType>(options: ComputeCommonParams<T> & {
+  axis?: AxisConfig<'linear', any, ChartsRadiusAxisProps>[];
+  axisDirection: 'radius';
+}): ComputeResult<ChartsYAxisProps>;
+export declare function computeAxisValue<T extends ChartSeriesType>(options: ComputeCommonParams<T> & {
+  axis?: AxisConfig<ScaleName, any, ChartsRotationAxisProps>[];
+  axisDirection: 'rotation';
+}): ComputeResult<ChartsAxisProps>;
+export {};

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

@@ -0,0 +1,133 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { scaleBand, scalePoint, scaleTime } from '@mui/x-charts-vendor/d3-scale';
+import { isBandScaleConfig, isPointScaleConfig } from "../../../../models/axis.js";
+import { getColorScale, getOrdinalColorScale } from "../../../colorScale.js";
+import { getTickNumber } from "../../../../hooks/useTicks.js";
+import { getScale } from "../../../getScale.js";
+import { getAxisExtremum } from "./getAxisExtremum.js";
+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 = 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;
+export 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] = getAxisExtremum(axis, axisDirection, seriesConfig, axisIndex, formattedSeries);
+    const data = axis.data ?? [];
+    if (isBandScaleConfig(axis)) {
+      const categoryGapRatio = axis.categoryGapRatio ?? DEFAULT_CATEGORY_GAP_RATIO;
+      const barGapRatio = axis.barGapRatio ?? DEFAULT_BAR_GAP_RATIO;
+      completeAxis[axis.id] = _extends({
+        offset: 0,
+        categoryGapRatio,
+        barGapRatio
+      }, axis, {
+        data,
+        scale: scaleBand(axis.data, range).paddingInner(categoryGapRatio).paddingOuter(categoryGapRatio / 2),
+        tickNumber: axis.data.length,
+        colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? getOrdinalColorScale(_extends({
+          values: axis.data
+        }, axis.colorMap)) : getColorScale(axis.colorMap))
+      });
+      if (isDateData(axis.data)) {
+        const dateFormatter = createDateFormatter(axis, range);
+        completeAxis[axis.id].valueFormatter = axis.valueFormatter ?? dateFormatter;
+      }
+    }
+    if (isPointScaleConfig(axis)) {
+      completeAxis[axis.id] = _extends({
+        offset: 0
+      }, axis, {
+        data,
+        scale: scalePoint(axis.data, range),
+        tickNumber: axis.data.length,
+        colorScale: axis.colorMap && (axis.colorMap.type === 'ordinal' ? getOrdinalColorScale(_extends({
+          values: axis.data
+        }, axis.colorMap)) : 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 = getTickNumber(_extends({}, axis, {
+      range,
+      domain: axisExtremums
+    }));
+    const tickNumber = rawTickNumber / ((range[1] - range[0]) / 100);
+    const scale = 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] = _extends({
+      offset: 0
+    }, axis, {
+      data,
+      scaleType: scaleType,
+      scale: finalScale.domain(domain),
+      tickNumber,
+      colorScale: axis.colorMap && getColorScale(axis.colorMap)
+    });
+  });
+  return {
+    axis: completeAxis,
+    axisIds: allAxis.map(({
+      id
+    }) => id)
+  };
+}

package/esm/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/esm/internals/plugins/featurePlugins/useChartPolarAxis/defaultizeAxis.js

@@ -0,0 +1,24 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { DEFAULT_ROTATION_AXIS_KEY } from "../../../../constants/index.js";
+export function defaultizeAxis(inAxis, dataset, axisName) {
+  const DEFAULT_AXIS_KEY = axisName === 'rotation' ? 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 _extends({
+        id
+      }, axisConfig);
+    }
+    if (dataset === undefined) {
+      throw new Error(`MUI X: ${axisName}-axis uses \`dataKey\` but no \`dataset\` is provided.`);
+    }
+    return _extends({
+      id,
+      data: dataset.map(d => d[dataKey])
+    }, axisConfig);
+  });
+}

package/esm/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/esm/internals/plugins/featurePlugins/useChartPolarAxis/getAxisExtremum.js

@@ -0,0 +1,21 @@
+import { isPolarSeriesType } from "../../../isPolar.js";
+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)];
+};
+export const getAxisExtremum = (axis, axisDirection, seriesConfig, axisIndex, formattedSeries) => {
+  const polarSeriesTypes = Object.keys(seriesConfig).filter(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;
+};

package/esm/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/esm/internals/plugins/featurePlugins/useChartPolarAxis/index.js

@@ -0,0 +1,2 @@
+export { useChartPolarAxis } from "./useChartPolarAxis.js";
+export * from "./useChartPolarAxis.selectors.js";

package/esm/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/esm/internals/plugins/featurePlugins/useChartPolarAxis/useChartPolarAxis.js

@@ -0,0 +1,57 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { warnOnce } from '@mui/x-internals/warning';
+import { useSelector } from "../../../store/useSelector.js";
+import { selectorChartDrawingArea } from "../../corePlugins/useChartDimensions/useChartDimensions.selectors.js";
+import { selectorChartSeriesState } from "../../corePlugins/useChartSeries/useChartSeries.selectors.js";
+import { defaultizeAxis } from "./defaultizeAxis.js";
+export 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) {
+      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 = useSelector(store, selectorChartDrawingArea);
+  const formattedSeries = useSelector(store, 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 => _extends({}, prev, {
+      polarAxis: _extends({}, prev.polarAxis, {
+        rotation: defaultizeAxis(rotationAxis, dataset, 'rotation'),
+        radius: defaultizeAxis(radiusAxis, dataset, 'radius')
+      })
+    }));
+  }, [seriesConfig, drawingArea, formattedSeries, rotationAxis, radiusAxis, dataset, store]);
+  return {};
+};
+useChartPolarAxis.params = {
+  rotationAxis: true,
+  radiusAxis: true,
+  dataset: true
+};
+useChartPolarAxis.getInitialState = params => ({
+  polarAxis: {
+    rotation: defaultizeAxis(params.rotationAxis, params.dataset, 'rotation'),
+    radius: defaultizeAxis(params.radiusAxis, params.dataset, 'radius')
+  }
+});