@mui/x-charts-pro 8.0.0-beta.3 → 8.1.0

package/ChartContainerPro/ChartContainerPro.d.ts

@@ -7,6 +7,7 @@ export type ChartContainerProProps<TSeries extends ChartSeriesType = ChartSeries
 type ChartContainerProComponent = <TSeries extends ChartSeriesType = ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = AllPluginSignatures<TSeries>>(props: ChartContainerProProps<TSeries, TSignatures> & {
   ref?: React.ForwardedRef<SVGSVGElement>;
 }) => React.JSX.Element;
+export type ChartProApi = NonNullable<NonNullable<ChartContainerProProps['apiRef']>['current']>;
 /**
  * It sets up the data providers as well as the `<svg>` for the chart.
  *

package/ChartDataProviderPro/ChartDataProviderPro.d.ts

@@ -2,7 +2,7 @@ import * as React from 'react';
 import { ChartSeriesType, ChartAnyPluginSignature, ChartProviderProps } from '@mui/x-charts/internals';
 import { ChartDataProviderProps } from '@mui/x-charts/ChartDataProvider';
 import { AllPluginSignatures } from "../internals/plugins/allPlugins.js";
-export type ChartDataProviderProProps<TSeries extends ChartSeriesType = ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = AllPluginSignatures<TSeries>> = ChartDataProviderProps<TSeries, TSignatures> & Omit<ChartProviderProps<TSeries, TSignatures>['pluginParams'], 'children'>;
+export type ChartDataProviderProProps<TSeries extends ChartSeriesType = ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = AllPluginSignatures<TSeries>> = ChartDataProviderProps<TSeries, TSignatures> & ChartProviderProps<TSeries, TSignatures>['pluginParams'];
 /**
  * Orchestrates the data providers for the chart components and hooks.
  *

package/ChartDataProviderPro/ChartDataProviderPro.js

@@ -12,11 +12,12 @@ var React = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _Watermark = require("@mui/x-license/Watermark");
 var _internals = require("@mui/x-charts/internals");
+var _ChartsLocalizationProvider = require("@mui/x-charts/ChartsLocalizationProvider");
 var _useLicenseVerifier = require("@mui/x-license/useLicenseVerifier");
+var _allPlugins = require("../internals/plugins/allPlugins");
 var _useChartDataProviderProProps = require("./useChartDataProviderProProps");
-var _releaseInfo = require("../internals/utils/releaseInfo");
 var _jsxRuntime = require("react/jsx-runtime");
-const releaseInfo = (0, _releaseInfo.getReleaseInfo)();
+const releaseInfo = "MTc0NTQ0NTYwMDAwMA==";
 const packageIdentifier = 'x-charts-pro';
 /**
  * Orchestrates the data providers for the chart components and hooks.
@@ -48,17 +49,20 @@ const packageIdentifier = 'x-charts-pro';
 function ChartDataProviderPro(props) {
   const {
     children,
-    animationProviderProps,
+    localeText,
     chartProviderProps
-  } = (0, _useChartDataProviderProProps.useChartDataProviderProProps)(props);
+  } = (0, _useChartDataProviderProProps.useChartDataProviderProProps)((0, _extends2.default)({}, props, {
+    plugins: props.plugins ?? _allPlugins.DEFAULT_PLUGINS
+  }));
   (0, _useLicenseVerifier.useLicenseVerifier)(packageIdentifier, releaseInfo);
-  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_internals.ChartProvider, (0, _extends2.default)({}, chartProviderProps, {
-    children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_internals.AnimationProvider, (0, _extends2.default)({}, animationProviderProps, {
-      children: [children, /*#__PURE__*/(0, _jsxRuntime.jsx)(_Watermark.Watermark, {
-        packageName: packageIdentifier,
-        releaseInfo: releaseInfo
-      })]
-    }))
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_internals.ChartProvider, (0, _extends2.default)({}, chartProviderProps, {
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsLocalizationProvider.ChartsLocalizationProvider, {
+      localeText: localeText,
+      children: children
+    }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Watermark.Watermark, {
+      packageName: packageIdentifier,
+      releaseInfo: releaseInfo
+    })]
   }));
 }
 process.env.NODE_ENV !== "production" ? ChartDataProviderPro.propTypes = {
@@ -66,47 +70,57 @@ process.env.NODE_ENV !== "production" ? ChartDataProviderPro.propTypes = {
   // | These PropTypes are generated from the TypeScript type definitions |
   // | To update them edit the TypeScript types and run "pnpm proptypes"  |
   // ----------------------------------------------------------------------
-  apiRef: _propTypes.default.any,
-  children: _propTypes.default.node,
+  apiRef: _propTypes.default.shape({
+    current: _propTypes.default.any
+  }),
   /**
    * Color palette used to colorize multiple series.
    * @default rainbowSurgePalette
    */
-  colors: _propTypes.default.any,
+  colors: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.func]),
   /**
    * An array of objects that can be used to populate series and axes data using their `dataKey` property.
    */
