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

package/ChartDataProviderPro/ChartDataProviderPro.d.ts

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import { ChartSeriesType, ChartAnyPluginSignature } from '@mui/x-charts/internals';
+import { ChartSeriesType, ChartAnyPluginSignature, ChartProviderProps } from '@mui/x-charts/internals';
 import { ChartDataProviderProps } from '@mui/x-charts/ChartDataProvider';
-import { AllPluginSignatures } from '../internals/plugins/allPlugins';
-export type ChartDataProviderProProps<TSeries extends ChartSeriesType = ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = AllPluginSignatures<TSeries>> = ChartDataProviderProps<TSeries, TSignatures>;
+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'>;
 /**
  * Orchestrates the data providers for the chart components and hooks.
  *
@@ -24,14 +24,14 @@ export type ChartDataProviderProProps<TSeries extends ChartSeriesType = ChartSer
  * >
  *   <ChartsSurface>
  *      <BarPlot />
- *      <ChartsXAxis position="bottom" axisId="x-axis" />
+ *      <ChartsXAxis axisId="x-axis" />
  *   </ChartsSurface>
  *   {'Custom Legend Component'}
  * </ChartDataProviderPro>
  * ```
  */
-declare function ChartDataProviderPro<TSeries extends ChartSeriesType = ChartSeriesType>(props: ChartDataProviderProProps<TSeries>): React.JSX.Element;
+declare function ChartDataProviderPro<TSeries extends ChartSeriesType = ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = AllPluginSignatures<TSeries>>(props: ChartDataProviderProProps<TSeries, TSignatures>): React.JSX.Element;
 declare namespace ChartDataProviderPro {
-    var propTypes: any;
+  var propTypes: any;
 }
-export { ChartDataProviderPro };
+export { ChartDataProviderPro };

package/ChartDataProviderPro/ChartDataProviderPro.js

@@ -1,16 +1,22 @@
+"use strict";
 'use client';
 
-import _extends from "@babel/runtime/helpers/esm/extends";
-import * as React from 'react';
-import PropTypes from 'prop-types';
-import { Watermark } from '@mui/x-license/Watermark';
-import { ChartProvider, AnimationProvider } from '@mui/x-charts/internals';
-import { HighlightedProvider } from '@mui/x-charts/context';
-import { useLicenseVerifier } from '@mui/x-license/useLicenseVerifier';
-import { useChartDataProviderProProps } from "./useChartDataProviderProProps.js";
-import { getReleaseInfo } from "../internals/utils/releaseInfo.js";
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-const releaseInfo = getReleaseInfo();
+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.
@@ -33,7 +39,7 @@ const packageIdentifier = 'x-charts-pro';
  * >
  *   <ChartsSurface>
  *      <BarPlot />
- *      <ChartsXAxis position="bottom" axisId="x-axis" />
+ *      <ChartsXAxis axisId="x-axis" />
  *   </ChartsSurface>
  *   {'Custom Legend Component'}
  * </ChartDataProviderPro>
@@ -42,19 +48,16 @@ const packageIdentifier = 'x-charts-pro';
 function ChartDataProviderPro(props) {
   const {
     children,
-    highlightedProviderProps,
     animationProviderProps,
     chartProviderProps
-  } = useChartDataProviderProProps(props);
-  useLicenseVerifier(packageIdentifier, releaseInfo);
-  return /*#__PURE__*/_jsx(ChartProvider, _extends({}, chartProviderProps, {
-    children: /*#__PURE__*/_jsx(HighlightedProvider, _extends({}, highlightedProviderProps, {
-      children: /*#__PURE__*/_jsxs(AnimationProvider, _extends({}, animationProviderProps, {
-        children: [children, /*#__PURE__*/_jsx(Watermark, {
-          packageName: packageIdentifier,
-          releaseInfo: releaseInfo
-        })]
-      }))
+  } = (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
+      })]
     }))
   }));
 }
