@mui/x-charts-premium 8.26.0 → 9.0.0-alpha.0

package/esm/ChartsContainerPremium/ChartsContainerPremium.js

@@ -0,0 +1,46 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { ChartsSurface } from '@mui/x-charts/ChartsSurface';
+import { ChartDataProviderPremium } from "../ChartDataProviderPremium/index.js";
+import { useChartsContainerPremiumProps } from "./useChartsContainerPremiumProps.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * It sets up the data providers as well as the `<svg>` for the chart.
+ *
+ * This is a combination of both the `ChartDataProviderPremium` and `ChartsSurface` components.
+ *
+ * Demos:
+ *
+ * - [Composition](https://mui.com/x/api/charts/composition/)
+ *
+ * API:
+ *
+ * - [ChartsContainerPremium API](https://mui.com/x/api/charts/charts-container-premium/)
+ *
+ * @example
+ * ```jsx
+ * <ChartsContainerPremium
+ *   series={[{ label: "Label", type: "bar", data: [10, 20] }]}
+ *   xAxis={[{ data: ["A", "B"], scaleType: "band", id: "x-axis" }]}
+ * >
+ *    <BarPlot />
+ *    <ChartsXAxis axisId="x-axis" />
+ * </ChartsContainerPremium>
+ * ```
+ */
+const ChartsContainerPremium = /*#__PURE__*/React.forwardRef(function ChartsContainerPremium(props, ref) {
+  const {
+    chartDataProviderPremiumProps,
+    children,
+    chartsSurfaceProps
+  } = useChartsContainerPremiumProps(props, ref);
+  return /*#__PURE__*/_jsx(ChartDataProviderPremium, _extends({}, chartDataProviderPremiumProps, {
+    children: /*#__PURE__*/_jsx(ChartsSurface, _extends({}, chartsSurfaceProps, {
+      children: children
+    }))
+  }));
+});
+if (process.env.NODE_ENV !== "production") ChartsContainerPremium.displayName = "ChartsContainerPremium";
+export { ChartsContainerPremium };

package/esm/ChartsContainerPremium/index.d.ts

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

package/esm/ChartsContainerPremium/index.js

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

package/esm/ChartsContainerPremium/useChartsContainerPremiumProps.d.ts

@@ -0,0 +1,9 @@
+import type * as React from 'react';
+import { type ChartAnyPluginSignature, type ChartSeriesType, type UseChartsContainerPropsReturnValue } from '@mui/x-charts/internals';
+import { type AllPluginSignatures } from "../internals/plugins/allPlugins.js";
+import type { ChartsContainerPremiumProps } from "./ChartsContainerPremium.js";
+import type { ChartDataProviderPremiumProps } from "../ChartDataProviderPremium/index.js";
+export type UseChartsContainerPremiumPropsReturnValue<TSeries extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = Pick<UseChartsContainerPropsReturnValue<TSeries, TSignatures>, 'chartsSurfaceProps' | 'children'> & {
+  chartDataProviderPremiumProps: ChartDataProviderPremiumProps<TSeries, TSignatures>;
+};
+export declare function useChartsContainerPremiumProps<TSeries extends ChartSeriesType = ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[] = AllPluginSignatures<TSeries>>(props: ChartsContainerPremiumProps<TSeries, TSignatures>, ref: React.Ref<SVGSVGElement>): UseChartsContainerPremiumPropsReturnValue<TSeries, TSignatures>;

package/esm/ChartsContainerPremium/useChartsContainerPremiumProps.js

@@ -0,0 +1,27 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["initialZoom", "zoomData", "onZoomChange", "zoomInteractionConfig", "plugins", "apiRef"];
+import { useChartsContainerProProps } from '@mui/x-charts-pro/internals';
+import { DEFAULT_PLUGINS } from "../internals/plugins/allPlugins.js";
+export function useChartsContainerPremiumProps(props, ref) {
+  const _ref = props,
+    {
+      plugins
+    } = _ref,
+    baseProps = _objectWithoutPropertiesLoose(_ref, _excluded);
+  const {
+    chartDataProviderProProps,
+    chartsSurfaceProps,
+    children
+  } = useChartsContainerProProps(baseProps, ref);
+  const chartDataProviderPremiumProps = _extends({}, chartDataProviderProProps, {
+    plugins: plugins ?? DEFAULT_PLUGINS
+  });
+  return {
+    chartDataProviderPremiumProps,
+    chartsSurfaceProps,
+    children
+  };
+}

package/esm/ChartsContainerPro/index.d.ts

@@ -0,0 +1 @@
+export * from '@mui/x-charts-pro/ChartsContainerPro';

package/esm/ChartsContainerPro/index.js

@@ -0,0 +1,2 @@
+// Re-export automatically generated, to customize, simply remove this line.
+export * from '@mui/x-charts-pro/ChartsContainerPro';

package/esm/HeatmapPremium/HeatmapPlotPremium.d.ts

@@ -0,0 +1,9 @@
+import { type HeatmapRendererPlotProps } from '@mui/x-charts-pro/internals';
+export interface HeatmapPlotPremiumProps extends HeatmapRendererPlotProps {
+  renderer: 'svg-single' | 'webgl';
+}
+export declare function HeatmapPlotPremium({
+  renderer,
+  borderRadius,
+  ...props
+}: HeatmapPlotPremiumProps): import("react/jsx-runtime").JSX.Element;

package/esm/HeatmapPremium/HeatmapPlotPremium.js

@@ -0,0 +1,23 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["renderer", "borderRadius"];
+import { HeatmapSVGPlot } from '@mui/x-charts-pro/internals';
+import { HeatmapWebGLRenderer } from "./webgl/HeatmapWebGLRenderer.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+export function HeatmapPlotPremium(_ref) {
+  let {
+      renderer,
+      borderRadius
+    } = _ref,
+    props = _objectWithoutPropertiesLoose(_ref, _excluded);
+  if (renderer === 'webgl') {
+    return /*#__PURE__*/_jsx(HeatmapWebGLRenderer, {
+      borderRadius: borderRadius
+    });
+  }
+  return /*#__PURE__*/_jsx(HeatmapSVGPlot, _extends({
+    borderRadius: borderRadius
+  }, props));
+}

package/esm/HeatmapPremium/HeatmapPremium.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { type HeatmapProps, type HeatmapSlots, type HeatmapSlotProps } from '@mui/x-charts-pro/Heatmap';
+export interface HeatmapPremiumSlots extends HeatmapSlots {}
+export interface HeatmapPremiumSlotProps extends HeatmapSlotProps {}
+export interface HeatmapPremiumProps extends HeatmapProps {
+  /**
+   * The type of renderer to use for the heatmap plot.
+   * - `svg-single`: Renders every scatter item in a `<rect />` element.
+   * - `webgl`: Renders heatmap cells using WebGL for better performance, at the cost of some limitations.
+   *                Read more: https://mui.com/x/react-charts/heatmap/#performance
+   */
+  renderer?: 'svg-single' | 'webgl';
+}
+declare const HeatmapPremium: React.ForwardRefExoticComponent<HeatmapPremiumProps & React.RefAttributes<SVGSVGElement>>;
+export { HeatmapPremium };

package/esm/HeatmapPremium/HeatmapPremium.js

@@ -0,0 +1,472 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { useThemeProps } from '@mui/material/styles';
+import { ChartsBrushOverlay } from '@mui/x-charts/ChartsBrushOverlay';
+import { ChartsWrapper } from '@mui/x-charts/ChartsWrapper';
+import { ChartsSurface } from '@mui/x-charts/ChartsSurface';
+import { FocusedHeatmapCell, HeatmapTooltip } from '@mui/x-charts-pro/Heatmap';
+import { ChartsLegend } from '@mui/x-charts/ChartsLegend';
+import { ChartsToolbarPro } from '@mui/x-charts-pro/ChartsToolbarPro';
+import { ChartsOverlay } from '@mui/x-charts/ChartsOverlay';
+import { ChartsAxis } from '@mui/x-charts/ChartsAxis';
+import { ChartsClipPath } from '@mui/x-charts/ChartsClipPath';
+import { useHeatmapPremiumProps } from "./useHeatmapPremiumProps.js";
+import { ChartDataProviderPremium } from "../ChartDataProviderPremium/index.js";
+import { HeatmapPlotPremium } from "./HeatmapPlotPremium.js";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const HeatmapPremium = /*#__PURE__*/React.forwardRef(function HeatmapPremium(inProps, ref) {
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiHeatmapPremium'
+  });
+  const {
+    sx,
+    slots,
+    slotProps,
+    loading,
+    hideLegend,
+    showToolbar = false
+  } = props;
+  const {
+    chartDataProviderPremiumProps,
+    chartsWrapperProps,
+    chartsAxisProps,
+    clipPathProps,
+    clipPathGroupProps,
+    legendProps,
+    heatmapPlotPremiumProps,
+    overlayProps,
+    children
+  } = useHeatmapPremiumProps(props);
+  const Tooltip = slots?.tooltip ?? HeatmapTooltip;
+  const Toolbar = slots?.toolbar ?? ChartsToolbarPro;
+  return /*#__PURE__*/_jsx(ChartDataProviderPremium, _extends({}, chartDataProviderPremiumProps, {
+    children: /*#__PURE__*/_jsxs(ChartsWrapper, _extends({}, chartsWrapperProps, {
+      children: [showToolbar ? /*#__PURE__*/_jsx(Toolbar, _extends({}, props.slotProps?.toolbar)) : null, !hideLegend && /*#__PURE__*/_jsx(ChartsLegend, _extends({}, legendProps)), /*#__PURE__*/_jsxs(ChartsSurface, {
+        ref: ref,
+        sx: sx,
+        children: [/*#__PURE__*/_jsxs("g", _extends({}, clipPathGroupProps, {
+          children: [/*#__PURE__*/_jsx(HeatmapPlotPremium, _extends({}, heatmapPlotPremiumProps)), /*#__PURE__*/_jsx(FocusedHeatmapCell, {}), /*#__PURE__*/_jsx(ChartsOverlay, _extends({}, overlayProps))]
+        })), /*#__PURE__*/_jsx(ChartsAxis, _extends({}, chartsAxisProps)), /*#__PURE__*/_jsx(ChartsClipPath, _extends({}, clipPathProps)), /*#__PURE__*/_jsx(ChartsBrushOverlay, {}), children]
+      }), !loading && /*#__PURE__*/_jsx(Tooltip, _extends({}, slotProps?.tooltip))]
+    }))
+  }));
+});
+if (process.env.NODE_ENV !== "production") HeatmapPremium.displayName = "HeatmapPremium";
+process.env.NODE_ENV !== "production" ? HeatmapPremium.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | 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({
+      exportAsImage: PropTypes.func.isRequired,
+      exportAsPrint: PropTypes.func.isRequired,
+      setAxisZoomData: PropTypes.func.isRequired,
+      setZoomData: PropTypes.func.isRequired
+    })
+  }),
+  /**
+   * The border radius of the heatmap cells in pixels.
+   */
+  borderRadius: PropTypes.number,
+  /**
+   * Configuration for the brush interaction.
+   */
+  brushConfig: PropTypes.shape({
+    enabled: PropTypes.bool,
+    preventHighlight: PropTypes.bool,
+    preventTooltip: PropTypes.bool
+  }),
+  className: PropTypes.string,
+  /**
+   * Color palette used to colorize multiple series.
+   * @default rainbowSurgePalette
+   */
+  colors: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.func]),
+  /**
+   * An array of objects that can be used to populate series and axes data using their `dataKey` property.
+   */
+  dataset: PropTypes.arrayOf(PropTypes.object),
+  desc: PropTypes.string,
+  /**
+   * If `true`, the charts will not listen to the mouse move event.
+   * It might break interactive features, but will improve performance.
+   * @default false
+   */
+  disableAxisListener: PropTypes.bool,
+  enableKeyboardNavigation: PropTypes.bool,
+  /**
+   * The height of the chart in px. If not defined, it takes the height of the parent element.
+   */
+  height: PropTypes.number,
+  /**
+   * If `true`, the legend is not rendered.
+   */
+  hideLegend: PropTypes.bool,
+  /**
+   * The highlighted item.
+   * Used when the highlight is controlled.
+   */
+  highlightedItem: PropTypes.shape({
+    dataIndex: PropTypes.number,
+    seriesId: PropTypes.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.string,
+  /**
+   * The list of zoom data related to each axis.
+   * Used to initialize the zoom in a specific configuration without controlling it.
+   */
+  initialZoom: PropTypes.arrayOf(PropTypes.shape({
+    axisId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired,
+    end: PropTypes.number.isRequired,
+    start: PropTypes.number.isRequired
+  })),
+  /**
+   * If `true`, a loading overlay is displayed.
+   * @default false
+   */
+  loading: PropTypes.bool,
+  /**
+   * Localized text for chart components.
+   */
+  localeText: PropTypes.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.oneOfType([PropTypes.number, PropTypes.shape({
+    bottom: PropTypes.number,
+    left: PropTypes.number,
+    right: PropTypes.number,
+    top: PropTypes.number
+  })]),
+  /**
+   * The function called for onClick events.
+   * The second argument contains information about all line/bar elements at the current mouse position.
+   * @param {MouseEvent} event The mouse event recorded on the `<svg/>` element.
+   * @param {null | ChartsAxisData} data The data about the clicked axis and items associated with it.
+   *
+   * @deprecated Use `onItemClick` instead to get access to both x- and y-axis values.
+   */
+  onAxisClick: PropTypes.func,
+  /**
+   * The callback fired when the highlighted item changes.
+   *
+   * @param {HighlightItemData | null} highlightedItem  The newly highlighted item.
+   */
+  onHighlightChange: PropTypes.func,
+  /**
+   * The callback fired when an item is clicked.
+   *
+   * @param {React.MouseEvent<SVGSVGElement, MouseEvent>} event The click event.
+   * @param {SeriesItemIdentifier<SeriesType>} item The clicked item.
+   */
+  onItemClick: PropTypes.func,
+  /**
+   * The callback fired when the tooltip item changes.
+   *
+   * @param {SeriesItemIdentifier<TSeries> | null} tooltipItem  The newly highlighted item.
+   */
+  onTooltipItemChange: PropTypes.func,
+  /**
+   * Callback fired when the zoom has changed.
+   *
+   * @param {ZoomData[]} zoomData Updated zoom data.
+   */
+  onZoomChange: PropTypes.func,
+  /**
+   * The type of renderer to use for the heatmap plot.
+   * - `svg-single`: Renders every scatter item in a `<rect />` element.
+   * - `webgl`: Renders heatmap cells using WebGL for better performance, at the cost of some limitations.
+   *                Read more: https://mui.com/x/react-charts/heatmap/#performance
+   */
+  renderer: PropTypes.oneOf(['svg-single', 'webgl']),
+  /**
+   * The series to display in the bar chart.
+   * An array of [[HeatmapSeries]] objects.
+   */
+  series: PropTypes.arrayOf(PropTypes.object).isRequired,
+  /**
+   * If true, shows the default chart toolbar.
+   * @default false
+   */
+  showToolbar: PropTypes.bool,
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps: PropTypes.object,
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots: PropTypes.object,
+  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
+  theme: PropTypes.oneOf(['dark', 'light']),
+  title: PropTypes.string,
+  /**
+   * The configuration of the tooltip.
+   * @see See {@link https://mui.com/x/react-charts/tooltip/ tooltip docs} for more details.
+   */
+  tooltip: PropTypes.object,
+  /**
+   * The tooltip item.
+   * Used when the tooltip is controlled.
+   */
+  tooltipItem: PropTypes.shape({
+    dataIndex: PropTypes.number,
+    seriesId: PropTypes.string.isRequired,
+    type: PropTypes.oneOf(['heatmap']).isRequired,
+    xIndex: PropTypes.number.isRequired,
+    yIndex: PropTypes.number.isRequired
+  }),
+  /**
+   * 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({
+    axis: PropTypes.oneOf(['x']),
+    barGapRatio: PropTypes.number,
+    categoryGapRatio: PropTypes.number,
+    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]),
+    groups: PropTypes.arrayOf(PropTypes.shape({
+      getValue: PropTypes.func.isRequired,
+      tickLabelStyle: PropTypes.object,
+      tickSize: PropTypes.number
+    })),
+    height: PropTypes.number,
+    hideTooltip: PropTypes.bool,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    ignoreTooltip: PropTypes.bool,
+    label: PropTypes.string,
+    labelStyle: PropTypes.object,
+    offset: PropTypes.number,
+    ordinalTimeTicks: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf(['biweekly', 'days', 'hours', 'months', 'quarterly', 'weeks', 'years']), PropTypes.shape({
+      format: PropTypes.func.isRequired,
+      getTickNumber: PropTypes.func.isRequired,
+      isTick: PropTypes.func.isRequired
+    })]).isRequired),
+    position: PropTypes.oneOf(['bottom', 'none', 'top']),
+    reverse: PropTypes.bool,
+    scaleType: PropTypes.oneOf(['band']),
+    slotProps: PropTypes.object,
+    slots: PropTypes.object,
+    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]),
+    tickLabelMinGap: PropTypes.number,
+    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,
+    tickSpacing: 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,
+      slider: PropTypes.shape({
+        enabled: PropTypes.bool,
+        preview: PropTypes.bool,
+        showTooltip: PropTypes.oneOf(['always', 'hover', 'never']),
+        size: PropTypes.number
+      }),
+      step: PropTypes.number
+    }), PropTypes.bool])
+  })).isRequired,
+  /**
+   * 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({
+    axis: PropTypes.oneOf(['y']),
+    barGapRatio: PropTypes.number,
+    categoryGapRatio: PropTypes.number,
+    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]),
+    groups: PropTypes.arrayOf(PropTypes.shape({
+      getValue: PropTypes.func.isRequired,
+      tickLabelStyle: PropTypes.object,
+      tickSize: PropTypes.number
+    })),
+    hideTooltip: PropTypes.bool,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    ignoreTooltip: PropTypes.bool,
+    label: PropTypes.string,
+    labelStyle: PropTypes.object,
+    offset: PropTypes.number,
+    ordinalTimeTicks: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf(['biweekly', 'days', 'hours', 'months', 'quarterly', 'weeks', 'years']), PropTypes.shape({
+      format: PropTypes.func.isRequired,
+      getTickNumber: PropTypes.func.isRequired,
+      isTick: PropTypes.func.isRequired
+    })]).isRequired),
+    position: PropTypes.oneOf(['left', 'none', 'right']),
+    reverse: PropTypes.bool,
+    scaleType: PropTypes.oneOf(['band']),
+    slotProps: PropTypes.object,
+    slots: PropTypes.object,
+    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,
+    tickSpacing: PropTypes.number,
+    valueFormatter: PropTypes.func,
+    width: PropTypes.number,
+    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,
+      slider: PropTypes.shape({
+        enabled: PropTypes.bool,
+        preview: PropTypes.bool,
+        showTooltip: PropTypes.oneOf(['always', 'hover', 'never']),
+        size: PropTypes.number
+      }),
+      step: PropTypes.number
+    }), PropTypes.bool])
+  })).isRequired,
+  /**
+   * 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
+  })),
+  /**
+   * The list of zoom data related to each axis.
+   */
+  zoomData: PropTypes.arrayOf(PropTypes.shape({
+    axisId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired,
+    end: PropTypes.number.isRequired,
+    start: PropTypes.number.isRequired
+  })),
+  /**
+   * Configuration for zoom interactions.
+   */
+  zoomInteractionConfig: PropTypes.shape({
+    pan: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf(['drag', 'pressAndDrag', 'wheel']), PropTypes.shape({
+      pointerMode: PropTypes.oneOf(['mouse', 'touch']),
+      requiredKeys: PropTypes.arrayOf(PropTypes.string),
+      type: PropTypes.oneOf(['drag']).isRequired
+    }), PropTypes.shape({
+      pointerMode: PropTypes.oneOf(['mouse', 'touch']),
+      requiredKeys: PropTypes.arrayOf(PropTypes.string),
+      type: PropTypes.oneOf(['pressAndDrag']).isRequired
+    }), PropTypes.shape({
+      allowedDirection: PropTypes.oneOf(['x', 'xy', 'y']),
+      pointerMode: PropTypes.any,
+      requiredKeys: PropTypes.arrayOf(PropTypes.string),
+      type: PropTypes.oneOf(['wheel']).isRequired
+    })]).isRequired),
+    zoom: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf(['brush', 'doubleTapReset', 'pinch', 'tapAndDrag', 'wheel']), PropTypes.shape({
+      pointerMode: PropTypes.any,
+      requiredKeys: PropTypes.arrayOf(PropTypes.string),
+      type: PropTypes.oneOf(['wheel']).isRequired
+    }), PropTypes.shape({
+      pointerMode: PropTypes.any,
+      requiredKeys: PropTypes.array,
+      type: PropTypes.oneOf(['pinch']).isRequired
+    }), PropTypes.shape({
+      pointerMode: PropTypes.oneOf(['mouse', 'touch']),
+      requiredKeys: PropTypes.arrayOf(PropTypes.string),
+      type: PropTypes.oneOf(['tapAndDrag']).isRequired
+    }), PropTypes.shape({
+      pointerMode: PropTypes.oneOf(['mouse', 'touch']),
+      requiredKeys: PropTypes.arrayOf(PropTypes.string),
+      type: PropTypes.oneOf(['doubleTapReset']).isRequired
+    }), PropTypes.shape({
+      pointerMode: PropTypes.any,
+      requiredKeys: PropTypes.array,
+      type: PropTypes.oneOf(['brush']).isRequired
+    })]).isRequired)
+  })
+} : void 0;
+export { HeatmapPremium };