-  dataset: _propTypes.default.any,
+  dataset: _propTypes.default.arrayOf(_propTypes.default.object),
   /**
    * The height of the chart in px. If not defined, it takes the height of the parent element.
    */
-  height: _propTypes.default.any,
+  height: _propTypes.default.number,
   /**
    * This prop is used to help implement the accessibility logic.
    * If you don't provide this prop. It falls back to a randomly generated id.
    */
-  id: _propTypes.default.any,
+  id: _propTypes.default.string,
+  /**
+   * Localized text for chart components.
+   */
+  localeText: _propTypes.default.object,
   /**
    * The margin between the SVG and the drawing area.
    * It's used for leaving some space for extra information such as the x- and y-axis or legend.
    *
    * Accepts a `number` to be used on all sides or an object with the optional properties: `top`, `bottom`, `left`, and `right`.
    */
-  margin: _propTypes.default.any,
+  margin: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.shape({
+    bottom: _propTypes.default.number,
+    left: _propTypes.default.number,
+    right: _propTypes.default.number,
+    top: _propTypes.default.number
+  })]),
   /**
    * The array of series to display.
    * Each type of series has its own specificity.
    * Please refer to the appropriate docs page to learn more about it.
    */
-  series: _propTypes.default.any,
+  series: _propTypes.default.arrayOf(_propTypes.default.object),
   /**
    * If `true`, animations are skipped.
    * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
    */
-  skipAnimation: _propTypes.default.any,
-  theme: _propTypes.default.any,
+  skipAnimation: _propTypes.default.bool,
+  theme: _propTypes.default.oneOf(['dark', 'light']),
   /**
    * The width of the chart in px. If not defined, it takes the width of the parent element.
    */
-  width: _propTypes.default.any
+  width: _propTypes.default.number
 } : void 0;

package/ChartDataProviderPro/useChartDataProviderProProps.d.ts

@@ -3,6 +3,6 @@ import type { ChartDataProviderProProps } from './ChartDataProviderPro';
 import type { AllPluginSignatures } from '../internals/plugins/allPlugins';
 export declare const useChartDataProviderProProps: <TSeries extends ChartSeriesType = ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = AllPluginSignatures<TSeries>>(props: ChartDataProviderProProps<TSeries, TSignatures>) => {
   children: import("react").ReactNode;
-  animationProviderProps: Omit<import("@mui/x-charts/internals").AnimationProviderProps, "children">;
-  chartProviderProps: Omit<import("@mui/x-charts/internals").ChartProviderProps<TSeries, TSignatures>, "children">;
+  localeText: Partial<import("@mui/x-charts/locales").ChartsLocaleText> | undefined;
+  chartProviderProps: import("@mui/x-charts/internals").ChartProviderProps<TSeries, TSignatures>;
 };

package/ChartDataProviderPro/useChartDataProviderProProps.js

@@ -8,13 +8,13 @@ exports.useChartDataProviderProProps = void 0;
 var _internals = require("@mui/x-charts/internals");
 const useChartDataProviderProProps = props => {
   const {
-    animationProviderProps,
     chartProviderProps,
+    localeText,
     children
   } = (0, _internals.useChartDataProviderProps)(props);
   return {
     children,
-    animationProviderProps,
+    localeText,
     chartProviderProps
   };
 };

package/FunnelChart/FunnelChart.js