@@ -63,230 +66,47 @@ 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.shape({
-    current: PropTypes.shape({
-      setZoomData: PropTypes.func.isRequired
-    })
-  }),
-  children: PropTypes.node,
+  apiRef: _propTypes.default.any,
+  children: _propTypes.default.node,
   /**
    * Color palette used to colorize multiple series.
-   * @default blueberryTwilightPalette
+   * @default rainbowSurgePalette
    */
-  colors: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.func]),
+  colors: _propTypes.default.any,
   /**
    * An array of objects that can be used to populate series and axes data using their `dataKey` property.
    */
-  dataset: PropTypes.arrayOf(PropTypes.object),
+  dataset: _propTypes.default.any,
   /**
    * The height of the chart in px. If not defined, it takes the height of the parent element.
    */
-  height: PropTypes.number,
-  /**
-   * The item currently highlighted. Turns highlighting into a controlled prop.
-   */
-  highlightedItem: PropTypes.shape({
-    dataIndex: PropTypes.number,
-    seriesId: PropTypes.oneOfType([PropTypes.number, PropTypes.string])
-  }),
+  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.string,
-  /**
-   * The list of zoom data related to each axis.
-   */
-  initialZoom: PropTypes.arrayOf(PropTypes.shape({
-    axisId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired,
-    end: PropTypes.number.isRequired,
-    start: PropTypes.number.isRequired
-  })),
+  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.shape({
-    bottom: PropTypes.number,
-    left: PropTypes.number,
-    right: PropTypes.number,
-    top: PropTypes.number
-  }),
-  /**
-   * The callback fired when the highlighted item changes.
    *
-   * @param {HighlightItemData | null} highlightedItem  The newly highlighted item.
+   * Accepts a `number` to be used on all sides or an object with the optional properties: `top`, `bottom`, `left`, and `right`.
    */
