@mui/x-charts 9.0.0-alpha.2 → 9.0.0-alpha.4

package/models/seriesType/config.d.mts

@@ -25,7 +25,13 @@ export interface ChartsSeriesConfig {
      * Series typing such that the one user need to provide
      */
     seriesProp: BarSeriesType;
+    /**
+     * The minimal information to identify a specific item in the series.
+     */
     itemIdentifier: BarItemIdentifier;
+    /**
+     * The minimal information to identify a specific item in the series. Plus the data associated to it.
+     */
     itemIdentifierWithData: BarItemIdentifier;
     valueType: number | null;
     canBeStacked: true;
@@ -111,22 +117,28 @@ export type ChartSeriesType = keyof ChartsSeriesConfig;
 export type CartesianChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
   axisType: 'cartesian';
 } ? Key : never }[ChartSeriesType]>;
+/**
+ * Extracts series types whose itemIdentifier includes a `dataIndex` property.
+ * This prevents accidentally using dataIndex-based cleaners/serializers
+ * for series types that use different identifier properties (e.g., heatmap uses xIndex/yIndex).
+ */
+export type SeriesTypeWithDataIndex = { [K in ChartSeriesType]: 'dataIndex' extends keyof ChartsSeriesConfig[K]['itemIdentifier'] ? K : never }[ChartSeriesType];
 export type PolarChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
   axisType: 'polar';
 } ? Key : never }[ChartSeriesType]>;
 export type StackableChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
   canBeStacked: true;
 } ? Key : never }[ChartSeriesType]>;
-export type ChartSeries<T extends ChartSeriesType> = ChartsSeriesConfig[T]['seriesInput'];
-export type ChartSeriesDefaultized<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends {
+export type ChartSeries<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType]['seriesInput'];
+export type ChartSeriesDefaultized<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType] extends {
   canBeStacked: true;
-} ? ChartsSeriesConfig[T]['series'] & {
+} ? ChartsSeriesConfig[SeriesType]['series'] & {
   visibleStackedData: [number, number][];
   stackedData: [number, number][];
-} : ChartsSeriesConfig[T]['series'];
-export type ChartSeriesLayout<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends any ? ChartsSeriesConfig[T]['seriesLayout'] : never;
+} : ChartsSeriesConfig[SeriesType]['series'];
+export type ChartSeriesLayout<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType] extends any ? ChartsSeriesConfig[SeriesType]['seriesLayout'] : never;
 export type DatasetElementType<T> = {
   [key: string]: T;
 };
 export type DatasetType<T = unknown> = DatasetElementType<T>[];
-export type HighlightScope<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends any ? ChartsSeriesConfig[T]['highlightScope'] : never;
+export type HighlightScope<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType] extends any ? ChartsSeriesConfig[SeriesType]['highlightScope'] : never;

package/models/seriesType/config.d.ts

@@ -25,7 +25,13 @@ export interface ChartsSeriesConfig {
      * Series typing such that the one user need to provide
      */
     seriesProp: BarSeriesType;
+    /**
+     * The minimal information to identify a specific item in the series.
+     */
     itemIdentifier: BarItemIdentifier;
+    /**
+     * The minimal information to identify a specific item in the series. Plus the data associated to it.
+     */
     itemIdentifierWithData: BarItemIdentifier;
     valueType: number | null;
     canBeStacked: true;
@@ -111,22 +117,28 @@ export type ChartSeriesType = keyof ChartsSeriesConfig;
 export type CartesianChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
   axisType: 'cartesian';
 } ? Key : never }[ChartSeriesType]>;
+/**
+ * Extracts series types whose itemIdentifier includes a `dataIndex` property.
+ * This prevents accidentally using dataIndex-based cleaners/serializers
+ * for series types that use different identifier properties (e.g., heatmap uses xIndex/yIndex).
+ */
+export type SeriesTypeWithDataIndex = { [K in ChartSeriesType]: 'dataIndex' extends keyof ChartsSeriesConfig[K]['itemIdentifier'] ? K : never }[ChartSeriesType];
 export type PolarChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
   axisType: 'polar';
 } ? Key : never }[ChartSeriesType]>;
 export type StackableChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
   canBeStacked: true;
 } ? Key : never }[ChartSeriesType]>;
