@mui/x-charts-pro 8.0.0-alpha.1 → 8.0.0-alpha.11

package/node/ChartDataProviderPro/ChartDataProviderPro.js

@@ -0,0 +1,111 @@
+"use strict";
+'use client';
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ChartDataProviderPro = ChartDataProviderPro;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+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 _useLicenseVerifier = require("@mui/x-license/useLicenseVerifier");
+var _useChartDataProviderProProps = require("./useChartDataProviderProProps");
+var _releaseInfo = require("../internals/utils/releaseInfo");
+var _jsxRuntime = require("react/jsx-runtime");
+const releaseInfo = (0, _releaseInfo.getReleaseInfo)();
+const packageIdentifier = 'x-charts-pro';
+/**
+ * Orchestrates the data providers for the chart components and hooks.
+ *
+ * Use this component if you have custom HTML components that need to access the chart data.
+ *
+ * Demos:
+ *
+ * - [Composition](https://mui.com/x/api/charts/composition/)
+ *
+ * API:
+ *
+ * - [ChartDataProviderPro API](https://mui.com/x/api/charts/chart-data-provider/)
+ *
+ * @example
+ * ```jsx
+ * <ChartDataProviderPro
+ *   series={[{ label: "Label", type: "bar", data: [10, 20] }]}
+ *   xAxis={[{ data: ["A", "B"], scaleType: "band", id: "x-axis" }]}
+ * >
+ *   <ChartsSurface>
+ *      <BarPlot />
+ *      <ChartsXAxis position="bottom" axisId="x-axis" />
+ *   </ChartsSurface>
+ *   {'Custom Legend Component'}
+ * </ChartDataProviderPro>
+ * ```
+ */
+function ChartDataProviderPro(props) {
+  const {
+    children,
+    animationProviderProps,
+    chartProviderProps
+  } = (0, _useChartDataProviderProProps.useChartDataProviderProProps)(props);
+  (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
+      })]
+    }))
+  }));
+}
+process.env.NODE_ENV !== "production" ? ChartDataProviderPro.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | 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,
+  /**
+   * Color palette used to colorize multiple series.
+   * @default rainbowSurgePalette
+   */
+  colors: _propTypes.default.any,
+  /**
+   * An array of objects that can be used to populate series and axes data using their `dataKey` property.
+   */
+  dataset: _propTypes.default.any,
+  /**
+   * The height of the chart in px. If not defined, it takes the height of the parent element.
+   */
+  height: _propTypes.default.any,
+  /**
+   * 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,
+  /**
+   * 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 an object with the optional properties: `top`, `bottom`, `left`, and `right`.
+   */
+  margin: _propTypes.default.any,
+  /**
+   * 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,
+  /**
+   * 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,
+  /**
+   * The width of the chart in px. If not defined, it takes the width of the parent element.
+   */
+  width: _propTypes.default.any
+} : void 0;

package/node/ChartDataProviderPro/useChartDataProviderProProps.js

@@ -0,0 +1,21 @@
+"use strict";
+'use client';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useChartDataProviderProProps = void 0;
+var _internals = require("@mui/x-charts/internals");
+const useChartDataProviderProProps = props => {
+  const {
+    animationProviderProps,
+    chartProviderProps,
+    children
+  } = (0, _internals.useChartDataProviderProps)(props);
+  return {
+    children,
+    animationProviderProps,
+    chartProviderProps
+  };
+};
+exports.useChartDataProviderProProps = useChartDataProviderProProps;

package/node/Heatmap/Heatmap.js

@@ -15,15 +15,18 @@ var _useId = _interopRequireDefault(require("@mui/utils/useId"));
 var _d3Interpolate = require("@mui/x-charts-vendor/d3-interpolate");
 var _ChartsAxis = require("@mui/x-charts/ChartsAxis");
 var _ChartsClipPath = require("@mui/x-charts/ChartsClipPath");
-var _ChartsOnAxisClickHandler = require("@mui/x-charts/ChartsOnAxisClickHandler");
 var _ChartsOverlay = require("@mui/x-charts/ChartsOverlay");
 var _ChartContainerPro = require("../ChartContainerPro");
 var _HeatmapPlot = require("./HeatmapPlot");
 var _plugin = require("./plugin");
 var _HeatmapTooltip = require("./HeatmapTooltip");
+var _Heatmap = require("./Heatmap.plugins");
 var _jsxRuntime = require("react/jsx-runtime");
 // The GnBu: https://github.com/d3/d3-scale-chromatic/blob/main/src/sequential-multi/GnBu.js
 const defaultColorMap = (0, _d3Interpolate.interpolateRgbBasis)(['#f7fcf0', '#e0f3db', '#ccebc5', '#a8ddb5', '#7bccc4', '#4eb3d3', '#2b8cbe', '#0868ac', '#084081']);
