@mui/x-charts-premium 9.2.0 → 9.4.0

package/models/seriesType/mapShape.d.ts

@@ -0,0 +1,105 @@
+import type { CommonSeriesType, CommonDefaultizedProps, SeriesId, DatasetElementType } from '@mui/x-charts/internals';
+import type { DefaultizedProps } from '@mui/x-internals/types';
+/**
+ * A single entry of a `mapShape` series.
+ *
+ * The `name` is used to join the entry to a feature in the chart's `geoData`
+ * (matching `feature.properties.name`).
+ */
+export interface MapShapeValueType {
+  /**
+   * Identifies the GeoJSON feature this entry maps to, via `feature.properties.name`.
+   */
+  name: string;
+  /**
+   * Numeric value associated with the feature.
+   */
+  value?: number;
+  /**
+   * The value used to compute the color of the item through a color axis.
+   * Falls back to `value` when no `colorValue` is provided.
+   */
+  colorValue?: any;
+  /**
+   * Label used in legends and tooltips.
+   */
+  label?: string;
+  /**
+   * Color used for the item. Fallback on the series color if not defined.
+   */
+  color?: string;
+}
+export interface MapShapeSeriesType extends Omit<CommonSeriesType<MapShapeValueType, 'mapShape'>, 'valueFormatter'> {
+  type: 'mapShape';
+  /**
+   * The data points to render. Each entry is joined to a feature in `geoData`
+   * through its `name` property.
+   */
+  data?: ReadonlyArray<MapShapeValueType>;
+  /**
+   * The label to display on the tooltip or the legend. It can be a string or a function.
+   */
+  label?: string | ((location: 'tooltip' | 'legend') => string);
+  /**
+   * The id of the color axis used to compute the color of the shapes.
+   * It points to the id of an axis defined with the `zAxis` prop.
+   */
+  colorAxisId?: string;
+  /**
+   * A function to extract and transform the value from the `dataset` item.
+   * It receives the full dataset item and should return a map shape value.
+   * Can be used as an alternative to `datasetKeys`.
+   * @param {DatasetElementType<unknown>} item The full dataset item.
+   * @returns {MapShapeValueType} The transformed value.
+   */
+  valueGetter?: (item: DatasetElementType<unknown>) => MapShapeValueType;
+  /**
+   * The keys used to retrieve data from the dataset.
+   *
+   * When this prop is provided, `name` is required to match each entry with a
+   * GeoJSON feature. `label`, `value`, and `colorValue` are optional.
+   */
+  datasetKeys?: {
+    /**
+     * The key used to retrieve the feature name from the dataset.
+     */
+    name: string;
+    /**
+     * The key used to retrieve the item label from the dataset.
+     */
+    label?: string;
+    /**
+     * The key used to retrieve the item numeric value from the dataset.
+     */
+    value?: string;
+    /**
+     * The key used to retrieve the color value from the dataset.
+     */
+    colorValue?: string;
+  };
+  /**
+   * Formatter used to render values in tooltips or other data displays.
+   * @param {MapShapeValueType} value The data entry to format.
+   * @param {object} context The rendering context.
+   * @param {number} context.dataIndex The index of the data point in the series.
+   * @returns {string | null} The string to display, or `null` if the value should not be shown.
+   */
+  valueFormatter?: (value: MapShapeValueType, context: {
+    dataIndex: number;
+  }) => string | null;
+}
+/**
+ * Identifies a single item in a `mapShape` series.
+ */
+export type MapShapeItemIdentifier = {
+  type: 'mapShape';
+  seriesId: SeriesId;
+  dataIndex: number;
+};
+export type DefaultizedMapShapeValueType = MapShapeValueType & {
+  hidden: boolean;
+};
+export interface DefaultizedMapShapeSeriesType extends Omit<DefaultizedProps<MapShapeSeriesType, CommonDefaultizedProps | 'color'>, 'data'> {
+  hidden: boolean;
+  data: ReadonlyArray<DefaultizedMapShapeValueType>;
+}