-export type ChartSeries<T extends ChartSeriesType> = ChartsSeriesConfig[T]['seriesInput'];
-export type ChartSeriesDefaultized<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends {
+export type ChartSeries<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType]['seriesInput'];
+export type ChartSeriesDefaultized<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType] extends {
   canBeStacked: true;
-} ? ChartsSeriesConfig[T]['series'] & {
+} ? ChartsSeriesConfig[SeriesType]['series'] & {
   visibleStackedData: [number, number][];
   stackedData: [number, number][];
-} : ChartsSeriesConfig[T]['series'];
-export type ChartSeriesLayout<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends any ? ChartsSeriesConfig[T]['seriesLayout'] : never;
+} : ChartsSeriesConfig[SeriesType]['series'];
+export type ChartSeriesLayout<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType] extends any ? ChartsSeriesConfig[SeriesType]['seriesLayout'] : never;
 export type DatasetElementType<T> = {
   [key: string]: T;
 };
 export type DatasetType<T = unknown> = DatasetElementType<T>[];
-export type HighlightScope<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends any ? ChartsSeriesConfig[T]['highlightScope'] : never;
+export type HighlightScope<SeriesType extends ChartSeriesType> = ChartsSeriesConfig[SeriesType] extends any ? ChartsSeriesConfig[SeriesType]['highlightScope'] : never;

package/models/seriesType/index.d.mts

@@ -1,16 +1,16 @@
 import type { DefaultizedProps, DistributiveOmit } from '@mui/x-internals/types';
 import type { ChartSeriesType, ChartsSeriesConfig } from "./config.mjs";
-type AllSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['seriesProp'];
-type DefaultizedSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['series'];
-export type SeriesItemIdentifier<T extends ChartSeriesType> = T extends any ? DistributiveOmit<ChartsSeriesConfig[T]['itemIdentifier'], 'type'> : never;
-export type SeriesItemIdentifierWithType<T extends ChartSeriesType> = T extends any ? ChartsSeriesConfig[T]['itemIdentifier'] : never;
-export type SeriesItemIdentifierWithData<T extends ChartSeriesType> = T extends any ? ChartsSeriesConfig[T]['itemIdentifierWithData'] : never;
+type AllSeriesType<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[SeriesType]['seriesProp'];
+type DefaultizedSeriesType<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[SeriesType]['series'];
+export type SeriesItemIdentifier<SeriesType extends ChartSeriesType> = SeriesType extends any ? DistributiveOmit<ChartsSeriesConfig[SeriesType]['itemIdentifier'], 'type'> : never;
+export type SeriesItemIdentifierWithType<SeriesType extends ChartSeriesType> = SeriesType extends any ? ChartsSeriesConfig[SeriesType]['itemIdentifier'] : never;
+export type SeriesItemIdentifierWithData<SeriesType extends ChartSeriesType> = SeriesType extends any ? ChartsSeriesConfig[SeriesType]['itemIdentifierWithData'] : never;
 /**
  * Identifies an highlighted item or series.
  */
-export type HighlightItemIdentifier<T extends ChartSeriesType> = T extends any ? DistributiveOmit<ChartsSeriesConfig[T]['highlightIdentifier'], 'type'> : never;
-export type HighlightItemIdentifierWithType<T extends ChartSeriesType> = T extends any ? ChartsSeriesConfig[T]['highlightIdentifier'] : never;
-export type FocusedItemIdentifier<T extends ChartSeriesType = ChartSeriesType> = T extends 'line' | 'radar' ? DefaultizedProps<ChartsSeriesConfig[T]['itemIdentifier'], 'dataIndex'> : T extends 'heatmap' ? DefaultizedProps<ChartsSeriesConfig[T]['itemIdentifier'], 'xIndex' | 'yIndex'> : ChartsSeriesConfig[T]['itemIdentifier'];
+export type HighlightItemIdentifier<SeriesType extends ChartSeriesType> = SeriesType extends any ? DistributiveOmit<ChartsSeriesConfig[SeriesType]['highlightIdentifier'], 'type'> : never;
+export type HighlightItemIdentifierWithType<SeriesType extends ChartSeriesType> = SeriesType extends any ? ChartsSeriesConfig[SeriesType]['highlightIdentifier'] : never;
+export type FocusedItemIdentifier<SeriesType extends ChartSeriesType = ChartSeriesType> = SeriesType extends 'line' | 'radar' ? DefaultizedProps<ChartsSeriesConfig[SeriesType]['itemIdentifier'], 'dataIndex'> : SeriesType extends 'heatmap' ? DefaultizedProps<ChartsSeriesConfig[SeriesType]['itemIdentifier'], 'xIndex' | 'yIndex'> : ChartsSeriesConfig[SeriesType]['itemIdentifier'];
 export { type SeriesId } from "./common.mjs";
 export type { CartesianChartSeriesType, StackableChartSeriesType } from "./config.mjs";
 export * from "./line.mjs";

