@mui/x-charts-pro 9.8.0 → 9.9.0

package/internals/plugins/useChartProSampling/useChartProSampling.mjs

@@ -0,0 +1,52 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { useEffectAfterFirstRender } from '@mui/x-internals/useEffectAfterFirstRender';
+import { isDeepEqual } from '@mui/x-internals/isDeepEqual';
+/** Toggles sampling. Pyramids and level selection live in community selectors. */
+export const useChartProSampling = ({
+  params,
+  store
+}) => {
+  const {
+    sampling
+  } = params;
+  useEffectAfterFirstRender(() => {
+    // Skip the update when unchanged so an inlined `sampling` config (a new object each render, e.g.
+    // in composition) doesn't replace the state and force the pyramids to recompute every render.
+    const next = toSamplingState(sampling);
+    if (!isDeepEqual(store.state.sampling, next)) {
+      store.set('sampling', next);
+    }
+  }, [sampling, store]);
+  return {};
+};
+
+/** Maps the per-series-type `sampling` config to the internal state (enabled methods per type). */
+function toSamplingState(sampling = {}) {
+  const methods = {};
+  // Iterate generically so a new series type only needs its `sampling` config entry, no edit here.
+  Object.keys(sampling).forEach(seriesType => {
+    const method = sampling[seriesType];
+    if (method && method !== 'none') {
+      methods[seriesType] = method;
+    }
+  });
+  return {
+    enabled: Object.keys(methods).length > 0,
+    methods
+  };
+}
+useChartProSampling.params = {
+  sampling: true
+};
+useChartProSampling.getDefaultizedParams = ({
+  params
+}) => _extends({}, params, {
+  sampling: params.sampling ?? {}
+});
+useChartProSampling.getInitialState = ({
+  sampling
+}) => ({
+  sampling: toSamplingState(sampling)
+});

package/internals/plugins/useChartProSampling/useChartProSampling.types.d.mts

@@ -0,0 +1,25 @@
+import type { SamplingState, SamplingConfig, ChartPluginSignature, UseChartCartesianAxisSignature, UseChartSeriesSignature } from '@mui/x-charts/internals';
+export interface UseChartProSamplingParameters {
+  /**
+   * Per-series-type sampling configuration used to render large datasets when zoomed out.
+   * Each series type accepts only the methods valid for it:
+   * - bar: `'none'` | `'minmax'`.
+   * - line: `'none'` | `'minmax'` | `'m4'` | `'lttb'`.
+   *
+   * @example { line: 'lttb', bar: 'minmax' }
+   * @default {}
+   */
+  sampling?: SamplingConfig;
+}
+export interface UseChartProSamplingDefaultizedParameters {
+  sampling: SamplingConfig;
+}
+export interface UseChartProSamplingState {
+  sampling: SamplingState;
+}
+export type UseChartProSamplingSignature = ChartPluginSignature<{
+  params: UseChartProSamplingParameters;
+  defaultizedParams: UseChartProSamplingDefaultizedParameters;
+  state: UseChartProSamplingState;
+  dependencies: [UseChartSeriesSignature, UseChartCartesianAxisSignature];
+}>;

package/internals/plugins/useChartProSampling/useChartProSampling.types.d.ts

@@ -0,0 +1,25 @@
+import type { SamplingState, SamplingConfig, ChartPluginSignature, UseChartCartesianAxisSignature, UseChartSeriesSignature } from '@mui/x-charts/internals';
+export interface UseChartProSamplingParameters {
+  /**
+   * Per-series-type sampling configuration used to render large datasets when zoomed out.
+   * Each series type accepts only the methods valid for it:
+   * - bar: `'none'` | `'minmax'`.
+   * - line: `'none'` | `'minmax'` | `'m4'` | `'lttb'`.
+   *
+   * @example { line: 'lttb', bar: 'minmax' }
+   * @default {}
+   */
+  sampling?: SamplingConfig;
+}
+export interface UseChartProSamplingDefaultizedParameters {
+  sampling: SamplingConfig;
+}
+export interface UseChartProSamplingState {
+  sampling: SamplingState;
+}
+export type UseChartProSamplingSignature = ChartPluginSignature<{
+  params: UseChartProSamplingParameters;
+  defaultizedParams: UseChartProSamplingDefaultizedParameters;
+  state: UseChartProSamplingState;
+  dependencies: [UseChartSeriesSignature, UseChartCartesianAxisSignature];
+}>;

package/internals/plugins/useChartProSampling/useChartProSampling.types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/internals/plugins/useChartProSampling/useChartProSampling.types.mjs

@@ -0,0 +1 @@
+export {};

package/internals/plugins/useChartProZoom/gestureHooks/useRegisterZoomGestures.d.mts

@@ -1,5 +1,4 @@
-import type { ChartPlugin } from '@mui/x-charts/internals';
-import type { UseChartProZoomSignature } from "../useChartProZoom.types.mjs";
+import type { ChartUsedInstance } from '@mui/x-charts/internals';
 /**
  * Registers the gestures required by the zoom feature.
  * They are registered here instead of in the core interaction listener plugin
@@ -7,4 +6,6 @@ import type { UseChartProZoomSignature } from "../useChartProZoom.types.mjs";
  */
 export declare const useRegisterZoomGestures: ({
   instance
-}: Pick<Parameters<ChartPlugin<UseChartProZoomSignature>>[0], "instance">) => void;
+}: {
+  instance: ChartUsedInstance<any>;
+}) => void;

package/internals/plugins/useChartProZoom/gestureHooks/useRegisterZoomGestures.d.ts

