@mui/x-charts 8.0.0-alpha.1 → 8.0.0-alpha.10

package/internals/defaultizeColor.d.ts

@@ -1,9 +1,10 @@
 import { AllSeriesType } from '../models/seriesType';
-export declare function defaultizeColor(series: AllSeriesType, seriesIndex: number, colors?: string[]): {
+export declare function defaultizeColor(series: AllSeriesType, seriesIndex: number, colors: string[]): {
     data: {
-        color: string;
-        label?: (string | ((location: "tooltip" | "legend" | "arc") => string)) | undefined;
         value: number;
+        label?: string | ((location: "tooltip" | "legend" | "arc") => string) | undefined;
+        color: string;
+        labelMarkType?: "line" | "circle" | "square" | undefined;
         id?: import("..").PieItemId | undefined;
     }[];
     type: "pie";
@@ -43,6 +44,7 @@ export declare function defaultizeColor(series: AllSeriesType, seriesIndex: numb
     color?: string;
     valueFormatter?: import(".").SeriesValueFormatter<import("@mui/x-internals/types").MakeOptional<import("..").PieValueType, "id">> | undefined;
     highlightScope?: Partial<import("..").HighlightScope>;
+    labelMarkType?: import("..").ChartsLabelMarkProps["type"];
 } | {
     type: "bar";
     data?: (number | null)[];
@@ -54,29 +56,11 @@ export declare function defaultizeColor(series: AllSeriesType, seriesIndex: numb
     color: string;
     valueFormatter?: import(".").SeriesValueFormatter<number | null> | undefined;
     highlightScope?: Partial<import("..").HighlightScope>;
+    labelMarkType?: import("..").ChartsLabelMarkProps["type"];
     xAxisId?: string;
     yAxisId?: string;
     stack?: string;
     stackOrder?: import("..").StackOrderType;
-} | {
-    type: "scatter";
-    data?: import("..").ScatterValueType[];
-    markerSize?: number;
-    label?: string | ((location: "tooltip" | "legend") => string);
-    disableHover?: boolean;
-    zAxisId?: string;
-    datasetKeys?: {
-        x: string;
-        y: string;
-        z?: string;
-        id: string;
-    };
-    id?: import(".").SeriesId;
-    color: string;
-    valueFormatter?: import(".").SeriesValueFormatter<import("..").ScatterValueType> | undefined;
-    highlightScope?: Partial<import("..").HighlightScope>;
-    xAxisId?: string;
-    yAxisId?: string;
 } | {
     type: "line";
     data?: (number | null)[];
@@ -85,7 +69,9 @@ export declare function defaultizeColor(series: AllSeriesType, seriesIndex: numb
     area?: boolean;
     label?: string | ((location: "tooltip" | "legend") => string);
     curve?: import("..").CurveType;
+    strictStepCurve?: boolean;
     showMark?: boolean | ((params: import("..").ShowMarkParams) => boolean);
+    shape?: "circle" | "cross" | "diamond" | "square" | "star" | "triangle" | "wye";
     disableHighlight?: boolean;
     connectNulls?: boolean;
     stackOffset?: import("..").StackOffsetType;
@@ -94,7 +80,28 @@ export declare function defaultizeColor(series: AllSeriesType, seriesIndex: numb
     color: string;
     valueFormatter?: import(".").SeriesValueFormatter<number | null> | undefined;
     highlightScope?: Partial<import("..").HighlightScope>;
+    labelMarkType?: import("..").ChartsLabelMarkProps["type"];
     xAxisId?: string;
     yAxisId?: string;
     stackOrder?: import("..").StackOrderType;
+} | {
+    type: "scatter";
+    data?: import("..").ScatterValueType[];
+    markerSize?: number;
+    label?: string | ((location: "tooltip" | "legend") => string);
+    disableHover?: boolean;
+    zAxisId?: string;
+    datasetKeys?: {
+        x: string;
+        y: string;
+        z?: string;
+        id?: string;
+    };
+    id?: import(".").SeriesId;
+    color: string;
+    valueFormatter?: import(".").SeriesValueFormatter<import("..").ScatterValueType | null> | undefined;
+    highlightScope?: Partial<import("..").HighlightScope>;
+    labelMarkType?: import("..").ChartsLabelMarkProps["type"];
+    xAxisId?: string;
+    yAxisId?: string;
 };

package/internals/defaultizeColor.js

@@ -1,6 +1,5 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
-const DEFAULT_COLORS = ['#1f77b4', '#ff7f0e', '#2ca02c', '#d62728', '#9467bd', '#8c564b', '#e377c2', '#7f7f7f', '#bcbd22', '#17becf'];
-export function defaultizeColor(series, seriesIndex, colors = DEFAULT_COLORS) {
+export function defaultizeColor(series, seriesIndex, colors) {
   if (series.type === 'pie') {
     return _extends({}, series, {
       data: series.data.map((d, index) => _extends({

package/internals/getCurve.d.ts

@@ -1,2 +1,2 @@
-import { CurveType } from '../models/seriesType/line';
-export default function getCurveFactory(curveType?: CurveType): import("@mui/x-charts-vendor/d3-shape").CurveFactory;
+import { CurveType } from '../models/curve';
+export declare function getCurveFactory(curveType?: CurveType): import("@mui/x-charts-vendor/d3-shape").CurveFactory;

package/internals/getCurve.js

@@ -1,38 +1,26 @@
-import { curveCatmullRom, curveLinear, curveMonotoneX, curveMonotoneY, curveNatural, curveStep, curveStepAfter, curveStepBefore } from '@mui/x-charts-vendor/d3-shape';
-export default function getCurveFactory(curveType) {
+import { curveCatmullRom, curveLinear, curveMonotoneX, curveMonotoneY, curveNatural, curveStep, curveStepAfter, curveStepBefore, curveBumpX, curveBumpY } from '@mui/x-charts-vendor/d3-shape';
+export function getCurveFactory(curveType) {
   switch (curveType) {
     case 'catmullRom':
-      {
-        return curveCatmullRom.alpha(0.5);
-      }
+      return curveCatmullRom.alpha(0.5);
     case 'linear':
-      {
-        return curveLinear;
-      }
+      return curveLinear;
     case 'monotoneX':
-      {
-        return curveMonotoneX;
-      }
+      return curveMonotoneX;
     case 'monotoneY':
-      {
-        return curveMonotoneY;
-      }
+      return curveMonotoneY;
     case 'natural':
-      {
-        return curveNatural;
-      }
+      return curveNatural;
     case 'step':
-      {
-        return curveStep;
-      }
+      return curveStep;
     case 'stepBefore':
-      {
-        return curveStepBefore;
-      }
+      return curveStepBefore;
     case 'stepAfter':
-      {
-        return curveStepAfter;
-      }
+      return curveStepAfter;
+    case 'bumpY':
+      return curveBumpY;
+    case 'bumpX':
+      return curveBumpX;
     default:
       return curveMonotoneX;
   }

package/internals/index.d.ts

@@ -1,5 +1,6 @@
 export * from './components/ChartsAxesGradients';
-export * from '../ChartContainer/ResizableContainer';
+export * from './components/ChartsWrapper';
+export * from '../ChartsLabel/ChartsLabelMark';
 export { useSeries } from '../hooks/useSeries';
 export { useInteractionItemProps } from '../hooks/useInteractionItemProps';
 export { useDrawingArea } from '../hooks/useDrawingArea';
@@ -7,7 +8,18 @@ export { useScatterChartProps } from '../ScatterChart/useScatterChartProps';
 export { useLineChartProps } from '../LineChart/useLineChartProps';
 export { useBarChartProps } from '../BarChart/useBarChartProps';
 export * from '../ChartContainer/useChartContainerProps';
-export * from '../context/ChartDataProvider/useChartDataProviderProps';
+export * from '../ChartDataProvider/useChartDataProviderProps';
+export * from './plugins/corePlugins/useChartId';
+export * from './plugins/corePlugins/useChartSeries';
+export * from './plugins/corePlugins/useChartDimensions';
+export * from './plugins/featurePlugins/useChartZAxis';
+export * from './plugins/featurePlugins/useChartCartesianAxis';
+export * from './plugins/featurePlugins/useChartInteraction';
+export * from './plugins/featurePlugins/useChartHighlight';
+export * from './plugins/utils/selectors';
+export * from './store/useCharts';
+export * from './store/useStore';
+export * from './store/useSelector';
 export * from './defaultizeValueFormatter';
 export * from './configInit';
 export * from './getLabel';
@@ -15,20 +27,13 @@ export * from './getSVGPoint';
 export * from './isDefined';
 export { unstable_cleanupDOM } from './domUtils';
 export * from './getScale';
-export * from './computeAxisValue';
-export * from '../context/CartesianProvider';
-export * from '../context/DrawingAreaProvider';
-export * from '../context/InteractionProvider';
-export * from '../context/SeriesProvider';
-export * from '../context/ZAxisContextProvider';
-export * from '../context/PluginProvider';
+export * from './getCurve';
 export * from '../context/AnimationProvider';
 export type * from '../context/context.types';
-export { getAxisExtremum } from '../context/CartesianProvider/getAxisExtremum';
-export * from '../context/ChartDataProvider';
-export * from '../context/SizeProvider';
-export * from '../context/SvgRefProvider';
+export { getAxisExtremum } from './plugins/featurePlugins/useChartCartesianAxis/getAxisExtremum';
+export * from '../context/ChartProvider';
 export * from '../models/seriesType/config';
 export * from '../models/seriesType/common';
 export * from '../models/z-axis';
 export * from '../models/axis';
+export * from './plugins/models';

package/internals/index.js

@@ -1,6 +1,7 @@
 // Components
 export * from "./components/ChartsAxesGradients/index.js";
-export * from "../ChartContainer/ResizableContainer.js";
+export * from "./components/ChartsWrapper/index.js";
+export * from "../ChartsLabel/ChartsLabelMark.js";
 
 // hooks
 export { useSeries } from "../hooks/useSeries.js";
@@ -10,7 +11,20 @@ export { useScatterChartProps } from "../ScatterChart/useScatterChartProps.js";
 export { useLineChartProps } from "../LineChart/useLineChartProps.js";
 export { useBarChartProps } from "../BarChart/useBarChartProps.js";
 export * from "../ChartContainer/useChartContainerProps.js";
-export * from "../context/ChartDataProvider/useChartDataProviderProps.js";
+export * from "../ChartDataProvider/useChartDataProviderProps.js";
+
+// plugins
+export * from "./plugins/corePlugins/useChartId/index.js";
+export * from "./plugins/corePlugins/useChartSeries/index.js";
+export * from "./plugins/corePlugins/useChartDimensions/index.js";
+export * from "./plugins/featurePlugins/useChartZAxis/index.js";
+export * from "./plugins/featurePlugins/useChartCartesianAxis/index.js";
+export * from "./plugins/featurePlugins/useChartInteraction/index.js";
+export * from "./plugins/featurePlugins/useChartHighlight/index.js";
+export * from "./plugins/utils/selectors.js";
+export * from "./store/useCharts.js";
+export * from "./store/useStore.js";
+export * from "./store/useSelector.js";
 
 // utils
 export * from "./defaultizeValueFormatter.js";
@@ -20,24 +34,17 @@ export * from "./getSVGPoint.js";
 export * from "./isDefined.js";
 export { unstable_cleanupDOM } from "./domUtils.js";
 export * from "./getScale.js";
-export * from "./computeAxisValue.js";
+export * from "./getCurve.js";
 
 // contexts
 
-export * from "../context/CartesianProvider/index.js";
-export * from "../context/DrawingAreaProvider/index.js";
-export * from "../context/InteractionProvider.js";
-export * from "../context/SeriesProvider/index.js";
-export * from "../context/ZAxisContextProvider.js";
-export * from "../context/PluginProvider/index.js";
 export * from "../context/AnimationProvider/index.js";
-export { getAxisExtremum } from "../context/CartesianProvider/getAxisExtremum.js";
-export * from "../context/ChartDataProvider/index.js";
-export * from "../context/SizeProvider/index.js";
-export * from "../context/SvgRefProvider/index.js";
+export { getAxisExtremum } from "./plugins/featurePlugins/useChartCartesianAxis/getAxisExtremum.js";
+export * from "../context/ChartProvider/index.js";
 
 // series configuration
 export * from "../models/seriesType/config.js";
 export * from "../models/seriesType/common.js";
 export * from "../models/z-axis.js";
-export * from "../models/axis.js";
+export * from "../models/axis.js";
+export * from "./plugins/models/index.js";

package/internals/plugins/allPlugins.d.ts

@@ -0,0 +1,14 @@
+import { ChartSeriesType } from '../../models/seriesType/config';
+import { UseChartCartesianAxisSignature } from './featurePlugins/useChartCartesianAxis';
+import { UseChartHighlightSignature } from './featurePlugins/useChartHighlight';
+import { UseChartInteractionSignature } from './featurePlugins/useChartInteraction';
+import { UseChartZAxisSignature } from './featurePlugins/useChartZAxis';
+import { ConvertSignaturesIntoPlugins } from './models/helpers';
+export type AllPluginSignatures<TSeries extends ChartSeriesType = ChartSeriesType> = [
+    UseChartZAxisSignature,
+    UseChartCartesianAxisSignature<TSeries>,
+    UseChartInteractionSignature,
+    UseChartHighlightSignature
+];
+export type AllPluginsType<TSeries extends ChartSeriesType = ChartSeriesType> = ConvertSignaturesIntoPlugins<AllPluginSignatures<TSeries>>;
+export declare const ALL_PLUGINS: (import("./models").ChartPlugin<UseChartCartesianAxisSignature<keyof import("..").ChartsSeriesConfig>> | import("./models").ChartPlugin<UseChartZAxisSignature> | import("./models").ChartPlugin<UseChartInteractionSignature> | import("./models").ChartPlugin<UseChartHighlightSignature>)[];

package/internals/plugins/allPlugins.js

@@ -0,0 +1,7 @@
+// This file should be removed after creating all plugins in favor of a file per chart type.
+
+import { useChartCartesianAxis } from "./featurePlugins/useChartCartesianAxis/index.js";
+import { useChartHighlight } from "./featurePlugins/useChartHighlight/useChartHighlight.js";
+import { useChartInteraction } from "./featurePlugins/useChartInteraction/index.js";
+import { useChartZAxis } from "./featurePlugins/useChartZAxis/index.js";
+export const ALL_PLUGINS = [useChartZAxis, useChartCartesianAxis, useChartInteraction, useChartHighlight];

package/internals/plugins/corePlugins/corePlugins.d.ts

@@ -0,0 +1,10 @@
+import { ConvertPluginsIntoSignatures } from '../models/helpers';
+import { UseChartIdParameters } from './useChartId';
+/**
+ * Internal plugins that create the tools used by the other plugins.
+ * These plugins are used by the Charts components.
+ */
+export declare const CHART_CORE_PLUGINS: readonly [import("../models").ChartPlugin<import("./useChartId").UseChartIdSignature>, import("../models").ChartPlugin<import("./useChartDimensions").UseChartDimensionsSignature>, import("../models").ChartPlugin<import("./useChartSeries").UseChartSeriesSignature>];
+export type ChartCorePluginSignatures = ConvertPluginsIntoSignatures<typeof CHART_CORE_PLUGINS>;
+export interface ChartCorePluginParameters extends UseChartIdParameters {
+}

package/internals/plugins/corePlugins/corePlugins.js

@@ -0,0 +1,9 @@
+import { useChartDimensions } from "./useChartDimensions/useChartDimensions.js";
+import { useChartId } from "./useChartId/index.js";
+import { useChartSeries } from "./useChartSeries/index.js";
+
+/**
+ * Internal plugins that create the tools used by the other plugins.
+ * These plugins are used by the Charts components.
+ */
+export const CHART_CORE_PLUGINS = [useChartId, useChartDimensions, useChartSeries];

package/internals/plugins/corePlugins/index.d.ts

@@ -0,0 +1,2 @@
+export { CHART_CORE_PLUGINS } from './corePlugins';
+export type { ChartCorePluginSignatures, ChartCorePluginParameters } from './corePlugins';

package/internals/plugins/corePlugins/index.js

@@ -0,0 +1 @@
+export { CHART_CORE_PLUGINS } from "./corePlugins.js";

package/internals/plugins/corePlugins/useChartDimensions/index.d.ts

@@ -0,0 +1,3 @@
+export { useChartDimensions } from './useChartDimensions';
+export type { UseChartDimensionsSignature, UseChartDimensionsParameters, UseChartDimensionsDefaultizedParameters, } from './useChartDimensions.types';
+export * from './useChartDimensions.selectors';

package/internals/plugins/corePlugins/useChartDimensions/index.js

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

package/internals/plugins/corePlugins/useChartDimensions/useChartDimensions.d.ts

@@ -0,0 +1,3 @@
+import { ChartPlugin } from '../../models';
+import { UseChartDimensionsSignature } from './useChartDimensions.types';
+export declare const useChartDimensions: ChartPlugin<UseChartDimensionsSignature>;

package/internals/plugins/corePlugins/useChartDimensions/useChartDimensions.js

@@ -0,0 +1,175 @@
+'use client';
+
+/* eslint-disable react-compiler/react-compiler */
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import useEnhancedEffect from '@mui/utils/useEnhancedEffect';
+import ownerWindow from '@mui/utils/ownerWindow';
+import { DEFAULT_MARGINS } from "../../../../constants/index.js";
+import { selectorChartDimensionsState } from "./useChartDimensions.selectors.js";
+const MAX_COMPUTE_RUN = 10;
+export const useChartDimensions = ({
+  params,
+  store,
+  svgRef
+}) => {
+  const hasInSize = params.width !== undefined && params.height !== undefined;
+  const stateRef = React.useRef({
+    displayError: false,
+    initialCompute: true,
+    computeRun: 0
+  });
+  // States only used for the initialization of the size.
+  const [innerWidth, setInnerWidth] = React.useState(0);
+  const [innerHeight, setInnerHeight] = React.useState(0);
+  const computeSize = React.useCallback(() => {
+    const mainEl = svgRef?.current;
+    if (!mainEl) {
+      return {};
+    }
+    const win = ownerWindow(mainEl);
+    const computedStyle = win.getComputedStyle(mainEl);
+    const newHeight = Math.floor(parseFloat(computedStyle.height)) || 0;
+    const newWidth = Math.floor(parseFloat(computedStyle.width)) || 0;
+    store.update(prev => {
+      const prevWidth = prev.dimensions.width + prev.dimensions.left + prev.dimensions.right;
+      const prevHeight = prev.dimensions.height + prev.dimensions.top + prev.dimensions.bottom;
+      if (prevWidth === newWidth && prevHeight === newHeight) {
+        return prev;
+      }
+      return _extends({}, prev, {
+        dimensions: _extends({}, prev.dimensions, {
+          width: newWidth - prev.dimensions.left - prev.dimensions.right,
+          height: newHeight - prev.dimensions.top - prev.dimensions.bottom
+        })
+      });
+    });
+    return {
+      height: newHeight,
+      width: newWidth
+    };
+  }, [store, svgRef]);
+  store.update(prev => {
+    if ((params.width === undefined || prev.dimensions.propsWidth === params.width) && (params.height === undefined || prev.dimensions.propsHeight === params.height)) {
+      return prev;
+    }
+    return _extends({}, prev, {
+      dimensions: _extends({}, prev.dimensions, {
+        width: params.width === undefined ? prev.dimensions.width : params.width - prev.dimensions.left - prev.dimensions.right,
+        height: params.height === undefined ? prev.dimensions.height : params.height - prev.dimensions.top - prev.dimensions.bottom,
+        propsWidth: params.width,
+        propsHeight: params.height
+      })
+    });
+  });
+  React.useEffect(() => {
+    // Ensure the error detection occurs after the first rendering.
+    stateRef.current.displayError = true;
+  }, []);
+
+  // This effect is used to compute the size of the container on the initial render.
+  // It is not bound to the raf loop to avoid an unwanted "resize" event.
+  // https://github.com/mui/mui-x/issues/13477#issuecomment-2336634785
+  useEnhancedEffect(() => {
+    // computeRun is used to avoid infinite loops.
+    if (hasInSize || !stateRef.current.initialCompute || stateRef.current.computeRun > MAX_COMPUTE_RUN) {
+      return;
+    }
+    const computedSize = computeSize();
+    if (computedSize.width !== innerWidth || computedSize.height !== innerHeight) {
+      stateRef.current.computeRun += 1;
+      if (computedSize.width !== undefined) {
+        setInnerWidth(computedSize.width);
+      }
+      if (computedSize.height !== undefined) {
+        setInnerHeight(computedSize.height);
+      }
+    } else if (stateRef.current.initialCompute) {
+      stateRef.current.initialCompute = false;
+    }
+  }, [innerHeight, innerWidth, computeSize, hasInSize]);
+  useEnhancedEffect(() => {
+    if (hasInSize) {
+      return () => {};
+    }
+    computeSize();
+    const elementToObserve = svgRef.current;
+    if (typeof ResizeObserver === 'undefined') {
+      return () => {};
+    }
+    let animationFrame;
+    const observer = new ResizeObserver(() => {
+      // See https://github.com/mui/mui-x/issues/8733
+      animationFrame = requestAnimationFrame(() => {
+        computeSize();
+      });
+    });
+    if (elementToObserve) {
+      observer.observe(elementToObserve);
+    }
+    return () => {
+      if (animationFrame) {
+        cancelAnimationFrame(animationFrame);
+      }
+      if (elementToObserve) {
+        observer.unobserve(elementToObserve);
+      }
+    };
+  }, [computeSize, hasInSize, svgRef]);
+  if (process.env.NODE_ENV !== 'production') {
+    if (stateRef.current.displayError && params.width === undefined && innerWidth === 0) {
+      console.error(`MUI X: ChartContainer does not have \`width\` prop, and its container has no \`width\` defined.`);
+      stateRef.current.displayError = false;
+    }
+    if (stateRef.current.displayError && params.height === undefined && innerHeight === 0) {
+      console.error(`MUI X: ChartContainer does not have \`height\` prop, and its container has no \`height\` defined.`);
+      stateRef.current.displayError = false;
+    }
+  }
+  const isPointInside = React.useCallback(({
+    x,
+    y
+  }, options) => {
+    // For element allowed to overflow, wrapping them in <g data-drawing-container /> make them fully part of the drawing area.
+    if (options?.targetElement && options?.targetElement.closest('[data-drawing-container]')) {
+      return true;
+    }
+    const drawingArea = selectorChartDimensionsState(store.value);
+    const isInsideX = x >= drawingArea.left - 1 && x <= drawingArea.left + drawingArea.width;
+    const isInsideY = y >= drawingArea.top - 1 && y <= drawingArea.top + drawingArea.height;
+    if (options?.direction === 'x') {
+      return isInsideX;
+    }
+    if (options?.direction === 'y') {
+      return isInsideY;
+    }
+    return isInsideX && isInsideY;
+  }, [store.value]);
+  return {
+    instance: {
+      isPointInside
+    }
+  };
+};
+useChartDimensions.params = {
+  width: true,
+  height: true,
+  margin: true
+};
+useChartDimensions.getDefaultizedParams = ({
+  params
+}) => _extends({}, params, {
+  margin: params.margin ? _extends({}, DEFAULT_MARGINS, params.margin) : DEFAULT_MARGINS
+});
+useChartDimensions.getInitialState = ({
+  width,
+  height,
+  margin
+}) => ({
+  dimensions: _extends({}, margin, {
+    width: (width ?? 0) - margin.left - margin.right,
+    height: (height ?? 0) - margin.top - margin.bottom,
+    propsWidth: width,
+    propsHeight: height
+  })
+});