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

package/internals/plugins/featurePlugins/useChartPolarAxis/useChartPolarInteraction.selectors.js

@@ -3,26 +3,90 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.selectorChartsInteractionRotationAxisValue = exports.selectorChartsInteractionRotationAxisIndex = void 0;
+exports.selectorChartsInteractionTooltipRotationAxes = exports.selectorChartsInteractionTooltipRadiusAxes = exports.selectorChartsInteractionRotationAxisValues = exports.selectorChartsInteractionRotationAxisValue = exports.selectorChartsInteractionRotationAxisIndexes = exports.selectorChartsInteractionRotationAxisIndex = exports.selectorChartsInteractionPolarAxisTooltip = void 0;
+var _isDeepEqual = require("@mui/x-internals/isDeepEqual");
 var _selectors = require("../../utils/selectors");
 var _useChartInteraction = require("../useChartInteraction/useChartInteraction.selectors");
 var _coordinateTransformation = require("./coordinateTransformation");
-var _getAxisValue = require("./getAxisValue");
+var _getAxisIndex = require("./getAxisIndex");
 var _useChartPolarAxis = require("./useChartPolarAxis.selectors");
-const selectorChartsInteractionRotationAxisIndex = exports.selectorChartsInteractionRotationAxisIndex = (0, _selectors.createSelector)([_useChartInteraction.selectorChartsInteractionPointerX, _useChartInteraction.selectorChartsInteractionPointerY, _useChartPolarAxis.selectorChartPolarCenter, _useChartPolarAxis.selectorChartRotationAxis], (x, y, center, rotationAxis) => {
-  if (x === null || y === null || !rotationAxis.axis[rotationAxis.axisIds[0]]) {
+const optionalGetAxisId = (_, id) => id;
+const optionalGetAxisIds = (_, ids) => ids;
+
+/**
+ * Get interaction indexes
+ */
+
+function indexGetter(value, axes, ids) {
+  return Array.isArray(ids) ? ids.map(id => (0, _getAxisIndex.getAxisIndex)(axes.axis[id], value)) : (0, _getAxisIndex.getAxisIndex)(axes.axis[ids], value);
+}
+
+/**
+ * Helper to get the rotation associated to the interaction coordinate.
+ */
+const selectorChartsInteractionRotationAngle = (0, _selectors.createSelector)([_useChartInteraction.selectorChartsInteractionPointerX, _useChartInteraction.selectorChartsInteractionPointerY, _useChartPolarAxis.selectorChartPolarCenter], (x, y, center) => {
+  if (x === null || y === null) {
     return null;
   }
-  const rotation = (0, _coordinateTransformation.generateSvg2rotation)(center)(x, y);
-  return (0, _getAxisValue.getAxisIndex)(rotationAxis.axis[rotationAxis.axisIds[0]], rotation);
+  return (0, _coordinateTransformation.generateSvg2rotation)(center)(x, y);
 });
-const selectorChartsInteractionRotationAxisValue = exports.selectorChartsInteractionRotationAxisValue = (0, _selectors.createSelector)([_useChartInteraction.selectorChartsInteractionPointerX, _useChartInteraction.selectorChartsInteractionPointerY, _useChartPolarAxis.selectorChartRotationAxis, selectorChartsInteractionRotationAxisIndex], (x, y, rotationAxis, rotationIndex) => {
-  if (x === null || y === null || rotationIndex === null || rotationIndex === -1) {
+const selectorChartsInteractionRotationAxisIndex = exports.selectorChartsInteractionRotationAxisIndex = (0, _selectors.createSelector)([selectorChartsInteractionRotationAngle, _useChartPolarAxis.selectorChartRotationAxis, optionalGetAxisId], (rotation, rotationAxis, id = rotationAxis.axisIds[0]) => rotation === null ? null : indexGetter(rotation, rotationAxis, id));
+const selectorChartsInteractionRotationAxisIndexes = exports.selectorChartsInteractionRotationAxisIndexes = (0, _selectors.createSelector)([selectorChartsInteractionRotationAngle, _useChartPolarAxis.selectorChartRotationAxis, optionalGetAxisIds], (rotation, rotationAxis, ids = rotationAxis.axisIds) => rotation === null ? null : indexGetter(rotation, rotationAxis, ids));
+const selectorChartsInteractionRotationAxisValue = exports.selectorChartsInteractionRotationAxisValue = (0, _selectors.createSelector)([_useChartPolarAxis.selectorChartRotationAxis, selectorChartsInteractionRotationAxisIndex, optionalGetAxisId], (rotationAxis, rotationIndex, id = rotationAxis.axisIds[0]) => {
+  if (rotationIndex === null || rotationIndex === -1 || rotationAxis.axisIds.length === 0) {
     return null;
   }
-  const data = rotationAxis.axis[rotationAxis.axisIds[0]]?.data;
+  const data = rotationAxis.axis[id]?.data;
   if (!data) {
     return null;
   }
   return data[rotationIndex];
-});
+});
+const selectorChartsInteractionRotationAxisValues = exports.selectorChartsInteractionRotationAxisValues = (0, _selectors.createSelector)([_useChartPolarAxis.selectorChartRotationAxis, selectorChartsInteractionRotationAxisIndexes, optionalGetAxisIds], (rotationAxis, rotationIndexes, ids = rotationAxis.axisIds) => {
+  if (rotationIndexes === null) {
+    return null;
+  }
+  return ids.map((id, axisIndex) => {
+    const rotationIndex = rotationIndexes[axisIndex];
+    if (rotationIndex === -1) {
+      return null;
+    }
+    return rotationAxis.axis[id].data?.[rotationIndex];
+  });
+});
+
+/**
+ * Get rotation-axis ids and corresponding data index that should be display in the tooltip.
+ */
+const selectorChartsInteractionTooltipRotationAxes = exports.selectorChartsInteractionTooltipRotationAxes = (0, _selectors.createSelector)([selectorChartsInteractionRotationAxisIndexes, _useChartPolarAxis.selectorChartRotationAxis], (indexes, axes) => {
+  if (indexes === null) {
+    return [];
+  }
+  return axes.axisIds.map((axisId, axisIndex) => ({
+    axisId,
+    dataIndex: indexes[axisIndex]
+  })).filter(({
+    axisId,
+    dataIndex
+  }) => axes.axis[axisId].triggerTooltip && dataIndex >= 0);
+}, {
+  memoizeOptions: {
+    // Keep the same reference if array content is the same.
+    // If possible, avoid this pattern by creating selectors that
+    // uses string/number as arguments.
+    resultEqualityCheck: _isDeepEqual.isDeepEqual
+  }
+});
+
+/**
+ * Get radius-axis ids and corresponding data index that should be displayed in the tooltip.
+ */
+const selectorChartsInteractionTooltipRadiusAxes = exports.selectorChartsInteractionTooltipRadiusAxes = (0, _selectors.createSelector)([], () => {
+  // TODO implement this selector and add it to the `selectorChartsInteractionPolarAxisTooltip`
+  return [];
+});
+
+/**
+ * Return `true` if the axis tooltip has something to display.
+ */
+const selectorChartsInteractionPolarAxisTooltip = exports.selectorChartsInteractionPolarAxisTooltip = (0, _selectors.createSelector)([selectorChartsInteractionTooltipRotationAxes], rotationTooltip => rotationTooltip.length > 0);

package/internals/plugins/featurePlugins/useChartVoronoi/useChartVoronoi.selectors.d.ts

@@ -1,6 +1,6 @@
 import { ChartRootSelector } from "../../utils/selectors.js";
 import { UseChartVoronoiSignature } from "./useChartVoronoi.types.js";
-export declare const selectorChartsVoronoiIsVoronoiEnabled: ((state: import("../../corePlugins/useChartId/useChartId.types").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types").UseChartSeriesState<keyof import("../../..").ChartsSeriesConfig> & import("./useChartVoronoi.types").UseChartVoronoiState & Partial<{}> & {
+export declare const selectorChartsVoronoiIsVoronoiEnabled: ((state: import("../../corePlugins/useChartId/useChartId.types").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types").UseChartSeriesState<keyof import("../../..").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types").UseChartAnimationState & import("./useChartVoronoi.types").UseChartVoronoiState & Partial<{}> & {
   cacheKey: import("../../models").ChartStateCacheKey;
 }) => boolean | undefined) & {
   clearCache: () => void;

package/internals/plugins/featurePlugins/useChartZAxis/useChartZAxis.selectors.d.ts

@@ -1,6 +1,6 @@
 import { ChartState } from "../../models/chart.js";
 import { UseChartZAxisSignature } from "./useChartZAxis.types.js";
-export declare const selectorChartZAxis: ((state: import("../../corePlugins/useChartId/useChartId.types").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types").UseChartSeriesState<keyof import("../../..").ChartsSeriesConfig> & import("./useChartZAxis.types").UseChartZAxisState & Partial<{}> & {
+export declare const selectorChartZAxis: ((state: import("../../corePlugins/useChartId/useChartId.types").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types").UseChartSeriesState<keyof import("../../..").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types").UseChartAnimationState & import("./useChartZAxis.types").UseChartZAxisState & Partial<{}> & {
   cacheKey: import("../../models").ChartStateCacheKey;
 }) => {
   axis: {

package/internals/plugins/featurePlugins/useChartZAxis/useChartZAxis.types.d.ts

@@ -29,7 +29,6 @@ export interface UseChartZAxisState {
     axisIds: AxisId[];
   };
 }
-export interface UseChartZAxisInstance {}
 export type UseChartZAxisSignature = ChartPluginSignature<{
   params: UseChartZAxisParameters;
   defaultizedParams: UseChartZAxisDefaultizedParameters;

package/internals/plugins/models/plugin.d.ts

@@ -25,6 +25,10 @@ export interface ChartPluginOptions<TSignature extends ChartAnyPluginSignature>
    * Reference to the main svg element.
    */
   svgRef: React.RefObject<SVGSVGElement | null>;
+  /**
+   * Reference to the chart root element.
+   */
+  chartRootRef: React.RefObject<HTMLDivElement | null>;
   /**
    * All the plugins that are used in the chart.
    */

package/internals/plugins/models/seriesConfig/colorProcessor.types.d.ts

@@ -2,4 +2,13 @@ import type { AxisDefaultized } from '../../../../models/axis';
 import type { DefaultizedSeriesType } from '../../../../models/seriesType';
 import type { ZAxisDefaultized } from '../../../../models/z-axis';
 import type { ChartSeriesType } from '../../../../models/seriesType/config';
-export type ColorProcessor<TSeriesType extends ChartSeriesType> = (series: DefaultizedSeriesType<TSeriesType>, xAxis?: AxisDefaultized, yAxis?: AxisDefaultized, zAxis?: ZAxisDefaultized) => (dataIndex: number) => string;
+/**
+ * Map data index to a color.
+ * If dataIndex is not defined, it falls back to the series color when defined.
+ */
+export type ColorGetter<TSeriesType extends ChartSeriesType> = TSeriesType extends 'pie' | 'funnel' | 'heatmap' ? (dataIndex: number) => string : (dataIndex?: number) => string;
+/**
+ * Transforms charts config to a color getter.
+ * If dataIndex is not defined, it falls back to the series color.
+ */
+export type ColorProcessor<TSeriesType extends ChartSeriesType> = (series: DefaultizedSeriesType<TSeriesType>, xAxis?: AxisDefaultized, yAxis?: AxisDefaultized, zAxis?: ZAxisDefaultized) => ColorGetter<TSeriesType>;

package/internals/plugins/models/seriesConfig/polarExtremumGetter.types.d.ts

@@ -9,8 +9,4 @@ type PolarExtremumGetterParams<TSeriesType extends PolarChartSeriesType> = {
 };
 export type PolarExtremumGetterResult = [number, number];
 export type PolarExtremumGetter<TSeriesType extends PolarChartSeriesType> = (params: PolarExtremumGetterParams<TSeriesType>) => PolarExtremumGetterResult;
-export type PolarExtremumFilter = (value: {
-  x: number | Date | string | null;
-  y: number | Date | string | null;
-}, dataIndex: number) => boolean;
 export {};

package/internals/plugins/models/seriesConfig/tooltipGetter.types.d.ts

@@ -1,12 +1,71 @@
-import type { ItemTooltip } from '../../../../ChartsTooltip';
-import type { ChartItemIdentifier, ChartSeriesDefaultized, ChartSeriesType } from '../../../../models/seriesType/config';
+import type { ChartItemIdentifier, ChartSeriesDefaultized, ChartSeriesType, ChartsSeriesConfig } from '../../../../models/seriesType/config';
 import { SeriesId } from "../../../../models/seriesType/common.js";
-import { AxisId } from "../../../../models/axis.js";
+import { AxisDefaultized, AxisId, ChartsXAxisProps, ChartsYAxisProps, ChartsRotationAxisProps, ChartsRadiusAxisProps, PolarAxisDefaultized } from "../../../../models/axis.js";
+import { ChartsLabelMarkProps } from "../../../../ChartsLabel/ChartsLabelMark.js";
+import { ColorGetter } from "./colorProcessor.types.js";
+export interface ItemTooltip<T extends ChartSeriesType> {
+  /**
+   * An object that identifies the item to display.
+   */
+  identifier: ChartItemIdentifier<T>;
+  /**
+   * The color associated with the item.
+   */
+  color: string;
+  /**
+   * The item label.
+   */
+  label: string | undefined;
+  /**
+   * The item value.
+   */
+  value: ChartsSeriesConfig[T]['valueType'];
+  /**
+   * The value formatted with context set to "tooltip".
+   */
+  formattedValue: string | null;
+  /**
+   * The series mark type.
+   */
+  markType: ChartsLabelMarkProps['type'];
+}
+export type ItemTooltipWithMultipleValues<T extends 'radar' = 'radar'> = Pick<ItemTooltip<T>, 'identifier' | 'color' | 'label' | 'markType'> & {
+  values: {
+    /**
+     * The metric label.
+     */
+    label: string | undefined;
+    /**
+     * The value.
+     */
+    value: ChartsSeriesConfig[T]['valueType'];
+    /**
+     * The value formatted with context set to "tooltip".
+     */
+    formattedValue: string | null;
+    /**
+     * The series mark type.
+     */
+    markType: ChartsLabelMarkProps['type'];
+  }[];
+};
+export interface TooltipGetterAxesConfig {
+  x?: AxisDefaultized<any, any, ChartsXAxisProps>;
+  y?: AxisDefaultized<any, any, ChartsYAxisProps>;
+  rotation?: PolarAxisDefaultized<any, any, ChartsRotationAxisProps>;
+  radius?: PolarAxisDefaultized<any, any, ChartsRadiusAxisProps>;
+}
 export type TooltipGetter<TSeriesType extends ChartSeriesType> = (params: {
   series: ChartSeriesDefaultized<TSeriesType>;
-  getColor: (dataIndex: number) => string;
+  axesConfig: TooltipGetterAxesConfig;
+  getColor: ColorGetter<TSeriesType>;
   identifier: ChartItemIdentifier<TSeriesType> | null;
-}) => ItemTooltip<TSeriesType> | null;
+}) => (TSeriesType extends 'radar' ? ItemTooltipWithMultipleValues<TSeriesType> : ItemTooltip<TSeriesType>) | null;
+/**
+ * Return an array of the axes that should trigger the tooltip.
+ *
+ * If `axisId` is set to undefined, the default axis will be used.
+ */
 export type AxisTooltipGetter<TSeriesType extends ChartSeriesType, Directions extends 'x' | 'y' | 'rotation' | 'radius' = 'x' | 'y'> = (series: Record<SeriesId, ChartSeriesDefaultized<TSeriesType>>) => {
   direction: Directions;
   axisId: AxisId | undefined;

package/internals/store/useCharts.d.ts

@@ -16,10 +16,11 @@ import { ChartSeriesConfig } from "../plugins/models/seriesConfig/index.js";
  */
 export declare function useCharts<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]>(inPlugins: ConvertSignaturesIntoPlugins<TSignatures>, props: Partial<UseChartBaseProps<TSignatures>>, seriesConfig: ChartSeriesConfig<TSeriesType>): {
   contextValue: {
-    store: ChartStore<readonly [import("..").UseChartIdSignature, import("..").UseChartDimensionsSignature, import("..").UseChartSeriesSignature, ...TSignatures]> & UseChartInteractionState;
+    store: ChartStore<readonly [import("..").UseChartIdSignature, import("..").UseChartDimensionsSignature, import("..").UseChartSeriesSignature, import("../plugins/corePlugins/useChartAnimation").UseChartAnimationSignature, ...TSignatures]> & UseChartInteractionState;
     publicAPI: ChartPublicAPI<TSignatures>;
     instance: ChartInstance<TSignatures>;
     svgRef: React.RefObject<SVGSVGElement | null>;
+    chartRootRef: React.RefObject<HTMLDivElement | null>;
   };
 };
 export declare function useChartApiInitialization<T>(inputApiRef: React.RefObject<T | undefined> | undefined): T;

package/internals/store/useCharts.js

@@ -36,6 +36,7 @@ function useCharts(inPlugins, props, seriesConfig) {
   const instanceRef = React.useRef({});
   const instance = instanceRef.current;
   const publicAPI = useChartApiInitialization(props.apiRef);
+  const innerChartRootRef = React.useRef(null);
   const innerSvgRef = React.useRef(null);
   const storeRef = React.useRef(null);
   if (storeRef.current == null) {
@@ -60,6 +61,7 @@ function useCharts(inPlugins, props, seriesConfig) {
       plugins: plugins,
       store: storeRef.current,
       svgRef: innerSvgRef,
+      chartRootRef: innerChartRootRef,
       seriesConfig,
       models
     });
@@ -75,7 +77,8 @@ function useCharts(inPlugins, props, seriesConfig) {
     store: storeRef.current,
     publicAPI,
     instance,
-    svgRef: innerSvgRef
+    svgRef: innerSvgRef,
+    chartRootRef: innerChartRootRef
   }), [instance, publicAPI]);
   return {
     contextValue

package/internals/store/useSelector.js

@@ -4,11 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useSelector = void 0;
-var _withSelector = require("use-sync-external-store/with-selector.js");
-// use-sync-external-store has no exports field defined
-// See https://github.com/facebook/react/issues/30698
-// eslint-disable-next-line import/extensions
-
+var _withSelector = require("use-sync-external-store/with-selector");
 const defaultCompare = Object.is;
 const useSelector = (store, selector, args = undefined, equals = defaultCompare) => {
   const selectorWithArgs = state => selector(state, args);

package/locales/enUS.d.ts

@@ -0,0 +1,15 @@
+import { ChartsLocaleText } from "./utils/chartsLocaleTextApi.js";
+export declare const enUSLocaleText: ChartsLocaleText;
+export declare const DEFAULT_LOCALE: ChartsLocaleText;
+export declare const enUS: {
+  components: {
+    MuiChartsLocalizationProvider: {
+      defaultProps: {
+        localeText: {
+          loading?: string | undefined;
+          noData?: string | undefined;
+        };
+      };
+    };
+  };
+};

package/locales/enUS.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.enUSLocaleText = exports.enUS = exports.DEFAULT_LOCALE = void 0;
+var _getChartsLocalization = require("./utils/getChartsLocalization");
+// This object is not Partial<ChartsLocaleText> because it is the default values
+
+const enUSLocaleText = exports.enUSLocaleText = {
+  // Overlay
+  loading: 'Loading data…',
+  noData: 'No data to display'
+};
+const DEFAULT_LOCALE = exports.DEFAULT_LOCALE = enUSLocaleText;
+const enUS = exports.enUS = (0, _getChartsLocalization.getChartsLocalization)(enUSLocaleText);

package/locales/frFR.d.ts

@@ -0,0 +1,14 @@
+import { ChartsLocaleText } from "./utils/chartsLocaleTextApi.js";
+export declare const frFRLocalText: Partial<ChartsLocaleText>;
+export declare const frFR: {
+  components: {
+    MuiChartsLocalizationProvider: {
+      defaultProps: {
+        localeText: {
+          loading?: string | undefined;
+          noData?: string | undefined;
+        };
+      };
+    };
+  };
+};

package/locales/frFR.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.frFRLocalText = exports.frFR = void 0;
+var _getChartsLocalization = require("./utils/getChartsLocalization");
+const frFRLocalText = exports.frFRLocalText = {
+  // Overlay
+  loading: 'Chargement…',
+  noData: 'Pas de données'
+};
+const frFR = exports.frFR = (0, _getChartsLocalization.getChartsLocalization)(frFRLocalText);

package/locales/index.d.ts

@@ -0,0 +1,3 @@
+export type { ChartsLocaleText } from './utils/chartsLocaleTextApi';
+export * from "./enUS.js";
+export * from "./frFR.js";

package/locales/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _enUS = require("./enUS");
+Object.keys(_enUS).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _enUS[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _enUS[key];
+    }
+  });
+});
+var _frFR = require("./frFR");
+Object.keys(_frFR).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _frFR[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _frFR[key];
+    }
+  });
+});

package/locales/utils/chartsLocaleTextApi.d.ts

@@ -0,0 +1,11 @@
+export interface ChartsLocaleText {
+  /**
+   * Title displayed in the overlay if `loading` is `true`.
+   */
+  loading: string;
+  /**
+   * Title displayed in the overlay if there is no data to display.
+   */
+  noData: string;
+}
+export type ChartsTranslationKeys = keyof ChartsLocaleText;

package/locales/utils/getChartsLocalization.d.ts

@@ -0,0 +1,18 @@
+import { ChartsLocaleText } from "./chartsLocaleTextApi.js";
+/**
+ * Helper to pass translation to all charts thanks to the MUI theme.
+ * @param chartsTranslations The translation object.
+ * @returns an object to pass the translation by using the MUI theme default props
+ */
+export declare const getChartsLocalization: (chartsTranslations: Partial<ChartsLocaleText>) => {
+  components: {
+    MuiChartsLocalizationProvider: {
+      defaultProps: {
+        localeText: {
+          loading?: string | undefined;
+          noData?: string | undefined;
+        };
+      };
+    };
+  };
+};

package/locales/utils/getChartsLocalization.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getChartsLocalization = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+/**
+ * Helper to pass translation to all charts thanks to the MUI theme.
+ * @param chartsTranslations The translation object.
+ * @returns an object to pass the translation by using the MUI theme default props
+ */
+const getChartsLocalization = chartsTranslations => {
+  return {
+    components: {
+      MuiChartsLocalizationProvider: {
+        defaultProps: {
+          localeText: (0, _extends2.default)({}, chartsTranslations)
+        }
+      }
+    }
+  };
+};
+exports.getChartsLocalization = getChartsLocalization;

package/models/axis.d.ts

@@ -1,6 +1,6 @@
-import type { ScaleBand, ScaleLogarithmic, ScalePower, ScaleTime, ScaleLinear, ScalePoint, ScaleOrdinal, ScaleSequential, ScaleThreshold } from '@mui/x-charts-vendor/d3-scale';
+import type { ScaleBand, ScaleLinear, ScaleLogarithmic, ScaleOrdinal, ScalePoint, ScalePower, ScaleSequential, ScaleThreshold, ScaleTime } from '@mui/x-charts-vendor/d3-scale';
 import { SxProps } from '@mui/system/styleFunctionSx';
-import { MakeRequired } from '@mui/x-internals/types';
+import { type MakeOptional, MakeRequired } from '@mui/x-internals/types';
 import { ChartsAxisClasses } from "../ChartsAxis/axisClasses.js";
 import type { TickParams } from '../hooks/useTicks';
 import { ChartsTextProps } from "../ChartsText/index.js";
@@ -349,6 +349,9 @@ export type PolarAxisConfig<S extends ScaleName = ScaleName, V = any, AxisProps
    */
   offset?: number;
 } & CommonAxisConfig<S, V> & Omit<Partial<AxisProps>, 'axisId'> & Partial<Omit<AxisScaleConfig[S], 'scale'>> & AxisConfigExtension;