@@ -70,6 +70,7 @@ process.env.NODE_ENV !== "production" ? FunnelChart.propTypes = {
   // ----------------------------------------------------------------------
   apiRef: _propTypes.default.shape({
     current: _propTypes.default.shape({
+      exportAsPrint: _propTypes.default.func.isRequired,
       setZoomData: _propTypes.default.func.isRequired
     })
   }),
@@ -88,18 +89,87 @@ process.env.NODE_ENV !== "production" ? FunnelChart.propTypes = {
    *
    * @default { position: 'none' }
    */
-  categoryAxis: _propTypes.default.shape({
+  categoryAxis: _propTypes.default.oneOfType([_propTypes.default.shape({
     categories: _propTypes.default.arrayOf(_propTypes.default.string),
     disableLine: _propTypes.default.bool,
     disableTicks: _propTypes.default.bool,
     id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
     position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
-    scaleType: _propTypes.default.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
+    scaleType: _propTypes.default.oneOf(['band']),
     size: _propTypes.default.number,
     tickLabelStyle: _propTypes.default.object,
     tickSize: _propTypes.default.number
-  }),
-  children: _propTypes.default.node,
+  }), _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['point']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  }), _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['log']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  }), _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['pow']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  }), _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['sqrt']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  }), _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['time']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  }), _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['utc']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  }), _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['linear']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  })]),
   className: _propTypes.default.string,
   /**
    * Color palette used to colorize multiple series.
@@ -149,6 +219,10 @@ process.env.NODE_ENV !== "production" ? FunnelChart.propTypes = {
    * @default false
    */
   loading: _propTypes.default.bool,
+  /**
+   * Localized text for chart components.
+   */
+  localeText: _propTypes.default.object,
   /**
    * The margin between the SVG and the drawing area.
    * It's used for leaving some space for extra information such as the x- and y-axis or legend.

package/FunnelChart/categoryAxis.types.d.ts

@@ -1,6 +1,6 @@
 import { AxisConfig, ScaleName } from '@mui/x-charts/models';
 import { MakeOptional } from '@mui/x-internals/types';
-export type CategoryAxis = {
+export type CategoryAxis<S extends ScaleName = ScaleName> = S extends ScaleName ? {
   /**
    * The categories to be displayed on the axis.
    * The order of the categories is the order in which they are displayed.
@@ -21,4 +21,5 @@ export type CategoryAxis = {
    * - If the axis is vertical, the size is the width of the axis.
    */
   size?: number;
-} & MakeOptional<Pick<AxisConfig<ScaleName, any>, 'disableLine' | 'disableTicks' | 'scaleType' | 'tickLabelStyle' | 'tickSize' | 'id'>, 'id'>;
+  scaleType?: S;
+} & MakeOptional<Pick<AxisConfig<S, any>, 'disableLine' | 'disableTicks' | 'tickLabelStyle' | 'tickSize' | 'id'>, 'id'> : never;

package/FunnelChart/funnelSectionClasses.d.ts

@@ -8,6 +8,11 @@ export interface FunnelSectionClasses {
   faded: string;
   /** Styles applied to the label element. */
   label: string;
+  /**
+   * Styles applied to the root element for a specified series.
+   * Needs to be suffixed with the series ID: `.${funnelSectionClasses.series}-${seriesId}`.
+   */
+  series: string;
 }
 export declare const useUtilityClasses: (props: FunnelSectionProps) => Record<"label" | "highlighted" | "faded" | "root", string>;
 export declare const funnelSectionClasses: FunnelSectionClasses;

package/FunnelChart/funnelSectionClasses.js

@@ -25,4 +25,4 @@ const useUtilityClasses = props => {
   return (0, _composeClasses.default)(slots, getFunnelSectionUtilityClass, classes);
 };
 exports.useUtilityClasses = useUtilityClasses;
-const funnelSectionClasses = exports.funnelSectionClasses = (0, _generateUtilityClasses.default)('MuiFunnelSection', ['root', 'highlighted', 'faded', 'label']);
+const funnelSectionClasses = exports.funnelSectionClasses = (0, _generateUtilityClasses.default)('MuiFunnelSection', ['root', 'highlighted', 'faded', 'label', 'series']);

package/FunnelChart/index.d.ts

@@ -2,6 +2,7 @@ export { FunnelChart as Unstable_FunnelChart } from "./FunnelChart.js";
 export type { FunnelChartProps } from './FunnelChart';
 export * from "./FunnelPlot.js";
 export * from "./funnel.types.js";
+export * from "./categoryAxis.types.js";
 export * from "./funnelSlots.types.js";
 export { funnelSectionClasses } from "./funnelSectionClasses.js";
 export type { FunnelSectionClasses } from './funnelSectionClasses';

package/FunnelChart/index.js

@@ -44,6 +44,18 @@ Object.keys(_funnel).forEach(function (key) {
     }
   });
 });