-  onHighlightChange: PropTypes.func,
-  /**
-   * Callback fired when the zoom has changed.
-   *
-   * @param {ZoomData[]} zoomData Updated zoom data.
-   */
-  onZoomChange: PropTypes.func,
+  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.arrayOf(PropTypes.object),
+  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.bool,
-  theme: PropTypes.oneOf(['dark', 'light']),
+  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.number,
-  /**
-   * The configuration of the x-axes.
-   * If not provided, a default axis config is used.
-   * An array of [[AxisConfig]] objects.
-   */
-  xAxis: PropTypes.arrayOf(PropTypes.shape({
-    classes: PropTypes.object,
-    colorMap: PropTypes.oneOfType([PropTypes.shape({
-      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
-      type: PropTypes.oneOf(['ordinal']).isRequired,
-      unknownColor: PropTypes.string,
-      values: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number, PropTypes.string]).isRequired)
-    }), PropTypes.shape({
-      color: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string.isRequired), PropTypes.func]).isRequired,
-      max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-      min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-      type: PropTypes.oneOf(['continuous']).isRequired
-    }), PropTypes.shape({
-      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
-      thresholds: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]).isRequired).isRequired,
-      type: PropTypes.oneOf(['piecewise']).isRequired
-    })]),
-    data: PropTypes.array,
-    dataKey: PropTypes.string,
-    disableLine: PropTypes.bool,
-    disableTicks: PropTypes.bool,
-    domainLimit: PropTypes.oneOfType([PropTypes.oneOf(['nice', 'strict']), PropTypes.func]),
-    fill: PropTypes.string,
-    hideTooltip: PropTypes.bool,
-    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-    label: PropTypes.string,
-    labelStyle: PropTypes.object,
-    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    position: PropTypes.oneOf(['bottom', 'top']),
-    reverse: PropTypes.bool,
-    scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
-    slotProps: PropTypes.object,
-    slots: PropTypes.object,
-    stroke: PropTypes.string,
-    sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
-    tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
-    tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
-    tickLabelPlacement: PropTypes.oneOf(['middle', 'tick']),
-    tickLabelStyle: PropTypes.object,
-    tickMaxStep: PropTypes.number,
-    tickMinStep: PropTypes.number,
-    tickNumber: PropTypes.number,
-    tickPlacement: PropTypes.oneOf(['end', 'extremities', 'middle', 'start']),
-    tickSize: PropTypes.number,
-    valueFormatter: PropTypes.func,
-    zoom: PropTypes.oneOfType([PropTypes.shape({
-      filterMode: PropTypes.oneOf(['discard', 'keep']),
-      maxEnd: PropTypes.number,
-      maxSpan: PropTypes.number,
-      minSpan: PropTypes.number,
-      minStart: PropTypes.number,
-      panning: PropTypes.bool,
-      step: PropTypes.number
-    }), PropTypes.bool])
-  })),
-  /**
-   * The configuration of the y-axes.
-   * If not provided, a default axis config is used.
-   * An array of [[AxisConfig]] objects.
-   */
-  yAxis: PropTypes.arrayOf(PropTypes.shape({
-    classes: PropTypes.object,
-    colorMap: PropTypes.oneOfType([PropTypes.shape({
-      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
-      type: PropTypes.oneOf(['ordinal']).isRequired,
-      unknownColor: PropTypes.string,
-      values: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number, PropTypes.string]).isRequired)
-    }), PropTypes.shape({
-      color: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string.isRequired), PropTypes.func]).isRequired,
-      max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-      min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-      type: PropTypes.oneOf(['continuous']).isRequired
-    }), PropTypes.shape({
-      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
-      thresholds: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]).isRequired).isRequired,
-      type: PropTypes.oneOf(['piecewise']).isRequired
-    })]),
-    data: PropTypes.array,
-    dataKey: PropTypes.string,
-    disableLine: PropTypes.bool,
-    disableTicks: PropTypes.bool,
-    domainLimit: PropTypes.oneOfType([PropTypes.oneOf(['nice', 'strict']), PropTypes.func]),
-    fill: PropTypes.string,
-    hideTooltip: PropTypes.bool,
-    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-    label: PropTypes.string,
-    labelStyle: PropTypes.object,
-    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    position: PropTypes.oneOf(['left', 'right']),
-    reverse: PropTypes.bool,
-    scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
-    slotProps: PropTypes.object,
-    slots: PropTypes.object,
-    stroke: PropTypes.string,
-    sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
-    tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
-    tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
-    tickLabelPlacement: PropTypes.oneOf(['middle', 'tick']),
-    tickLabelStyle: PropTypes.object,
-    tickMaxStep: PropTypes.number,
-    tickMinStep: PropTypes.number,
-    tickNumber: PropTypes.number,
-    tickPlacement: PropTypes.oneOf(['end', 'extremities', 'middle', 'start']),
-    tickSize: PropTypes.number,
-    valueFormatter: PropTypes.func,
-    zoom: PropTypes.oneOfType([PropTypes.shape({
-      filterMode: PropTypes.oneOf(['discard', 'keep']),
-      maxEnd: PropTypes.number,
-      maxSpan: PropTypes.number,
-      minSpan: PropTypes.number,
-      minStart: PropTypes.number,
-      panning: PropTypes.bool,
-      step: PropTypes.number
-    }), PropTypes.bool])
-  })),
-  /**
-   * The configuration of the z-axes.
-   */
-  zAxis: PropTypes.arrayOf(PropTypes.shape({
-    colorMap: PropTypes.oneOfType([PropTypes.shape({
-      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
-      type: PropTypes.oneOf(['ordinal']).isRequired,
-      unknownColor: PropTypes.string,
-      values: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number, PropTypes.string]).isRequired)
-    }), PropTypes.shape({
-      color: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string.isRequired), PropTypes.func]).isRequired,
-      max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-      min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-      type: PropTypes.oneOf(['continuous']).isRequired
-    }), PropTypes.shape({
-      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
-      thresholds: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]).isRequired).isRequired,
-      type: PropTypes.oneOf(['piecewise']).isRequired
-    })]),
-    data: PropTypes.array,
-    dataKey: PropTypes.string,
-    id: PropTypes.string,
-    max: PropTypes.number,
-    min: PropTypes.number
-  }))
-} : void 0;
-export { ChartDataProviderPro };
+  width: _propTypes.default.any
+} : void 0;