+/**
+ * Use this type for advanced typing. For basic usage, use `XAxis`, `YAxis`, `RotationAxis` or `RadiusAxis`.
+ */
 export type AxisConfig<S extends ScaleName = ScaleName, V = any, AxisProps extends ChartsAxisProps = ChartsXAxisProps | ChartsYAxisProps> = {
   /**
    * The offset of the axis in pixels. It can be used to move the axis from its default position.
@@ -359,7 +362,12 @@ export type AxisConfig<S extends ScaleName = ScaleName, V = any, AxisProps exten
   offset?: number;
 } & CommonAxisConfig<S, V> & Omit<Partial<AxisProps>, 'axisId'> & Partial<Omit<AxisScaleConfig[S], 'scale'>> & AxisSideConfig<AxisProps> & TickParams & AxisConfigExtension;
 export interface AxisConfigExtension {}
-export type PolarAxisDefaultized<S extends ScaleName = ScaleName, V = any, AxisProps extends ChartsAxisProps = ChartsRotationAxisProps | ChartsRadiusAxisProps> = Omit<PolarAxisConfig<S, V, AxisProps>, 'scaleType'> & AxisScaleConfig[S] & AxisScaleComputedConfig[S];
+export type PolarAxisDefaultized<S extends ScaleName = ScaleName, V = any, AxisProps extends ChartsAxisProps = ChartsRotationAxisProps | ChartsRadiusAxisProps> = Omit<PolarAxisConfig<S, V, AxisProps>, 'scaleType'> & AxisScaleConfig[S] & AxisScaleComputedConfig[S] & {
+  /**
+   * If true, the contents of the axis will be displayed by a tooltip with `trigger='axis'`.
+   */
+  triggerTooltip?: boolean;
+};
 export type AxisDefaultized<S extends ScaleName = ScaleName, V = any, AxisProps extends ChartsAxisProps = ChartsXAxisProps | ChartsYAxisProps> = MakeRequired<Omit<AxisConfig<S, V, AxisProps>, 'scaleType'>, 'offset'> & AxisScaleConfig[S] & AxisScaleComputedConfig[S] & {
   /**
    * An indication of the expected number of ticks.
@@ -393,4 +401,8 @@ export interface ChartsAxisData {
    */
   seriesValues: Record<string, number | null | undefined>;
 }
