@mui/x-charts-pro 8.0.0-alpha.8 → 8.0.0-beta.0

package/esm/internals/plugins/useChartProZoom/useChartProZoom.utils.d.ts

@@ -0,0 +1,45 @@
+import { DefaultizedZoomOptions, ZoomData } from '@mui/x-charts/internals';
+/**
+ * Helper to get the range (in percents of a reference range) corresponding to a given scale.
+ * @param centerRatio {number} The ratio of the point that should not move between the previous and next range.
+ * @param scaleRatio {number} The target scale ratio.
+ * @returns The range to display.
+ */
+export declare const zoomAtPoint: (centerRatio: number, scaleRatio: number, currentZoomData: ZoomData, options: DefaultizedZoomOptions) => number[];
+/**
+ * Checks if the new span is valid.
+ */
+export declare function isSpanValid(minRange: number, maxRange: number, isZoomIn: boolean, option: DefaultizedZoomOptions): boolean;
+/**
+ * Get the scale ratio and if it's a zoom in or out from a wheel event.
+ */
+export declare function getWheelScaleRatio(event: WheelEvent, step: number): {
+  scaleRatio: number;
+  isZoomIn: boolean;
+};
+/**
+ * Get the scale ratio and if it's a zoom in or out from a pinch gesture.
+ */
+export declare function getPinchScaleRatio(curDiff: number, prevDiff: number, step: number): {
+  scaleRatio: number;
+  isZoomIn: boolean;
+};
+export declare function getDiff(eventCache: PointerEvent[]): number;
+/**
+ * Get the ratio of the point in the horizontal center of the area.
+ */
+export declare function getHorizontalCenterRatio(point: {
+  x: number;
+  y: number;
+}, area: {
+  left: number;
+  width: number;
+}): number;
+export declare function preventDefault(event: TouchEvent): void;
+export declare function getVerticalCenterRatio(point: {
+  x: number;
+  y: number;
+}, area: {
+  top: number;
+  height: number;
+}): number;

package/{node → esm}/internals/plugins/useChartProZoom/useChartProZoom.utils.js

@@ -1,23 +1,10 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getDiff = getDiff;
-exports.getHorizontalCenterRatio = getHorizontalCenterRatio;
-exports.getPinchScaleRatio = getPinchScaleRatio;
-exports.getVerticalCenterRatio = getVerticalCenterRatio;
-exports.getWheelScaleRatio = getWheelScaleRatio;
-exports.isSpanValid = isSpanValid;
-exports.preventDefault = preventDefault;
-exports.zoomAtPoint = void 0;
 /**
  * Helper to get the range (in percents of a reference range) corresponding to a given scale.
  * @param centerRatio {number} The ratio of the point that should not move between the previous and next range.
  * @param scaleRatio {number} The target scale ratio.
  * @returns The range to display.
  */
