@mui/x-charts 9.0.1 → 9.0.3

package/models/seriesType/line.d.mts

@@ -1,6 +1,7 @@
 import { type DefaultizedProps } from '@mui/x-internals/types';
 import type { StackOffsetType } from "../stacking.mjs";
-import { type CartesianSeriesType, type CommonDefaultizedProps, type CommonSeriesType, type SeriesId, type StackableSeriesType } from "./common.mjs";
+import type { CartesianSeriesType, CommonDefaultizedProps, CommonSeriesType, SeriesId, StackableSeriesType } from "./common.mjs";
+import { type DatasetElementType } from "./config.mjs";
 import { type CurveType } from "../curve.mjs";
 export interface ShowMarkParams<AxisValue = number | Date> {
   /**
@@ -25,8 +26,10 @@ 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';
+/**
+ * @internal The series type shared by the line and radialLine charts
+ */
+export interface CommonLineSeriesType {
   /**
    * Data associated to the line.
    */
@@ -35,6 +38,14 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
    * The key used to retrieve data from the dataset.
    */
   dataKey?: string;
+  /**
+   * A function to extract and transform the value from the `dataset` item.
+   * It receives the full dataset item and should return the series value.
+   * Can be used as an alternative to `dataKey`.
+   * @param {DatasetElementType<unknown>} item The full dataset item.
+   * @returns {number | null} The transformed value.
+   */
+  valueGetter?: (item: DatasetElementType<unknown>) => number | null;
   /**
    * If `true`, the series is rendered as an area instead of a line.
    */
@@ -77,11 +88,6 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
    * @default false
    */
   connectNulls?: boolean;
-  /**
-   * Defines how stacked series handle negative values.
-   * @default 'none'
-   */
-  stackOffset?: StackOffsetType;
   /**
    * The value of the line at the base of the series area.
    *
@@ -93,6 +99,14 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
    */
   baseline?: number | 'min' | 'max';
 }
+export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>, CartesianSeriesType, StackableSeriesType, CommonLineSeriesType {
+  type: 'line';
+  /**
+   * Defines how stacked series handle negative values.
+   * @default 'none'
+   */
+  stackOffset?: StackOffsetType;
+}
 /**
  * An object that allows to identify a single line.
  * Used for item interaction

package/models/seriesType/line.d.ts

@@ -1,6 +1,7 @@
 import { type DefaultizedProps } from '@mui/x-internals/types';
 import type { StackOffsetType } from "../stacking.js";
-import { type CartesianSeriesType, type CommonDefaultizedProps, type CommonSeriesType, type SeriesId, type StackableSeriesType } from "./common.js";
+import type { CartesianSeriesType, CommonDefaultizedProps, CommonSeriesType, SeriesId, StackableSeriesType } from "./common.js";
+import { type DatasetElementType } from "./config.js";
 import { type CurveType } from "../curve.js";
 export interface ShowMarkParams<AxisValue = number | Date> {
   /**
@@ -25,8 +26,10 @@ 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';
+/**
+ * @internal The series type shared by the line and radialLine charts
+ */
+export interface CommonLineSeriesType {
   /**
    * Data associated to the line.
    */
@@ -35,6 +38,14 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
    * The key used to retrieve data from the dataset.
    */
   dataKey?: string;
+  /**
+   * A function to extract and transform the value from the `dataset` item.
+   * It receives the full dataset item and should return the series value.
+   * Can be used as an alternative to `dataKey`.
+   * @param {DatasetElementType<unknown>} item The full dataset item.
+   * @returns {number | null} The transformed value.
+   */
+  valueGetter?: (item: DatasetElementType<unknown>) => number | null;
   /**
    * If `true`, the series is rendered as an area instead of a line.
    */
@@ -77,11 +88,6 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
    * @default false
    */
   connectNulls?: boolean;
-  /**
-   * Defines how stacked series handle negative values.
-   * @default 'none'
-   */
-  stackOffset?: StackOffsetType;
   /**
    * The value of the line at the base of the series area.
    *
@@ -93,6 +99,14 @@ export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>,
    */
   baseline?: number | 'min' | 'max';
 }
+export interface LineSeriesType extends CommonSeriesType<number | null, 'line'>, CartesianSeriesType, StackableSeriesType, CommonLineSeriesType {
+  type: 'line';
+  /**
+   * Defines how stacked series handle negative values.
+   * @default 'none'
+   */
+  stackOffset?: StackOffsetType;
+}
 /**
  * An object that allows to identify a single line.
  * Used for item interaction

package/models/seriesType/scatter.d.mts

@@ -1,5 +1,6 @@
 import { type DefaultizedProps, type MakeRequired } from '@mui/x-internals/types';
 import { type CartesianSeriesType, type CommonDefaultizedProps, type CommonSeriesType, type SeriesId } from "./common.mjs";
+import { type DatasetElementType } from "./config.mjs";
 export type ScatterValueType = {
   x: number;
   y: number;
@@ -24,6 +25,14 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType | n
    * The id of the z-axis used to render the series.
    */
   zAxisId?: string;
+  /**
+   * A function to extract and transform the value from the `dataset` item.
+   * It receives the full dataset item and should return a scatter value.
+   * Can be used as an alternative to `datasetKeys`.
+   * @param {DatasetElementType<unknown>} item The full dataset item.
+   * @returns {ScatterValueType} The transformed value.
+   */
+  valueGetter?: (item: DatasetElementType<unknown>) => ScatterValueType;
   /**
    * The keys used to retrieve data from the dataset.
    *

package/models/seriesType/scatter.d.ts

@@ -1,5 +1,6 @@
 import { type DefaultizedProps, type MakeRequired } from '@mui/x-internals/types';
 import { type CartesianSeriesType, type CommonDefaultizedProps, type CommonSeriesType, type SeriesId } from "./common.js";
+import { type DatasetElementType } from "./config.js";
 export type ScatterValueType = {
   x: number;
   y: number;
@@ -24,6 +25,14 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType | n
    * The id of the z-axis used to render the series.
    */
   zAxisId?: string;
+  /**
+   * A function to extract and transform the value from the `dataset` item.
+   * It receives the full dataset item and should return a scatter value.
+   * Can be used as an alternative to `datasetKeys`.
+   * @param {DatasetElementType<unknown>} item The full dataset item.
+   * @returns {ScatterValueType} The transformed value.
+   */
+  valueGetter?: (item: DatasetElementType<unknown>) => ScatterValueType;
   /**
    * The keys used to retrieve data from the dataset.
    *

package/models/slots/chartsBaseSlotProps.d.mts

@@ -14,6 +14,7 @@ export type ChartBaseButtonProps = ChartBaseCommonProps & {
   id?: string;
   disabled?: boolean;
   tabIndex?: number;
+  size?: 'small' | 'medium' | 'large';
 };
 export type ChartBaseIconButtonProps = ChartBaseCommonProps & {
   ref?: React.Ref<HTMLButtonElement>;
@@ -21,4 +22,20 @@ export type ChartBaseIconButtonProps = ChartBaseCommonProps & {
   disabled?: boolean;
   tabIndex?: number;
   size?: 'small' | 'medium' | 'large';
+};
+export type ChartBaseToggleButtonProps = ChartBaseCommonProps & {
+  ref?: React.Ref<HTMLButtonElement>;
+  id?: string;
+  disabled?: boolean;
+  tabIndex?: number;
+  size?: 'small' | 'medium' | 'large';
+  selected?: boolean;
+  value: unknown;
+};
+export type ChartBaseToggleButtonGroupProps = ChartBaseCommonProps<HTMLDivElement> & {
+  ref?: React.Ref<HTMLDivElement>;
+  value?: unknown;
+  exclusive?: boolean;
+  size?: 'small' | 'medium' | 'large';
+  onChange?: (event: React.MouseEvent<HTMLElement>, value: unknown) => void;
 };

package/models/slots/chartsBaseSlotProps.d.ts

@@ -14,6 +14,7 @@ export type ChartBaseButtonProps = ChartBaseCommonProps & {
   id?: string;
   disabled?: boolean;
   tabIndex?: number;
+  size?: 'small' | 'medium' | 'large';
 };
 export type ChartBaseIconButtonProps = ChartBaseCommonProps & {
   ref?: React.Ref<HTMLButtonElement>;
@@ -21,4 +22,20 @@ export type ChartBaseIconButtonProps = ChartBaseCommonProps & {
   disabled?: boolean;
   tabIndex?: number;
   size?: 'small' | 'medium' | 'large';
+};
+export type ChartBaseToggleButtonProps = ChartBaseCommonProps & {
+  ref?: React.Ref<HTMLButtonElement>;
+  id?: string;
+  disabled?: boolean;
+  tabIndex?: number;
+  size?: 'small' | 'medium' | 'large';
+  selected?: boolean;
+  value: unknown;
+};
+export type ChartBaseToggleButtonGroupProps = ChartBaseCommonProps<HTMLDivElement> & {
+  ref?: React.Ref<HTMLDivElement>;
+  value?: unknown;
+  exclusive?: boolean;
+  size?: 'small' | 'medium' | 'large';
+  onChange?: (event: React.MouseEvent<HTMLElement>, value: unknown) => void;
 };

package/models/slots/chartsBaseSlots.d.mts

@@ -1,6 +1,12 @@
 import type * as React from 'react';
-import { type ChartBaseButtonProps, type ChartBaseIconButtonProps } from "./chartsBaseSlotProps.mjs";
+import { type ChartBaseButtonProps, type ChartBaseIconButtonProps, type ChartBaseToggleButtonProps, type ChartBaseToggleButtonGroupProps } from "./chartsBaseSlotProps.mjs";
 export interface ChartsBaseSlots {
   baseButton: React.ComponentType<ChartBaseButtonProps>;
   baseIconButton: React.ComponentType<ChartBaseIconButtonProps>;
+  /**
+   * Note: MUI's `ToggleButton` has an incompatible `href` prop, so it must be cast:
+   * `ToggleButton as unknown as React.ComponentType<ChartBaseToggleButtonProps>`.
+   */
+  baseToggleButton: React.ComponentType<ChartBaseToggleButtonProps>;
+  baseToggleButtonGroup: React.ComponentType<ChartBaseToggleButtonGroupProps>;
 }