+export type XAxis<S extends ScaleName = ScaleName, V = any> = S extends ScaleName ? MakeOptional<AxisConfig<S, V, ChartsXAxisProps>, 'id'> : never;
+export type YAxis<S extends ScaleName = ScaleName, V = any> = S extends ScaleName ? MakeOptional<AxisConfig<S, V, ChartsYAxisProps>, 'id'> : never;
+export type RotationAxis<S extends ScaleName = ScaleName, V = any> = S extends ScaleName ? AxisConfig<S, V, ChartsRotationAxisProps> : never;
+export type RadiusAxis<S extends 'linear' = 'linear', V = any> = S extends 'linear' ? AxisConfig<S, V, ChartsRadiusAxisProps> : never;
 export {};

package/models/axis.js

@@ -14,6 +14,10 @@ exports.isPointScaleConfig = isPointScaleConfig;
  * Config that is shared between cartesian and polar axes.
  */
 
+/**
+ * Use this type for advanced typing. For basic usage, use `XAxis`, `YAxis`, `RotationAxis` or `RadiusAxis`.
+ */
+
 function isBandScaleConfig(scaleConfig) {
   return scaleConfig.scaleType === 'band';
 }

package/models/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./seriesType/index.js";
 export * from "./stacking.js";
-export type { AxisConfig, ChartsYAxisProps, ChartsXAxisProps, ScaleName, ContinuousScaleName, ChartsAxisData } from './axis';
+export type { AxisConfig, ChartsYAxisProps, ChartsXAxisProps, ScaleName, ContinuousScaleName, ChartsAxisData, XAxis, YAxis, RadiusAxis, RotationAxis } from './axis';
 export type { PropsFromSlot } from '@mui/x-internals/slots';
 export type { Position } from './position';
 export type { CurveType } from './curve';