-const zoomAtPoint = (centerRatio, scaleRatio, currentZoomData, options) => {
+export const zoomAtPoint = (centerRatio, scaleRatio, currentZoomData, options) => {
   const MIN_RANGE = options.minStart;
   const MAX_RANGE = options.maxEnd;
   const MIN_ALLOWED_SPAN = options.minSpan;
@@ -49,8 +36,7 @@ const zoomAtPoint = (centerRatio, scaleRatio, currentZoomData, options) => {
 /**
  * Checks if the new span is valid.
  */
-exports.zoomAtPoint = zoomAtPoint;
-function isSpanValid(minRange, maxRange, isZoomIn, option) {
+export function isSpanValid(minRange, maxRange, isZoomIn, option) {
   const newSpanPercent = maxRange - minRange;
   if (isZoomIn && newSpanPercent < option.minSpan || !isZoomIn && newSpanPercent > option.maxSpan) {
     return false;
@@ -77,7 +63,7 @@ function getMultiplier(event) {
 /**
  * Get the scale ratio and if it's a zoom in or out from a wheel event.
  */
-function getWheelScaleRatio(event, step) {
+export function getWheelScaleRatio(event, step) {
   const deltaY = -event.deltaY;
   const multiplier = getMultiplier(event);
   const scaledStep = step * multiplier * deltaY / 1000;
@@ -93,7 +79,7 @@ function getWheelScaleRatio(event, step) {
 /**
  * Get the scale ratio and if it's a zoom in or out from a pinch gesture.
  */
-function getPinchScaleRatio(curDiff, prevDiff, step) {
+export function getPinchScaleRatio(curDiff, prevDiff, step) {
   const scaledStep = step / 1000;
   let scaleRatio = 0;
   let isZoomIn = false;
@@ -113,7 +99,7 @@ function getPinchScaleRatio(curDiff, prevDiff, step) {
     isZoomIn
   };
 }
-function getDiff(eventCache) {
+export function getDiff(eventCache) {
   const [firstEvent, secondEvent] = eventCache;
   return Math.hypot(firstEvent.pageX - secondEvent.pageX, firstEvent.pageY - secondEvent.pageY);
 }
@@ -121,17 +107,17 @@ function getDiff(eventCache) {
 /**
  * Get the ratio of the point in the horizontal center of the area.
  */
-function getHorizontalCenterRatio(point, area) {
+export function getHorizontalCenterRatio(point, area) {
   const {
     left,
     width
   } = area;
   return (point.x - left) / width;
 }
-function preventDefault(event) {
+export function preventDefault(event) {
   event.preventDefault();
 }
-function getVerticalCenterRatio(point, area) {
+export function getVerticalCenterRatio(point, area) {
   const {
     top,
     height

package/esm/internals/utils/releaseInfo.d.ts

@@ -0,0 +1 @@
+export declare const getReleaseInfo: () => any;

package/esm/internals/utils/releaseInfo.js

@@ -0,0 +1,13 @@
+import ponyfillGlobal from '@mui/utils/ponyfillGlobal';
+export const getReleaseInfo = () => {
+  const releaseInfo = "MTc0MjI0ODgwMDAwMA==";
+  if (process.env.NODE_ENV !== 'production') {
+    // A simple hack to set the value in the test environment (has no build step).
+    // eslint-disable-next-line no-useless-concat
+    if (releaseInfo === '__RELEASE' + '_INFO__') {
+      // eslint-disable-next-line no-underscore-dangle
+      return ponyfillGlobal.__MUI_RELEASE_INFO__;
+    }
+  }
+  return releaseInfo;
+};

package/esm/models/index.d.ts

@@ -0,0 +1,2 @@
+export type { ZoomData } from '@mui/x-charts/internals';
+export * from "./seriesType/index.js";

package/esm/models/index.js

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

package/esm/models/seriesType/heatmap.d.ts

@@ -0,0 +1,28 @@
+import { DefaultizedProps } from '@mui/x-internals/types';
+import { CommonDefaultizedProps, CommonSeriesType, CartesianSeriesType } from '@mui/x-charts/internals';
+export type HeatmapValueType = readonly [number, number, number];
+export interface HeatmapSeriesType extends Omit<CommonSeriesType<HeatmapValueType>, 'color'>, CartesianSeriesType {
+  type: 'heatmap';
+  /**
+   * Data associated to each bar.
+   */
+  data?: readonly HeatmapValueType[];
+  /**
+   * The key used to retrieve data from the dataset.
+   */
+  dataKey?: string;
+  /**
+   * The label to display on the tooltip or the legend. It can be a string or a function.
+   */
+  label?: string | ((location: 'tooltip' | 'legend') => string);
+}
+/**
+ * An object that allows to identify a single bar.
+ * Used for item interaction
+ */
+export type HeatmapItemIdentifier = {
+  type: 'heatmap';
+  seriesId: DefaultizedHeatmapSeriesType['id'];
+  dataIndex: number;
+};
+export interface DefaultizedHeatmapSeriesType extends DefaultizedProps<HeatmapSeriesType, CommonDefaultizedProps> {}

package/esm/models/seriesType/heatmap.js

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

package/esm/models/seriesType/index.d.ts

@@ -0,0 +1 @@
+export * from "./heatmap.js";

package/esm/models/seriesType/index.js

@@ -0,0 +1 @@
+export * from "./heatmap.js";

package/esm/package.json

@@ -0,0 +1 @@
+{"type":"module","sideEffects":false}

package/esm/themeAugmentation/components.d.ts

@@ -0,0 +1,23 @@
+import { ComponentsProps, ComponentsOverrides } from '@mui/material/styles';
+export interface ChartsProComponents<Theme = unknown> {
+  // BarChartPro components
+  MuiBarChartPro?: {
+    defaultProps?: ComponentsProps['MuiBarChartPro'];
+  };
+  // LineChartPro components
+  MuiLineChartPro?: {
+    defaultProps?: ComponentsProps['MuiLineChartPro'];
+  };
+  // Heatmap components
+  MuiHeatmap?: {
+    defaultProps?: ComponentsProps['MuiHeatmap'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiHeatmap'];
+  };
+  // ScatterChartPro components
+  MuiScatterChartPro?: {
+    defaultProps?: ComponentsProps['MuiScatterChartPro'];
+  };
+}
+declare module '@mui/material/styles' {
+  interface Components<Theme = unknown> extends ChartsProComponents<Theme> {}
+}

package/esm/themeAugmentation/index.d.ts

@@ -0,0 +1,4 @@
+export type * from '@mui/x-charts/themeAugmentation';
+export type * from './overrides';
+export type * from './props';
+export type * from './components';

package/esm/themeAugmentation/overrides.d.ts

@@ -0,0 +1,11 @@
+import { HeatmapClassKey } from "../Heatmap/index.js";
+export interface ChartsProComponentNameToClassKey {
+  // Heatmap components
+  MuiHeatmap: HeatmapClassKey;
+}
+declare module '@mui/material/styles' {
+  interface ComponentNameToClassKey extends ChartsProComponentNameToClassKey {}
+}
+
+// disable automatic export
+export {};

package/esm/themeAugmentation/props.d.ts

@@ -0,0 +1,20 @@
+import { ScatterChartProProps } from "../ScatterChartPro/index.js";
+import { BarChartProProps } from "../BarChartPro/index.js";
+import { HeatmapProps } from "../Heatmap/Heatmap.js";
+import { LineChartProProps } from "../LineChartPro/index.js";
+export interface ChartsProComponentsPropsList {
+  // BarChartPro components
+  MuiBarChartPro: BarChartProProps;
+  // LineChartPro components
+  MuiLineChartPro: LineChartProProps;
+  // Heatmap components
+  MuiHeatmap: HeatmapProps;
+  // ScatterChartPro components
+  MuiScatterChartPro: ScatterChartProProps;
+}
+declare module '@mui/material/styles' {
+  interface ComponentsPropsList extends ChartsProComponentsPropsList {}
+}
+
+// disable automatic export
+export {};

package/esm/typeOverloads/index.d.ts

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

package/esm/typeOverloads/index.js

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

package/esm/typeOverloads/modules.d.ts

@@ -0,0 +1,33 @@
+import { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
+import { AxisId, ZoomOptions } from '@mui/x-charts/internals';
+import { HeatmapItemIdentifier, HeatmapSeriesType, DefaultizedHeatmapSeriesType, HeatmapValueType } from "../models/seriesType/heatmap.js";
+import { DefaultizedFunnelSeriesType, FunnelItemIdentifier, FunnelSeriesType, FunnelValueType } from "../FunnelChart/funnel.types.js";
+declare module '@mui/x-charts/internals' {
+  interface ChartsSeriesConfig {
+    heatmap: {
+      seriesInput: DefaultizedProps<HeatmapSeriesType, 'id'>;
+      series: DefaultizedHeatmapSeriesType;
+      seriesProp: HeatmapSeriesType;
+      itemIdentifier: HeatmapItemIdentifier;
+      valueType: HeatmapValueType;
+      axisType: 'cartesian';
+    };
+    funnel: {
+      seriesInput: Omit<DefaultizedProps<FunnelSeriesType, 'id'>, 'data'> & {
+        data: MakeRequired<FunnelValueType, 'color'>[];
+      };
+      series: DefaultizedFunnelSeriesType;
+      seriesProp: FunnelSeriesType;
+      itemIdentifier: FunnelItemIdentifier;
+      valueType: MakeRequired<FunnelValueType, 'id' | 'color'>;
+      axisType: 'cartesian';
+    };
+  }
+  interface DefaultizedZoomOptions extends Required<ZoomOptions> {
+    axisId: AxisId;
+    axisDirection: 'x' | 'y';
+  }
+  interface AxisConfigExtension {
+    zoom?: boolean | ZoomOptions;
+  }
+}

package/esm/typeOverloads/modules.js

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

package/hooks/index.d.ts

@@ -1,2 +1,2 @@
-export { useHeatmapSeries as unstable_useHeatmapSeries } from './useSeries';
-export * from './zoom';
+export { useHeatmapSeries } from "./useHeatmapSeries.js";
+export * from "./zoom/index.js";

package/hooks/index.js

@@ -1,2 +1,27 @@
-export { useHeatmapSeries as unstable_useHeatmapSeries } from "./useSeries.js";
-export * from "./zoom/index.js";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  useHeatmapSeries: true
+};
+Object.defineProperty(exports, "useHeatmapSeries", {
+  enumerable: true,
+  get: function () {
+    return _useHeatmapSeries.useHeatmapSeries;
+  }
+});
+var _useHeatmapSeries = require("./useHeatmapSeries");
+var _zoom = require("./zoom");
+Object.keys(_zoom).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _zoom[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _zoom[key];
+    }
+  });
+});

package/hooks/useFunnelSeries.d.ts

@@ -0,0 +1,33 @@
+import { ProcessedSeries, SeriesId, ChartSeriesDefaultized } from '@mui/x-charts/internals';
+export type UseFunnelSeriesReturnValue = ChartSeriesDefaultized<'funnel'>;
+export type UseFunnelSeriesContextReturnValue = ProcessedSeries['funnel'];
+/**
+ * Get access to the internal state of funnel series.
+ *
+ * @param {SeriesId} seriesId The id of the series to get.
+ * @returns {UseFunnelSeriesReturnValue} the funnel series
+ */
+export declare function useFunnelSeries(seriesId: SeriesId): UseFunnelSeriesReturnValue | undefined;
+/**
+ * Get access to the internal state of funnel series.
+ *
+ * When called without arguments, it returns all funnel series.
+ *
+ * @returns {UseFunnelSeriesReturnValue[]} the funnel series
+ */
+export declare function useFunnelSeries(): UseFunnelSeriesReturnValue[];
+/**
+ * Get access to the internal state of funnel series.
+ *
+ * @param {SeriesId[]} seriesIds The ids of the series to get. Order is preserved.
+ * @returns {UseFunnelSeriesReturnValue[]} the funnel series
+ */
+export declare function useFunnelSeries(seriesIds: SeriesId[]): UseFunnelSeriesReturnValue[];
+/**
+ * Get access to the internal state of funnel series.
+ * The returned object contains:
+ * - series: a mapping from ids to series attributes.
+ * - seriesOrder: the array of series ids.
+ * @returns the funnel series
+ */
+export declare function useFunnelSeriesContext(): UseFunnelSeriesContextReturnValue;

package/hooks/useFunnelSeries.js

@@ -0,0 +1,48 @@
+"use strict";
+'use client';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useFunnelSeries = useFunnelSeries;
+exports.useFunnelSeriesContext = useFunnelSeriesContext;
+var _internals = require("@mui/x-charts/internals");
+const useSelectorSeries = (0, _internals.createSeriesSelectorsOfType)('funnel');
+const useSelectorSeriesContext = (0, _internals.createAllSeriesSelectorOfType)('funnel');
+
+/**
+ * Get access to the internal state of funnel series.
+ *
+ * @param {SeriesId} seriesId The id of the series to get.
+ * @returns {UseFunnelSeriesReturnValue} the funnel series
+ */
+
+/**
+ * Get access to the internal state of funnel series.
+ *
+ * When called without arguments, it returns all funnel series.
+ *
+ * @returns {UseFunnelSeriesReturnValue[]} the funnel series
+ */
+
+/**
+ * Get access to the internal state of funnel series.
+ *
+ * @param {SeriesId[]} seriesIds The ids of the series to get. Order is preserved.
+ * @returns {UseFunnelSeriesReturnValue[]} the funnel series
+ */
+
+function useFunnelSeries(seriesIds) {
+  return useSelectorSeries(seriesIds);
+}
+
+/**
+ * Get access to the internal state of funnel series.
+ * The returned object contains:
+ * - series: a mapping from ids to series attributes.
+ * - seriesOrder: the array of series ids.
+ * @returns the funnel series
+ */
+function useFunnelSeriesContext() {
+  return useSelectorSeriesContext();
+}

package/hooks/useHeatmapSeries.d.ts

@@ -0,0 +1,33 @@
+import { ProcessedSeries, SeriesId, ChartSeriesDefaultized } from '@mui/x-charts/internals';
+export type UseHeatmapSeriesReturnValue = ChartSeriesDefaultized<'heatmap'>;
+export type UseHeatmapSeriesContextReturnValue = ProcessedSeries['heatmap'];
+/**
+ * Get access to the internal state of heatmap series.
+ *
+ * @param {SeriesId} seriesId The id of the series to get.
+ * @returns {UseHeatmapSeriesReturnValue} the heatmap series
+ */
+export declare function useHeatmapSeries(seriesId: SeriesId): UseHeatmapSeriesReturnValue | undefined;
+/**
+ * Get access to the internal state of heatmap series.
+ *
+ * When called without arguments, it returns all heatmap series.
+ *
+ * @returns {UseHeatmapSeriesReturnValue[]} the heatmap series
+ */
+export declare function useHeatmapSeries(): UseHeatmapSeriesReturnValue[];
+/**
+ * Get access to the internal state of heatmap series.
+ *
+ * @param {SeriesId[]} seriesIds The ids of the series to get. Order is preserved.
+ * @returns {UseHeatmapSeriesReturnValue[]} the heatmap series
+ */
+export declare function useHeatmapSeries(seriesIds: SeriesId[]): UseHeatmapSeriesReturnValue[];
+/**
+ * Get access to the internal state of heatmap series.
+ * The returned object contains:
+ * - series: a mapping from ids to series attributes.
+ * - seriesOrder: the array of series ids.
+ * @returns the heatmap series
+ */
+export declare function useHeatmapSeriesContext(): UseHeatmapSeriesContextReturnValue;

package/hooks/useHeatmapSeries.js

@@ -0,0 +1,48 @@
+"use strict";
+'use client';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useHeatmapSeries = useHeatmapSeries;
+exports.useHeatmapSeriesContext = useHeatmapSeriesContext;
+var _internals = require("@mui/x-charts/internals");
+const useSelectorSeries = (0, _internals.createSeriesSelectorsOfType)('heatmap');
+const useSelectorSeriesContext = (0, _internals.createAllSeriesSelectorOfType)('heatmap');
+
+/**
+ * Get access to the internal state of heatmap series.
+ *
+ * @param {SeriesId} seriesId The id of the series to get.
+ * @returns {UseHeatmapSeriesReturnValue} the heatmap series
+ */
+
+/**
+ * Get access to the internal state of heatmap series.
+ *
+ * When called without arguments, it returns all heatmap series.
+ *
+ * @returns {UseHeatmapSeriesReturnValue[]} the heatmap series
+ */
+
+/**
+ * Get access to the internal state of heatmap series.
+ *
+ * @param {SeriesId[]} seriesIds The ids of the series to get. Order is preserved.
+ * @returns {UseHeatmapSeriesReturnValue[]} the heatmap series
+ */
+
+function useHeatmapSeries(seriesIds) {
+  return useSelectorSeries(seriesIds);
+}
+
+/**
+ * Get access to the internal state of heatmap series.
+ * The returned object contains:
+ * - series: a mapping from ids to series attributes.
+ * - seriesOrder: the array of series ids.
+ * @returns the heatmap series
+ */
+function useHeatmapSeriesContext() {
+  return useSelectorSeriesContext();
+}

package/hooks/zoom/index.d.ts

@@ -1 +1 @@
-export * from './useIsZoomInteracting';
+export * from "./useIsZoomInteracting.js";

package/hooks/zoom/index.js

@@ -1 +1,16 @@
-export * from "./useIsZoomInteracting.js";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _useIsZoomInteracting = require("./useIsZoomInteracting");
+Object.keys(_useIsZoomInteracting).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _useIsZoomInteracting[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _useIsZoomInteracting[key];
+    }
+  });
+});

package/hooks/zoom/useIsZoomInteracting.d.ts

@@ -3,4 +3,4 @@
  *
  * @returns {boolean} Inform the zoom is interacting.
  */
-export declare function useIsZoomInteracting(): boolean;
+export declare function useIsZoomInteracting(): boolean;

package/hooks/zoom/useIsZoomInteracting.js

@@ -1,14 +1,19 @@
+"use strict";
 'use client';
 
-import { useSelector, useStore } from '@mui/x-charts/internals';
-import { selectorChartZoomIsInteracting } from "../../internals/plugins/useChartProZoom/index.js";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useIsZoomInteracting = useIsZoomInteracting;
+var _internals = require("@mui/x-charts/internals");
+var _useChartProZoom = require("../../internals/plugins/useChartProZoom");
 /**
  * Get access to the zoom state.
  *
  * @returns {boolean} Inform the zoom is interacting.
  */
-export function useIsZoomInteracting() {
-  const store = useStore();
-  const isInteracting = useSelector(store, selectorChartZoomIsInteracting);
+function useIsZoomInteracting() {
+  const store = (0, _internals.useStore)();
+  const isInteracting = (0, _internals.useSelector)(store, _useChartProZoom.selectorChartZoomIsInteracting);
   return isInteracting;
 }

package/index.d.ts

@@ -1,3 +1,4 @@
+import "./typeOverloads/modules.js";
 export * from '@mui/x-charts/constants';
 export * from '@mui/x-charts/context';
 export * from '@mui/x-charts/hooks';
@@ -13,17 +14,21 @@ export * from '@mui/x-charts/ChartsText';
 export * from '@mui/x-charts/ChartsTooltip';
 export * from '@mui/x-charts/ChartsLegend';
 export * from '@mui/x-charts/ChartsAxisHighlight';
-export * from '@mui/x-charts/ChartsVoronoiHandler';
-export * from '@mui/x-charts/ChartsOnAxisClickHandler';
 export * from '@mui/x-charts/BarChart';
 export * from '@mui/x-charts/LineChart';
 export * from '@mui/x-charts/PieChart';
 export * from '@mui/x-charts/ScatterChart';
 export * from '@mui/x-charts/SparkLineChart';
 export * from '@mui/x-charts/Gauge';
+export * from '@mui/x-charts/RadarChart';
 export * from '@mui/x-charts/ChartsSurface';
-export * from './Heatmap';
-export * from './ChartContainerPro';
-export * from './ScatterChartPro';
-export * from './BarChartPro';
-export * from './LineChartPro';
+export * from '@mui/x-charts/ChartDataProvider';
+export * from '@mui/x-charts/ChartsLabel';
+export * from "./hooks/index.js";
+export * from "./Heatmap/index.js";
+export * from "./ChartContainerPro/index.js";
+export * from "./ChartDataProviderPro/index.js";
+export * from "./ScatterChartPro/index.js";
+export * from "./BarChartPro/index.js";
+export * from "./LineChartPro/index.js";
+export * from "./FunnelChart/index.js";