package/models/seriesType/index.d.ts

@@ -1,16 +1,16 @@
 import type { DefaultizedProps, DistributiveOmit } from '@mui/x-internals/types';
 import type { ChartSeriesType, ChartsSeriesConfig } from "./config.js";
-type AllSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['seriesProp'];
-type DefaultizedSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['series'];
-export type SeriesItemIdentifier<T extends ChartSeriesType> = T extends any ? DistributiveOmit<ChartsSeriesConfig[T]['itemIdentifier'], 'type'> : never;
-export type SeriesItemIdentifierWithType<T extends ChartSeriesType> = T extends any ? ChartsSeriesConfig[T]['itemIdentifier'] : never;
-export type SeriesItemIdentifierWithData<T extends ChartSeriesType> = T extends any ? ChartsSeriesConfig[T]['itemIdentifierWithData'] : never;
+type AllSeriesType<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[SeriesType]['seriesProp'];
+type DefaultizedSeriesType<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[SeriesType]['series'];
+export type SeriesItemIdentifier<SeriesType extends ChartSeriesType> = SeriesType extends any ? DistributiveOmit<ChartsSeriesConfig[SeriesType]['itemIdentifier'], 'type'> : never;
+export type SeriesItemIdentifierWithType<SeriesType extends ChartSeriesType> = SeriesType extends any ? ChartsSeriesConfig[SeriesType]['itemIdentifier'] : never;
+export type SeriesItemIdentifierWithData<SeriesType extends ChartSeriesType> = SeriesType extends any ? ChartsSeriesConfig[SeriesType]['itemIdentifierWithData'] : never;
 /**
  * Identifies an highlighted item or series.
  */
-export type HighlightItemIdentifier<T extends ChartSeriesType> = T extends any ? DistributiveOmit<ChartsSeriesConfig[T]['highlightIdentifier'], 'type'> : never;
-export type HighlightItemIdentifierWithType<T extends ChartSeriesType> = T extends any ? ChartsSeriesConfig[T]['highlightIdentifier'] : never;
-export type FocusedItemIdentifier<T extends ChartSeriesType = ChartSeriesType> = T extends 'line' | 'radar' ? DefaultizedProps<ChartsSeriesConfig[T]['itemIdentifier'], 'dataIndex'> : T extends 'heatmap' ? DefaultizedProps<ChartsSeriesConfig[T]['itemIdentifier'], 'xIndex' | 'yIndex'> : ChartsSeriesConfig[T]['itemIdentifier'];
+export type HighlightItemIdentifier<SeriesType extends ChartSeriesType> = SeriesType extends any ? DistributiveOmit<ChartsSeriesConfig[SeriesType]['highlightIdentifier'], 'type'> : never;
+export type HighlightItemIdentifierWithType<SeriesType extends ChartSeriesType> = SeriesType extends any ? ChartsSeriesConfig[SeriesType]['highlightIdentifier'] : never;
+export type FocusedItemIdentifier<SeriesType extends ChartSeriesType = ChartSeriesType> = SeriesType extends 'line' | 'radar' ? DefaultizedProps<ChartsSeriesConfig[SeriesType]['itemIdentifier'], 'dataIndex'> : SeriesType extends 'heatmap' ? DefaultizedProps<ChartsSeriesConfig[SeriesType]['itemIdentifier'], 'xIndex' | 'yIndex'> : ChartsSeriesConfig[SeriesType]['itemIdentifier'];
 export { type SeriesId } from "./common.js";
 export type { CartesianChartSeriesType, StackableChartSeriesType } from "./config.js";
 export * from "./line.js";