package/models/slots/chartsBaseSlots.d.ts

@@ -1,6 +1,12 @@
 import type * as React from 'react';
-import { type ChartBaseButtonProps, type ChartBaseIconButtonProps } from "./chartsBaseSlotProps.js";
+import { type ChartBaseButtonProps, type ChartBaseIconButtonProps, type ChartBaseToggleButtonProps, type ChartBaseToggleButtonGroupProps } from "./chartsBaseSlotProps.js";
 export interface ChartsBaseSlots {
   baseButton: React.ComponentType<ChartBaseButtonProps>;
   baseIconButton: React.ComponentType<ChartBaseIconButtonProps>;
+  /**
+   * Note: MUI's `ToggleButton` has an incompatible `href` prop, so it must be cast:
+   * `ToggleButton as unknown as React.ComponentType<ChartBaseToggleButtonProps>`.
+   */
+  baseToggleButton: React.ComponentType<ChartBaseToggleButtonProps>;
+  baseToggleButtonGroup: React.ComponentType<ChartBaseToggleButtonGroupProps>;
 }

package/models/z-axis.d.mts

@@ -1,5 +1,6 @@
 import type { ScaleOrdinal, ScaleSequential, ScaleThreshold } from '@mui/x-charts-vendor/d3-scale';
 import { type ContinuousColorConfig, type OrdinalColorConfig, type PiecewiseColorConfig } from "./colorMapping.mjs";