package/ChartDataProviderPro/index.d.ts

@@ -1 +1,2 @@
-export * from './ChartDataProviderPro';
+import "../typeOverloads/index.js";
+export * from "./ChartDataProviderPro.js";

package/ChartDataProviderPro/index.js

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

package/ChartDataProviderPro/useChartDataProviderProProps.d.ts

@@ -1,8 +1,8 @@
-import { ChartSeriesType } from '@mui/x-charts/internals';
+import { ChartAnyPluginSignature, ChartSeriesType } from '@mui/x-charts/internals';
 import type { ChartDataProviderProProps } from './ChartDataProviderPro';
-export declare const useChartDataProviderProProps: <TSeries extends ChartSeriesType = keyof import("@mui/x-charts/internals").ChartsSeriesConfig>(props: ChartDataProviderProProps<TSeries>) => {
-    children: import("react").ReactNode;
-    highlightedProviderProps: Omit<import("@mui/x-charts").HighlightedProviderProps, "children">;
-    animationProviderProps: Omit<import("@mui/x-charts/internals").AnimationProviderProps, "children">;
-    chartProviderProps: Omit<import("@mui/x-charts/internals").ChartProviderProps<TSeries, import("../internals/plugins/allPlugins").AllPluginSignatures<TSeries>>, "children">;
-};
+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">;
+};

package/ChartDataProviderPro/useChartDataProviderProProps.js

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

package/FunnelChart/FunnelChart.d.ts

@@ -0,0 +1,37 @@
+import * as React from 'react';
+import { ChartsOverlayProps } from '@mui/x-charts/ChartsOverlay';
+import { MakeOptional } from '@mui/x-internals/types';
+import { ChartsAxisHighlightProps } from '@mui/x-charts/ChartsAxisHighlight';
+import { FunnelPlotProps } from "./FunnelPlot.js";
+import { FunnelSeriesType } from "./funnel.types.js";
+import { ChartContainerProProps } from "../ChartContainerPro/index.js";
+import { FunnelChartSlotExtension } from "./funnelSlots.types.js";
+import { CategoryAxis } from "./categoryAxis.types.js";
+export interface FunnelChartProps extends Omit<ChartContainerProProps<'funnel'>, 'series' | 'plugins' | 'zAxis' | 'zoom' | 'onZoomChange' | 'dataset' | 'yAxis' | 'xAxis' | 'rotationAxis' | 'radiusAxis'>, Omit<FunnelPlotProps, 'slots' | 'slotProps'>, Omit<ChartsOverlayProps, 'slots' | 'slotProps'>, FunnelChartSlotExtension {
+  /**
+   * The series to display in the funnel chart.
+   * An array of [[FunnelSeriesType]] objects.
+   */
+  series: Readonly<MakeOptional<FunnelSeriesType, 'type'>[]>;
+  /**
+   * The configuration of the category axis.
+   *
+   * @default { position: 'none' }
+   */
+  categoryAxis?: CategoryAxis;
+  /**
+   * If `true`, the legend is not rendered.
+   * @default false
+   */
+  hideLegend?: boolean;
+  /**
+   * The configuration of axes highlight.
+   * Default is set to 'band' in the bar direction.
+   * Depends on `layout` prop.
+   * @see See {@link https://mui.com/x/react-charts/highlighting/ highlighting docs} for more details.
+   *
+   */
+  axisHighlight?: ChartsAxisHighlightProps;
+}
+declare const FunnelChart: React.ForwardRefExoticComponent<FunnelChartProps & React.RefAttributes<SVGSVGElement>>;
+export { FunnelChart };