package/models/seriesType/mapShape.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/models/seriesType/mapShape.mjs

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

package/models/seriesType/radialBar.d.mts

@@ -1,7 +1,7 @@
 import type { CommonSeriesType, CommonBarSeriesType, RadialSeriesType, StackableSeriesType, SeriesId, CommonDefaultizedProps } from '@mui/x-charts/internals';
 import type { StackOffsetType } from '@mui/x-charts/models';
 import type { DefaultizedProps } from '@mui/x-internals/types';
-export interface RadialBarSeriesType extends CommonSeriesType<number | null, 'bar'>, RadialSeriesType, StackableSeriesType, CommonBarSeriesType {
+export interface RadialBarSeriesType extends CommonSeriesType<number | null, 'radialBar'>, RadialSeriesType, StackableSeriesType, CommonBarSeriesType {
   type: 'radialBar';
   /**
    * Defines how stacked series handle negative values.

package/models/seriesType/radialBar.d.ts

@@ -1,7 +1,7 @@
 import type { CommonSeriesType, CommonBarSeriesType, RadialSeriesType, StackableSeriesType, SeriesId, CommonDefaultizedProps } from '@mui/x-charts/internals';
 import type { StackOffsetType } from '@mui/x-charts/models';
 import type { DefaultizedProps } from '@mui/x-internals/types';
-export interface RadialBarSeriesType extends CommonSeriesType<number | null, 'bar'>, RadialSeriesType, StackableSeriesType, CommonBarSeriesType {
+export interface RadialBarSeriesType extends CommonSeriesType<number | null, 'radialBar'>, RadialSeriesType, StackableSeriesType, CommonBarSeriesType {
   type: 'radialBar';
   /**
    * Defines how stacked series handle negative values.

package/models/seriesType/radialLine.d.mts

@@ -14,6 +14,10 @@ export interface RadialLineSeriesType extends CommonSeriesType<number | null, 'l
    * @default 'linear'
    */
   curve?: CurveType;
+  /**
+   * If `true`, the line will be closed by connecting the last point to the first one.
+   */
+  closePath?: boolean;
 }
 /**
  * An object that allows to identify a single line.

package/models/seriesType/radialLine.d.ts

@@ -14,6 +14,10 @@ export interface RadialLineSeriesType extends CommonSeriesType<number | null, 'l
    * @default 'linear'
    */
   curve?: CurveType;
+  /**
+   * If `true`, the line will be closed by connecting the last point to the first one.
+   */
+  closePath?: boolean;
 }
 /**
  * An object that allows to identify a single line.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts-premium",
-  "version": "9.2.0",
+  "version": "9.4.0",
   "author": "MUI Team",
   "description": "The Premium plan edition of the MUI X Charts components.",
   "license": "SEE LICENSE IN LICENSE",
@@ -27,14 +27,14 @@
     "directory": "packages/x-charts-premium"
   },
   "dependencies": {
-    "@babel/runtime": "^7.29.2",
+    "@babel/runtime": "^7.29.7",
     "@mui/utils": "9.0.1",
     "clsx": "^2.1.1",
     "prop-types": "^15.8.1",
-    "@mui/x-charts": "^9.2.0",
-    "@mui/x-charts-pro": "^9.2.0",
-    "@mui/x-charts-vendor": "^9.0.0",
-    "@mui/x-license": "^9.2.0",
+    "@mui/x-charts": "^9.4.0",
+    "@mui/x-charts-pro": "^9.4.0",
+    "@mui/x-license": "^9.4.0",
+    "@mui/x-charts-vendor": "^9.4.0",
     "@mui/x-internals": "^9.1.0"
   },
   "peerDependencies": {
@@ -300,6 +300,20 @@
         "default": "./ChartsDataProviderPro/index.mjs"
       }
     },
+    "./ChartsGeoDataProviderPremium": {
+      "import": {
+        "types": "./ChartsGeoDataProviderPremium/index.d.mts",
+        "default": "./ChartsGeoDataProviderPremium/index.mjs"
+      },
+      "require": {
+        "types": "./ChartsGeoDataProviderPremium/index.d.ts",
+        "default": "./ChartsGeoDataProviderPremium/index.js"
+      },
+      "default": {
+        "types": "./ChartsGeoDataProviderPremium/index.d.mts",
+        "default": "./ChartsGeoDataProviderPremium/index.mjs"
+      }
+    },
     "./ChartsGrid": {
       "import": {
         "types": "./ChartsGrid/index.d.mts",
@@ -720,6 +734,20 @@
         "default": "./LineChartPro/index.mjs"
       }
     },
+    "./Map": {
+      "import": {
+        "types": "./Map/index.d.mts",
+        "default": "./Map/index.mjs"
+      },
+      "require": {
+        "types": "./Map/index.d.ts",
+        "default": "./Map/index.js"
+      },
+      "default": {
+        "types": "./Map/index.d.mts",
+        "default": "./Map/index.mjs"
+      }
+    },
     "./PieChart": {
       "import": {
         "types": "./PieChart/index.d.mts",

package/typeOverloads/modules.d.mts

@@ -1,6 +1,6 @@
 import type { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
 import type { CommonHighlightScope, SeriesColor, SeriesId, ComputedXAxis, ComputedYAxis, PolarAxisDefaultized, ChartsRadiusAxisProps, ChartsRotationAxisProps } from '@mui/x-charts/internals';
-import type { RangeBarValueType, RangeBarSeriesType, DefaultizedOHLCSeriesType, OHLCItemIdentifier, OHLCSeriesType, OHLCValueType, RadialLineSeriesType, DefaultizedRadialLineSeriesType, RadialLineItemIdentifier, RadialBarSeriesType, DefaultizedRadialBarSeriesType, RadialBarItemIdentifier } from "../models/index.mjs";
+import type { RangeBarValueType, RangeBarSeriesType, DefaultizedOHLCSeriesType, OHLCItemIdentifier, OHLCSeriesType, OHLCValueType, RadialLineSeriesType, DefaultizedRadialLineSeriesType, RadialLineItemIdentifier, RadialBarSeriesType, DefaultizedRadialBarSeriesType, RadialBarItemIdentifier, MapShapeSeriesType, DefaultizedMapShapeSeriesType, MapShapeItemIdentifier, MapShapeValueType } from "../models/index.mjs";
 import type { DefaultizedRangeBarSeriesType, RangeBarItemIdentifier } from "../models/seriesType/rangeBar.mjs";
 import type { BarSeries } from "../BarChart/index.mjs";
 declare module '@mui/x-charts/internals' {
@@ -75,6 +75,21 @@ declare module '@mui/x-charts/internals' {
         dataIndex?: number;
       };
     };
+    mapShape: {
+      seriesInput: DefaultizedProps<MapShapeSeriesType, 'id'> & MakeRequired<SeriesColor<MapShapeValueType>, 'color'>;
+      series: DefaultizedMapShapeSeriesType;
+      seriesLayout: {};
+      seriesProp: MapShapeSeriesType;
+      itemIdentifier: MapShapeItemIdentifier;
+      itemIdentifierWithData: MapShapeItemIdentifier;
+      valueType: MapShapeValueType;
+      highlightScope: CommonHighlightScope;
+      descriptionGetterParams: {
+        identifier: MapShapeItemIdentifier;
+        series: DefaultizedMapShapeSeriesType;
+      };
+      highlightIdentifier: MapShapeItemIdentifier;
+    };
     radialBar: {
       seriesInput: DefaultizedProps<RadialBarSeriesType, 'id'> & MakeRequired<SeriesColor<number | null>, 'color'>;
       series: DefaultizedRadialBarSeriesType;

package/typeOverloads/modules.d.ts

@@ -1,6 +1,6 @@
 import type { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
 import type { CommonHighlightScope, SeriesColor, SeriesId, ComputedXAxis, ComputedYAxis, PolarAxisDefaultized, ChartsRadiusAxisProps, ChartsRotationAxisProps } from '@mui/x-charts/internals';
-import type { RangeBarValueType, RangeBarSeriesType, DefaultizedOHLCSeriesType, OHLCItemIdentifier, OHLCSeriesType, OHLCValueType, RadialLineSeriesType, DefaultizedRadialLineSeriesType, RadialLineItemIdentifier, RadialBarSeriesType, DefaultizedRadialBarSeriesType, RadialBarItemIdentifier } from "../models/index.js";
+import type { RangeBarValueType, RangeBarSeriesType, DefaultizedOHLCSeriesType, OHLCItemIdentifier, OHLCSeriesType, OHLCValueType, RadialLineSeriesType, DefaultizedRadialLineSeriesType, RadialLineItemIdentifier, RadialBarSeriesType, DefaultizedRadialBarSeriesType, RadialBarItemIdentifier, MapShapeSeriesType, DefaultizedMapShapeSeriesType, MapShapeItemIdentifier, MapShapeValueType } from "../models/index.js";
 import type { DefaultizedRangeBarSeriesType, RangeBarItemIdentifier } from "../models/seriesType/rangeBar.js";
 import type { BarSeries } from "../BarChart/index.js";
 declare module '@mui/x-charts/internals' {
@@ -75,6 +75,21 @@ declare module '@mui/x-charts/internals' {
         dataIndex?: number;
       };
     };
+    mapShape: {
+      seriesInput: DefaultizedProps<MapShapeSeriesType, 'id'> & MakeRequired<SeriesColor<MapShapeValueType>, 'color'>;
+      series: DefaultizedMapShapeSeriesType;
+      seriesLayout: {};
+      seriesProp: MapShapeSeriesType;
+      itemIdentifier: MapShapeItemIdentifier;
+      itemIdentifierWithData: MapShapeItemIdentifier;
+      valueType: MapShapeValueType;
+      highlightScope: CommonHighlightScope;
+      descriptionGetterParams: {
+        identifier: MapShapeItemIdentifier;
+        series: DefaultizedMapShapeSeriesType;
+      };
+      highlightIdentifier: MapShapeItemIdentifier;
+    };
     radialBar: {
       seriesInput: DefaultizedProps<RadialBarSeriesType, 'id'> & MakeRequired<SeriesColor<number | null>, 'color'>;
       series: DefaultizedRadialBarSeriesType;

package/utils/webgl/useWebGLResizeObserver.js

@@ -1,12 +1,12 @@
 "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.useWebGLResizeObserver = useWebGLResizeObserver;
-var React = _interopRequireWildcard(require("react"));
+var _useEnhancedEffect = _interopRequireDefault(require("@mui/utils/useEnhancedEffect"));
 function getDevicePixelContentBoxSize(entry) {
   // Safari does not support devicePixelContentBoxSize
   if (entry.devicePixelContentBoxSize) {
@@ -30,7 +30,7 @@ function getDevicePixelContentBoxSize(entry) {
  * @param onResize Callback invoked after the canvas and viewport are updated.
  */
 function useWebGLResizeObserver(gl, onResize) {
-  React.useEffect(() => {
+  (0, _useEnhancedEffect.default)(() => {
     const canvas = gl?.canvas;
     if (!(canvas instanceof HTMLCanvasElement)) {
       return undefined;

package/utils/webgl/useWebGLResizeObserver.mjs

@@ -1,6 +1,6 @@
 'use client';
 
-import * as React from 'react';
+import useEnhancedEffect from '@mui/utils/useEnhancedEffect';
 function getDevicePixelContentBoxSize(entry) {
   // Safari does not support devicePixelContentBoxSize
   if (entry.devicePixelContentBoxSize) {
@@ -24,7 +24,7 @@ function getDevicePixelContentBoxSize(entry) {
  * @param onResize Callback invoked after the canvas and viewport are updated.
  */
 export function useWebGLResizeObserver(gl, onResize) {
-  React.useEffect(() => {
+  useEnhancedEffect(() => {
     const canvas = gl?.canvas;
     if (!(canvas instanceof HTMLCanvasElement)) {
       return undefined;