+import { type DatasetElementType } from "./seriesType/config.mjs";
 export interface ZAxisConfig<V = any> {
   id: string;
   data?: readonly V[];
@@ -7,6 +8,14 @@ export interface ZAxisConfig<V = any> {
    * The key used to retrieve `data` from the `dataset` prop.
    */
   dataKey?: string;
+  /**
+   * A function to extract and transform the value from the `dataset` item.
+   * It receives the full dataset item and should return the axis value.
+   * Can be used as an alternative to `dataKey`.
+   * @param {DatasetElementType<unknown>} item The full dataset item.
+   * @returns {V} The transformed value.
+   */
+  valueGetter?: (item: DatasetElementType<unknown>) => V;
   /**
    * The minimal value of the scale.
    */

package/models/z-axis.d.ts

@@ -1,5 +1,6 @@
 import type { ScaleOrdinal, ScaleSequential, ScaleThreshold } from '@mui/x-charts-vendor/d3-scale';
 import { type ContinuousColorConfig, type OrdinalColorConfig, type PiecewiseColorConfig } from "./colorMapping.js";
+import { type DatasetElementType } from "./seriesType/config.js";
 export interface ZAxisConfig<V = any> {
   id: string;
   data?: readonly V[];
@@ -7,6 +8,14 @@ export interface ZAxisConfig<V = any> {
    * The key used to retrieve `data` from the `dataset` prop.
    */
   dataKey?: string;
+  /**
+   * A function to extract and transform the value from the `dataset` item.
+   * It receives the full dataset item and should return the axis value.
+   * Can be used as an alternative to `dataKey`.
+   * @param {DatasetElementType<unknown>} item The full dataset item.
+   * @returns {V} The transformed value.
+   */
+  valueGetter?: (item: DatasetElementType<unknown>) => V;
   /**
    * The minimal value of the scale.
    */