package/esm/HeatmapPremium/HeatmapPremium.plugins.d.ts

@@ -0,0 +1,4 @@
+import { type UseChartZAxisSignature, type UseChartCartesianAxisSignature, type UseChartTooltipSignature, type UseChartInteractionSignature, type UseChartHighlightSignature, type ConvertSignaturesIntoPlugins, type UseChartBrushSignature, type UseChartKeyboardNavigationSignature, type UseChartItemClickSignature } from '@mui/x-charts/internals';
+import { type UseChartProExportSignature, type UseChartProZoomSignature } from '@mui/x-charts-pro/plugins';
+export type HeatmapPremiumPluginSignatures = [UseChartZAxisSignature, UseChartTooltipSignature<'heatmap'>, UseChartInteractionSignature, UseChartCartesianAxisSignature<'heatmap'>, UseChartHighlightSignature, UseChartProExportSignature, UseChartBrushSignature, UseChartProZoomSignature, UseChartItemClickSignature<'heatmap'>, UseChartKeyboardNavigationSignature];
+export declare const HEATMAP_PREMIUM_PLUGINS: ConvertSignaturesIntoPlugins<HeatmapPremiumPluginSignatures>;

package/esm/HeatmapPremium/HeatmapPremium.plugins.js

@@ -0,0 +1,3 @@
+import { useChartZAxis, useChartCartesianAxis, useChartTooltip, useChartInteraction, useChartHighlight, useChartBrush, useChartKeyboardNavigation, useChartItemClick } from '@mui/x-charts/internals';
+import { useChartProExport, useChartProZoom } from '@mui/x-charts-pro/plugins';
+export const HEATMAP_PREMIUM_PLUGINS = [useChartZAxis, useChartTooltip, useChartInteraction, useChartCartesianAxis, useChartHighlight, useChartProExport, useChartBrush, useChartProZoom, useChartItemClick, useChartKeyboardNavigation];