@@ -1,5 +1,4 @@
-import type { ChartPlugin } from '@mui/x-charts/internals';
-import type { UseChartProZoomSignature } from "../useChartProZoom.types.js";
+import type { ChartUsedInstance } from '@mui/x-charts/internals';
 /**
  * Registers the gestures required by the zoom feature.
  * They are registered here instead of in the core interaction listener plugin
@@ -7,4 +6,6 @@ import type { UseChartProZoomSignature } from "../useChartProZoom.types.js";
  */
 export declare const useRegisterZoomGestures: ({
   instance
-}: Pick<Parameters<ChartPlugin<UseChartProZoomSignature>>[0], "instance">) => void;
+}: {
+  instance: ChartUsedInstance<any>;
+}) => void;

package/internals/plugins/useChartProZoom/gestureHooks/useRegisterZoomGestures.mjs

@@ -2,6 +2,7 @@
 
 import * as React from 'react';
 import { PanGesture, PinchGesture, PressAndDragGesture, TapAndDragGesture, TapGesture, TurnWheelGesture } from '@mui/x-internal-gestures/core';
+
 /**
  * Registers the gestures required by the zoom feature.
  * They are registered here instead of in the core interaction listener plugin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts-pro",
-  "version": "9.8.0",
+  "version": "9.9.0",
   "author": "MUI Team",
   "description": "The Pro plan edition of the MUI X Charts components.",
   "license": "SEE LICENSE IN LICENSE",
@@ -28,14 +28,14 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.29.7",
-    "@mui/utils": "^9.1.1",
+    "@mui/utils": "^9.2.0",
     "clsx": "^2.1.1",
     "prop-types": "^15.8.1",
     "@mui/x-charts-vendor": "^9.4.0",
-    "@mui/x-charts": "^9.8.0",
-    "@mui/x-internal-gestures": "^9.8.0",
-    "@mui/x-internals": "^9.8.0",
-    "@mui/x-license": "^9.8.0"
+    "@mui/x-charts": "^9.9.0",
+    "@mui/x-internal-gestures": "^9.9.0",
+    "@mui/x-license": "^9.9.0",
+    "@mui/x-internals": "^9.9.0"
   },
   "peerDependencies": {
     "@emotion/react": "^11.9.0",

package/typeOverloads/modules.d.mts

@@ -1,5 +1,5 @@
 import type { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
-import type { AxisId, CommonHighlightScope, SeriesId, ComputedXAxis, ComputedYAxis, ZoomOptions } from '@mui/x-charts/internals';
+import type { AxisId, CommonHighlightScope, SeriesId, ComputedXAxis, ComputedYAxis, ZoomOptions, BarSamplingMethod, SamplingMethod } from '@mui/x-charts/internals';
 import type { DefaultizedFunnelSeriesType, FunnelItemIdentifier, FunnelSeriesType, FunnelValueType } from "../FunnelChart/funnel.types.mjs";
 import type { HeatmapItemIdentifier, HeatmapItemIdentifierWithData, HeatmapSeriesType, DefaultizedHeatmapSeriesType, HeatmapValueType } from "../models/seriesType/heatmap.mjs";
 import type { SankeyLayout, SankeySeriesType, DefaultizedSankeySeriesType, SankeyItemIdentifier, SankeyItemIdentifierWithData } from "../SankeyChart/sankey.types.mjs";
@@ -71,6 +71,14 @@ declare module '@mui/x-charts/internals' {
       highlightIdentifier: SankeyItemIdentifier;
     };
   }
+  interface BarSeriesExtension {
+    /** Bar `sampling` method. */
+    samplingMethod: BarSamplingMethod;
+  }
+  interface LineSeriesExtension {
+    /** Line `sampling` method. */
+    samplingMethod: SamplingMethod;
+  }
   interface DefaultizedZoomOptions extends Required<ZoomOptions> {
     axisId: AxisId;
     axisDirection: 'x' | 'y';

package/typeOverloads/modules.d.ts

@@ -1,5 +1,5 @@
 import type { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
-import type { AxisId, CommonHighlightScope, SeriesId, ComputedXAxis, ComputedYAxis, ZoomOptions } from '@mui/x-charts/internals';
+import type { AxisId, CommonHighlightScope, SeriesId, ComputedXAxis, ComputedYAxis, ZoomOptions, BarSamplingMethod, SamplingMethod } from '@mui/x-charts/internals';
 import type { DefaultizedFunnelSeriesType, FunnelItemIdentifier, FunnelSeriesType, FunnelValueType } from "../FunnelChart/funnel.types.js";
 import type { HeatmapItemIdentifier, HeatmapItemIdentifierWithData, HeatmapSeriesType, DefaultizedHeatmapSeriesType, HeatmapValueType } from "../models/seriesType/heatmap.js";
 import type { SankeyLayout, SankeySeriesType, DefaultizedSankeySeriesType, SankeyItemIdentifier, SankeyItemIdentifierWithData } from "../SankeyChart/sankey.types.js";
@@ -71,6 +71,14 @@ declare module '@mui/x-charts/internals' {
       highlightIdentifier: SankeyItemIdentifier;
     };
   }
+  interface BarSeriesExtension {
+    /** Bar `sampling` method. */
+    samplingMethod: BarSamplingMethod;
+  }
+  interface LineSeriesExtension {
+    /** Line `sampling` method. */
+    samplingMethod: SamplingMethod;
+  }
   interface DefaultizedZoomOptions extends Required<ZoomOptions> {
     axisId: AxisId;
     axisDirection: 'x' | 'y';