+const seriesConfig = {
+  heatmap: _plugin.plugin
+};
 const Heatmap = exports.Heatmap = /*#__PURE__*/React.forwardRef(function Heatmap(inProps, ref) {
   const props = (0, _styles.useThemeProps)({
     props: inProps,
@@ -73,7 +76,7 @@ const Heatmap = exports.Heatmap = /*#__PURE__*/React.forwardRef(function Heatmap
   const Tooltip = props.slots?.tooltip ?? _HeatmapTooltip.HeatmapTooltip;
   return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_ChartContainerPro.ChartContainerPro, {
     ref: ref,
-    plugins: [_plugin.plugin],
+    seriesConfig: seriesConfig,
     series: series.map(s => (0, _extends2.default)({
       type: 'heatmap'
     }, s)),
@@ -89,9 +92,9 @@ const Heatmap = exports.Heatmap = /*#__PURE__*/React.forwardRef(function Heatmap
     disableAxisListener: true,
     highlightedItem: highlightedItem,
     onHighlightChange: onHighlightChange,
-    children: [onAxisClick && /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsOnAxisClickHandler.ChartsOnAxisClickHandler, {
-      onAxisClick: onAxisClick
-    }), /*#__PURE__*/(0, _jsxRuntime.jsxs)("g", {
+    onAxisClick: onAxisClick,
+    plugins: _Heatmap.HEATMAP_PLUGINS,
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)("g", {
       clipPath: `url(#${clipPathId})`,
       children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_HeatmapPlot.HeatmapPlot, {
         slots: slots,
@@ -118,6 +121,11 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
   // | These PropTypes are generated from the TypeScript type definitions |
   // | To update them edit the TypeScript types and run "pnpm proptypes"  |
   // ----------------------------------------------------------------------
+  apiRef: _propTypes.default.shape({
+    current: _propTypes.default.shape({
+      setZoomData: _propTypes.default.func.isRequired
+    })
+  }),
   /**
    * Indicate which axis to display the bottom of the charts.
    * Can be a string (the id of the axis) or an object `ChartsXAxisProps`.
@@ -128,7 +136,7 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
   className: _propTypes.default.string,
   /**
    * Color palette used to colorize multiple series.
-   * @default blueberryTwilightPalette
+   * @default rainbowSurgePalette
    */
   colors: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.func]),
   /**
@@ -147,12 +155,26 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
    */
   height: _propTypes.default.number,
   /**
-   * The item currently highlighted. Turns highlighting into a controlled prop.
+   * The highlighted item.
+   * Used when the highlight is controlled.
    */
   highlightedItem: _propTypes.default.shape({
     dataIndex: _propTypes.default.number,
-    seriesId: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string])
+    seriesId: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]).isRequired
   }),
+  /**
+   * 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.string,
+  /**
+   * The list of zoom data related to each axis.
+   */
+  initialZoom: _propTypes.default.arrayOf(_propTypes.default.shape({
+    axisId: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]).isRequired,
+    end: _propTypes.default.number.isRequired,
+    start: _propTypes.default.number.isRequired
+  })),
   /**
    * Indicate which axis to display the left of the charts.
    * Can be a string (the id of the axis) or an object `ChartsYAxisProps`.
@@ -168,7 +190,6 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
    * 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 an object with the optional properties: `top`, `bottom`, `left`, and `right`.
-   * @default object Depends on the charts type.
    */
   margin: _propTypes.default.shape({
     bottom: _propTypes.default.number,
@@ -200,6 +221,11 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
    * An array of [[HeatmapSeriesType]] objects.
    */
   series: _propTypes.default.arrayOf(_propTypes.default.object).isRequired,
+  /**
+   * The configuration helpers used to compute attributes according to the serries type.
+   * @ignore Unstable props for internal usage.
+   */
+  seriesConfig: _propTypes.default.object,
   /**
    * The props used for each component slot.
    * @default {}
@@ -211,6 +237,7 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
    */
   slots: _propTypes.default.object,
   sx: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object, _propTypes.default.bool])), _propTypes.default.func, _propTypes.default.object]),