package/models/seriesType/line.d.mts

@@ -24,6 +24,7 @@ export interface ShowMarkParams<AxisValue = number | Date> {
    */
   value: number;
 }
+export type MarkShape = 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye';
 export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>, CartesianSeriesType, StackableSeriesType {
   type: 'line';
   /**
@@ -62,9 +63,10 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
   /**
    * The shape of the mark elements.
    * Using 'circle' renders a `<circle />` element, while all other options render a `<path />` instead. The path causes a small decrease in performance.
-   * @default 'circle'
+   * By default, each series has a different shape, cycling through `'circle'`, `'square'`, `'diamond'`, `'cross'`, `'star'`, `'triangle'`, `'wye'`.
+   * If there are more than 7 series, the shapes will repeat.
    */
-  shape?: 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye';
+  shape?: MarkShape;
   /**
    * Do not render the line highlight item if set to `true`.
    * @default false

package/models/seriesType/line.d.ts

@@ -24,6 +24,7 @@ export interface ShowMarkParams<AxisValue = number | Date> {
    */
   value: number;
 }
+export type MarkShape = 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye';
 export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>, CartesianSeriesType, StackableSeriesType {
   type: 'line';
   /**
@@ -62,9 +63,10 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
   /**
    * The shape of the mark elements.
    * Using 'circle' renders a `<circle />` element, while all other options render a `<path />` instead. The path causes a small decrease in performance.
-   * @default 'circle'
+   * By default, each series has a different shape, cycling through `'circle'`, `'square'`, `'diamond'`, `'cross'`, `'star'`, `'triangle'`, `'wye'`.
+   * If there are more than 7 series, the shapes will repeat.
    */
-  shape?: 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye';
+  shape?: MarkShape;
   /**
    * Do not render the line highlight item if set to `true`.
    * @default false

package/models/seriesType/radar.d.mts

@@ -1,5 +1,5 @@
 import { type DefaultizedProps } from '@mui/x-internals/types';
-import { type CommonDefaultizedProps, type CommonSeriesType, type SeriesId } from "./common.mjs";
+import type { SeriesId, CommonDefaultizedProps, CommonSeriesType } from "./common.mjs";
 export interface RadarSeriesType extends CommonSeriesType<number, 'radar'> {
   type: 'radar';
   data: number[];

package/models/seriesType/radar.d.ts

@@ -1,5 +1,5 @@
 import { type DefaultizedProps } from '@mui/x-internals/types';
-import { type CommonDefaultizedProps, type CommonSeriesType, type SeriesId } from "./common.js";
+import type { SeriesId, CommonDefaultizedProps, CommonSeriesType } from "./common.js";
 export interface RadarSeriesType extends CommonSeriesType<number, 'radar'> {
   type: 'radar';
   data: number[];

package/models/seriesType/scatter.d.mts

@@ -20,13 +20,6 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType | n
    * The label to display on the tooltip or the legend. It can be a string or a function.
    */
   label?: string | ((location: 'tooltip' | 'legend') => string);
-  /**
-   * If true, the interaction will not use element hover for this series.
-   * @default false
-   * @deprecated This prop will be removed in a future version because it is ambiguous. You can select what to disable
-   *             on hover by disabling the highlight or the tooltip separately.
-   */
-  disableHover?: boolean;
   /**
    * The id of the z-axis used to render the series.
    */

package/models/seriesType/scatter.d.ts

@@ -20,13 +20,6 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType | n
    * The label to display on the tooltip or the legend. It can be a string or a function.
    */
   label?: string | ((location: 'tooltip' | 'legend') => string);
-  /**
-   * If true, the interaction will not use element hover for this series.
-   * @default false
-   * @deprecated This prop will be removed in a future version because it is ambiguous. You can select what to disable
-   *             on hover by disabling the highlight or the tooltip separately.
-   */
-  disableHover?: boolean;
   /**
    * The id of the z-axis used to render the series.
    */