+var _categoryAxis = require("./categoryAxis.types");
+Object.keys(_categoryAxis).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _categoryAxis[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _categoryAxis[key];
+    }
+  });
+});
 var _funnelSlots = require("./funnelSlots.types");
 Object.keys(_funnelSlots).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/FunnelChart/useFunnelChartProps.js

@@ -35,7 +35,6 @@ function getCategoryAxisConfig(categoryAxis, series, isHorizontal, direction) {
   // If the scaleType is not defined or is 'band', our job is simple.
   if (!categoryAxis?.scaleType || categoryAxis.scaleType === 'band') {
     return (0, _extends2.default)({
-      scaleType: 'band',
       categoryGapRatio: 0,
       // Use the categories as the domain if they are defined.
       data: categoryAxis?.categories ? categoryAxis.categories :
@@ -44,7 +43,9 @@ function getCategoryAxisConfig(categoryAxis, series, isHorizontal, direction) {
         length: maxSeriesLength
       }, (_, index) => index),
       tickLabelPlacement: 'middle'
-    }, categoryValues);
+    }, categoryValues, {
+      scaleType: 'band'
+    });
   }
 
   // If the scaleType is other than 'band', we have to do some magic.
@@ -53,7 +54,6 @@ function getCategoryAxisConfig(categoryAxis, series, isHorizontal, direction) {
   // We add the total value of the series as the last tick value
   maxSeriesValue.reduce((a, value) => a + value, 0)];
   return (0, _extends2.default)({
-    scaleType: categoryAxis.scaleType,
     domainLimit: 'strict',
     tickLabelPlacement: 'middle',
     tickInterval: tickValues,

package/Heatmap/Heatmap.js

@@ -135,7 +135,6 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
   apiRef: _propTypes.default.shape({
     current: _propTypes.default.object
   }),
-  children: _propTypes.default.node,
   className: _propTypes.default.string,
   /**
    * Color palette used to colorize multiple series.
@@ -175,6 +174,10 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
    * @default false
    */
   loading: _propTypes.default.bool,
+  /**
+   * Localized text for chart components.
+   */
+  localeText: _propTypes.default.object,
   /**
    * The margin between the SVG and the drawing area.
    * It's used for leaving some space for extra information such as the x- and y-axis or legend.
@@ -206,7 +209,7 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
    */
   series: _propTypes.default.arrayOf(_propTypes.default.object).isRequired,
   /**
-   * The configuration helpers used to compute attributes according to the serries type.
+   * The configuration helpers used to compute attributes according to the series type.
    * @ignore Unstable props for internal usage.
    */
   seriesConfig: _propTypes.default.object,

package/Heatmap/HeatmapItem.js

@@ -21,7 +21,7 @@ const _excluded = ["seriesId", "dataIndex", "color", "value", "slotProps", "slot
 const HeatmapCell = (0, _styles.styled)('rect', {
   name: 'MuiHeatmap',
   slot: 'Cell',
-  overridesResolver: (_, styles) => styles.arc
+  overridesResolver: (_, styles) => styles.arc // FIXME: Inconsistent naming with slot
 })(({
   ownerState
 }) => ({

package/Heatmap/heatmapClasses.d.ts

@@ -5,6 +5,11 @@ export interface HeatmapClasses {
   highlighted: string;
   /** Styles applied to the cell element if faded. */
   faded: string;
+  /**
+   * Styles applied to the root element for a specified series.
+   * Needs to be suffixed with the series ID: `.${heatmapClasses.series}-${seriesId}`.
+   */
+  series: string;
 }
 export type HeatmapClassKey = keyof HeatmapClasses;
 export declare function getHeatmapUtilityClass(slot: string): string;

package/Heatmap/heatmapClasses.js

@@ -16,7 +16,7 @@ function getHeatmapUtilityClass(slot) {
   }
   return (0, _generateUtilityClass.default)('MuiHeatmap', slot);
 }
-const heatmapClasses = exports.heatmapClasses = (0, _extends2.default)({}, (0, _generateUtilityClasses.default)('MuiHeatmap', ['cell']), {
+const heatmapClasses = exports.heatmapClasses = (0, _extends2.default)({}, (0, _generateUtilityClasses.default)('MuiHeatmap', ['cell', 'series']), {
   highlighted: 'Charts-highlighted',
   faded: 'Charts-faded'
 });