+  theme: _propTypes.default.oneOf(['dark', 'light']),
   title: _propTypes.default.string,
   /**
    * The configuration of the tooltip.
@@ -260,7 +287,6 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
     hideTooltip: _propTypes.default.bool,
     id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
     label: _propTypes.default.string,
-    labelFontSize: _propTypes.default.number,
     labelStyle: _propTypes.default.object,
     max: _propTypes.default.oneOfType([_propTypes.default.instanceOf(Date), _propTypes.default.number]),
     min: _propTypes.default.oneOfType([_propTypes.default.instanceOf(Date), _propTypes.default.number]),
@@ -271,7 +297,6 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
     slots: _propTypes.default.object,
     stroke: _propTypes.default.string,
     sx: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object, _propTypes.default.bool])), _propTypes.default.func, _propTypes.default.object]),
-    tickFontSize: _propTypes.default.number,
     tickInterval: _propTypes.default.oneOfType([_propTypes.default.oneOf(['auto']), _propTypes.default.array, _propTypes.default.func]),
     tickLabelInterval: _propTypes.default.oneOfType([_propTypes.default.oneOf(['auto']), _propTypes.default.func]),
     tickLabelPlacement: _propTypes.default.oneOf(['middle', 'tick']),
@@ -325,7 +350,6 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
     hideTooltip: _propTypes.default.bool,
     id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
     label: _propTypes.default.string,
-    labelFontSize: _propTypes.default.number,
     labelStyle: _propTypes.default.object,
     max: _propTypes.default.oneOfType([_propTypes.default.instanceOf(Date), _propTypes.default.number]),
     min: _propTypes.default.oneOfType([_propTypes.default.instanceOf(Date), _propTypes.default.number]),
@@ -336,7 +360,6 @@ process.env.NODE_ENV !== "production" ? Heatmap.propTypes = {
     slots: _propTypes.default.object,
     stroke: _propTypes.default.string,
     sx: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object, _propTypes.default.bool])), _propTypes.default.func, _propTypes.default.object]),
-    tickFontSize: _propTypes.default.number,
     tickInterval: _propTypes.default.oneOfType([_propTypes.default.oneOf(['auto']), _propTypes.default.array, _propTypes.default.func]),
     tickLabelInterval: _propTypes.default.oneOfType([_propTypes.default.oneOf(['auto']), _propTypes.default.func]),
     tickLabelPlacement: _propTypes.default.oneOf(['middle', 'tick']),

package/node/Heatmap/Heatmap.plugins.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HEATMAP_PLUGINS = void 0;
+var _internals = require("@mui/x-charts/internals");
+const HEATMAP_PLUGINS = exports.HEATMAP_PLUGINS = [_internals.useChartZAxis, _internals.useChartCartesianAxis, _internals.useChartInteraction, _internals.useChartHighlight];

package/node/Heatmap/HeatmapItem.js

@@ -13,7 +13,7 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _styles = require("@mui/material/styles");
 var _useSlotProps = _interopRequireDefault(require("@mui/utils/useSlotProps"));
 var _composeClasses = _interopRequireDefault(require("@mui/utils/composeClasses"));
-var _context = require("@mui/x-charts/context");
+var _hooks = require("@mui/x-charts/hooks");
 var _internals = require("@mui/x-charts/internals");
 var _heatmapClasses = require("./heatmapClasses");
 var _jsxRuntime = require("react/jsx-runtime");
@@ -59,7 +59,7 @@ function HeatmapItem(props) {
   const {
     isFaded,
     isHighlighted
-  } = (0, _context.useItemHighlighted)({
+  } = (0, _hooks.useItemHighlighted)({
     seriesId,
     dataIndex
   });

package/node/Heatmap/HeatmapTooltip.js

@@ -11,6 +11,7 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
 var React = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _clsx = _interopRequireDefault(require("clsx"));
+var _HTMLElementType = _interopRequireDefault(require("@mui/utils/HTMLElementType"));
 var _composeClasses = _interopRequireDefault(require("@mui/utils/composeClasses"));
 var _ChartsTooltip = require("@mui/x-charts/ChartsTooltip");
 var _hooks = require("@mui/x-charts/hooks");
@@ -34,10 +35,6 @@ const useUtilityClasses = ownerState => {
   };
   return (0, _composeClasses.default)(slots, _ChartsTooltip.getChartsTooltipUtilityClass, classes);
 };
-
-/**
- * @ignore - internal component.
- */
 function DefaultHeatmapTooltipContent(props) {
   const {
     classes
@@ -57,7 +54,8 @@ function DefaultHeatmapTooltipContent(props) {
   const {
     color,
     value,
-    identifier
+    identifier,
+    markType
   } = tooltipData;
   const [xIndex, yIndex] = value;
   const formattedX = xAxis.valueFormatter?.(xAxis.data[xIndex], {
@@ -90,7 +88,8 @@ function DefaultHeatmapTooltipContent(props) {
           className: classes?.row,
           children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsTooltip.ChartsTooltipCell, {
             className: (0, _clsx.default)(classes?.markCell, classes?.cell),
-            children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsTooltip.ChartsTooltipMark, {
+            children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_internals.ChartsLabelMark, {
+              type: markType,
               color: color,
               className: classes?.mark
             })
@@ -139,26 +138,7 @@ process.env.NODE_ENV !== "production" ? HeatmapTooltip.propTypes = {
    * It's used to set the position of the popper.
    * The return value will passed as the reference object of the Popper instance.
    */
-  anchorEl: _propTypes.default.oneOfType([(props, propName) => {
-    if (props[propName] == null) {
-      return new Error(`Prop '${propName}' is required but wasn't specified`);
-    }
-    if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {
-      return new Error(`Expected prop '${propName}' to be of type Element`);
-    }
-    return null;
-  }, _propTypes.default.func, _propTypes.default.shape({
-    contextElement: (props, propName) => {
-      if (props[propName] == null) {
-        return null;
-      }
-      if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {
-        return new Error(`Expected prop '${propName}' to be of type Element`);
-      }
-      return null;
-    },
-    getBoundingClientRect: _propTypes.default.func.isRequired
-  })]),
+  anchorEl: _propTypes.default /* @typescript-to-proptypes-ignore */.oneOfType([_HTMLElementType.default, _propTypes.default.object, _propTypes.default.func]),
   /**
    * Override or extend the styles applied to the component.
    */

package/node/Heatmap/formatter.js

@@ -16,7 +16,8 @@ const formatter = params => {
     defaultizedSeries[seriesId] = (0, _extends2.default)({
       // Defaultize the data and the value formatter.
       valueFormatter: v => v[2].toString(),
-      data: []
+      data: [],
+      labelMarkType: 'square'
     }, series[seriesId]);
   });
   return {

package/node/Heatmap/heatmapClasses.js

@@ -7,15 +7,16 @@ Object.defineProperty(exports, "__esModule", {
 exports.getHeatmapUtilityClass = getHeatmapUtilityClass;
 exports.heatmapClasses = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var _utils = require("@mui/utils");
+var _generateUtilityClass = _interopRequireDefault(require("@mui/utils/generateUtilityClass"));
+var _generateUtilityClasses = _interopRequireDefault(require("@mui/utils/generateUtilityClasses"));
 function getHeatmapUtilityClass(slot) {
   // Those should be common to all charts
   if (['highlighted', 'faded'].includes(slot)) {
-    return (0, _utils.unstable_generateUtilityClass)('Charts', slot);
+    return (0, _generateUtilityClass.default)('Charts', slot);
   }
-  return (0, _utils.unstable_generateUtilityClass)('MuiHeatmap', slot);
+  return (0, _generateUtilityClass.default)('MuiHeatmap', slot);
 }
-const heatmapClasses = exports.heatmapClasses = (0, _extends2.default)({}, (0, _utils.unstable_generateUtilityClasses)('MuiHeatmap', ['cell']), {
+const heatmapClasses = exports.heatmapClasses = (0, _extends2.default)({}, (0, _generateUtilityClasses.default)('MuiHeatmap', ['cell']), {
   highlighted: 'Charts-highlighted',
   faded: 'Charts-faded'
 });

package/node/Heatmap/plugin.js

@@ -8,10 +8,12 @@ exports.plugin = void 0;
 var _extremums = require("./extremums");
 var _formatter = _interopRequireDefault(require("./formatter"));
 var _getColor = _interopRequireDefault(require("./getColor"));
+var _tooltip = _interopRequireDefault(require("./tooltip"));
 const plugin = exports.plugin = {
-  seriesType: 'heatmap',
-  seriesFormatter: _formatter.default,
+  seriesProcessor: _formatter.default,
   colorProcessor: _getColor.default,
+  legendGetter: () => [],
+  tooltipGetter: _tooltip.default,
   xExtremumGetter: _extremums.getBaseExtremum,
   yExtremumGetter: _extremums.getBaseExtremum
 };

package/node/Heatmap/tooltip.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _internals = require("@mui/x-charts/internals");
+const tooltipGetter = params => {
+  const {
+    series,
+    getColor,
+    identifier
+  } = params;
+  if (!identifier || identifier.dataIndex === undefined) {
+    return null;
+  }
+  const label = (0, _internals.getLabel)(series.label, 'tooltip');
+  const value = series.data[identifier.dataIndex];
+  const formattedValue = series.valueFormatter(value, {
+    dataIndex: identifier.dataIndex
+  });
+  return {
+    identifier,
+    color: getColor(identifier.dataIndex),
+    label,
+    value,
+    formattedValue,
+    markType: series.labelMarkType
+  };
+};
+var _default = exports.default = tooltipGetter;