package/esm/HeatmapPremium/index.d.ts

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

package/esm/HeatmapPremium/index.js

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

package/esm/HeatmapPremium/useHeatmapPremiumProps.d.ts

@@ -0,0 +1,16 @@
+import { type HeatmapPremiumProps } from "./HeatmapPremium.js";
+import { type HeatmapPlotPremiumProps } from "./HeatmapPlotPremium.js";
+export type UseHeatmapPremiumProps = HeatmapPremiumProps;
+export declare function useHeatmapPremiumProps(props: UseHeatmapPremiumProps): {
+  heatmapPlotPremiumProps: HeatmapPlotPremiumProps;
+  chartDataProviderPremiumProps: import("@mui/x-charts-pro/ChartDataProviderPro").ChartDataProviderProProps<"heatmap", import("@mui/x-charts-pro/Heatmap").HeatmapPluginSignatures>;
+  chartsWrapperProps: Omit<import("@mui/x-charts").ChartsWrapperProps, "children">;
+  clipPathProps: import("@mui/x-charts").ChartsClipPathProps;
+  clipPathGroupProps: {
+    clipPath: string;
+  };
+  overlayProps: import("@mui/x-charts/ChartsOverlay").ChartsOverlayProps;
+  chartsAxisProps: import("@mui/x-charts").ChartsAxisProps;
+  legendProps: import("@mui/x-charts").ChartsLegendProps | import("@mui/x-charts").ChartsLegendSlotExtension;
+  children: React.ReactNode;
+};