package/models/seriesType/common.d.ts

@@ -56,5 +56,4 @@ export type StackableSeriesType = {
    * @default 'none'
    */
   stackOrder?: StackOrderType;
-};
-export type DefaultizedCartesianSeriesType = Required<CartesianSeriesType>;
+};

package/models/seriesType/index.d.ts

@@ -1,9 +1,21 @@
 import { BarSeriesType, DefaultizedBarSeriesType } from "./bar.js";
 import { CartesianChartSeriesType, ChartSeriesType, ChartsSeriesConfig, StackableChartSeriesType } from "./config.js";
 type AllSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['seriesProp'];
+/**
+ * @deprecated We do not use this type in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
 type CartesianSeriesType = AllSeriesType<CartesianChartSeriesType>;
 type DefaultizedSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['series'];
+/**
+ * @deprecated We do not use this type in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
 type DefaultizedCartesianSeriesType = DefaultizedSeriesType<CartesianChartSeriesType>;
+/**
+ * @deprecated We do not use this type in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
 type StackableSeriesType = DefaultizedSeriesType<StackableChartSeriesType>;
 export type SeriesItemIdentifier<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['itemIdentifier'];
 export * from "./line.js";
@@ -11,6 +23,14 @@ export * from "./bar.js";
 export * from "./scatter.js";
 export * from "./pie.js";
 export * from "./radar.js";
-export type { AllSeriesType, CartesianSeriesType, DefaultizedSeriesType, DefaultizedCartesianSeriesType, StackableSeriesType };
+export type { AllSeriesType, DefaultizedSeriesType, CartesianSeriesType, DefaultizedCartesianSeriesType, StackableSeriesType };
+/**
+ * @deprecated We do not use this function in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
 export declare function isDefaultizedBarSeries(series: DefaultizedSeriesType): series is DefaultizedBarSeriesType;
+/**
+ * @deprecated We do not use this function in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
 export declare function isBarSeries(series: AllSeriesType): series is BarSeriesType;

package/models/seriesType/index.js

@@ -71,13 +71,37 @@ Object.keys(_radar).forEach(function (key) {
 });
 // Series definition
 
+/**
+ * @deprecated We do not use this type in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
+
+/**
+ * @deprecated We do not use this type in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
+
+/**
+ * @deprecated We do not use this type in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
+
 // item identifier
 
 // Helpers
 
+/**
+ * @deprecated We do not use this function in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
 function isDefaultizedBarSeries(series) {
   return series.type === 'bar';
 }
+
+/**
+ * @deprecated We do not use this function in v8. If it's useful for you use case, please open an issue explaining why.
+ * Otherwise, it will be removed in next major.
+ */
 function isBarSeries(series) {
   return series.type === 'bar';
 }

package/models/seriesType/radar.d.ts

@@ -8,9 +8,13 @@ export interface RadarSeriesType extends CommonSeriesType<number> {
    */
   label?: string | ((location: 'tooltip' | 'legend') => string);
   /**
-   * If `true` show marks at value position.
+   * If `true` hide marks at value position.
    */
-  showMark?: boolean;
+  hideMark?: boolean;
+  /**
+   * If `true` fill the series area.
+   */
+  fillArea?: boolean;
 }
 /**
  * An object that allows to identify either a radar series or a radar point (if dataIndex is defined).