@mui/x-charts 8.0.0-alpha.13 → 8.0.0-alpha.14

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

@@ -0,0 +1,26 @@
+import { selectorChartDrawingArea } from "../../corePlugins/useChartDimensions/index.js";
+import { selectorChartSeriesConfig, selectorChartSeriesProcessed } from "../../corePlugins/useChartSeries/index.js";
+import { createSelector } from "../../utils/selectors.js";
+import { computeAxisValue } from "./computeAxisValue.js";
+export const selectorChartPolarAxisState = state => state.polarAxis;
+export const selectorChartRawRotationAxis = createSelector(selectorChartPolarAxisState, axis => axis?.rotation);
+export const selectorChartRawRadiusAxis = createSelector(selectorChartPolarAxisState, axis => axis?.radius);
+
+/**
+ * The only interesting selectors that merge axis data and zoom if provided.
+ */
+
+export const selectorChartRotationAxis = createSelector([selectorChartRawRotationAxis, selectorChartDrawingArea, selectorChartSeriesProcessed, selectorChartSeriesConfig], (axis, drawingArea, formattedSeries, seriesConfig) => computeAxisValue({
+  drawingArea,
+  formattedSeries,
+  axis,
+  seriesConfig,
+  axisDirection: 'rotation'
+}));
+export const selectorChartRadiusAxis = createSelector([selectorChartRawRadiusAxis, selectorChartDrawingArea, selectorChartSeriesProcessed, selectorChartSeriesConfig], (axis, drawingArea, formattedSeries, seriesConfig) => computeAxisValue({
+  drawingArea,
+  formattedSeries,
+  axis,
+  seriesConfig,
+  axisDirection: 'radius'
+}));

package/modern/internals/plugins/featurePlugins/useChartPolarAxis/useChartPolarAxis.types.d.ts

@@ -0,0 +1,55 @@
+import { ChartPluginSignature } from "../../models/index.js";
+import { ChartSeriesType, DatasetType } from "../../../../models/seriesType/config.js";
+import { ScaleName, AxisId, AxisConfig, ChartsRotationAxisProps, ChartsRadiusAxisProps } from "../../../../models/axis.js";
+import { UseChartSeriesSignature } from "../../corePlugins/useChartSeries/index.js";
+import { DefaultizedAxisConfig } from "../useChartCartesianAxis/index.js";
+export type PolarAxisState = {
+  /**
+   * Mapping from rotation-axis key to scaling configuration.
+   */
+  rotationAxis: DefaultizedAxisConfig<ChartsRotationAxisProps>;
+  /**
+   * Mapping from radius-axis key to scaling configuration.
+   */
+  radiusAxis: DefaultizedAxisConfig<ChartsRadiusAxisProps>;
+  /**
+   * The rotation-axes IDs sorted by order they were provided.
+   */
+  rotationAxisIds: AxisId[];
+  /**
+   * The radius-axes IDs sorted by order they were provided.
+   */
+  radiusAxisIds: AxisId[];
+};
+export interface UseChartPolarAxisParameters {
+  /**
+   * The configuration of the rotation-axes.
+   * If not provided, a default axis config is used.
+   * An array of [[AxisConfig]] objects.
+   */
+  rotationAxis?: AxisConfig<ScaleName, any, ChartsRotationAxisProps>[];
+  /**
+   * The configuration of the radial-axes.
+   * If not provided, a default axis config is used.
+   * An array of [[AxisConfig]] objects.
+   */
+  radiusAxis?: AxisConfig<'linear', any, ChartsRadiusAxisProps>[];
+  /**
+   * An array of objects that can be used to populate series and axes data using their `dataKey` property.
+   */
+  dataset?: Readonly<DatasetType>;
+}
+export type UseChartPolarAxisDefaultizedParameters = UseChartPolarAxisParameters & {};
+export interface UseChartPolarAxisState {
+  polarAxis: {
+    rotation: AxisConfig<ScaleName, any, ChartsRotationAxisProps>[];
+    radius: AxisConfig<'linear', any, ChartsRadiusAxisProps>[];
+  };
+}
+export interface UseChartPolarAxisInstance {}
+export type UseChartPolarAxisSignature<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartPluginSignature<{
+  params: UseChartPolarAxisParameters;
+  defaultizedParams: UseChartPolarAxisDefaultizedParameters;
+  state: UseChartPolarAxisState;
+  dependencies: [UseChartSeriesSignature<SeriesType>];
+}>;

package/modern/internals/plugins/featurePlugins/useChartPolarAxis/useChartPolarAxis.types.js

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

package/modern/internals/plugins/models/seriesConfig/cartesianExtremumGetter.types.js

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

package/modern/internals/plugins/models/seriesConfig/getSeriesWithDefaultValues.types.d.ts

@@ -0,0 +1,3 @@
+import type { ChartSeries, ChartSeriesType } from '../../../../models/seriesType/config';
+import type { AllSeriesType } from '../../../../models/seriesType';
+export type GetSeriesWithDefaultValues<T extends ChartSeriesType> = (series: AllSeriesType<T>, seriesIndex: number, colors: string[]) => ChartSeries<T>;

package/modern/internals/plugins/models/seriesConfig/getSeriesWithDefaultValues.types.js

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

package/modern/internals/plugins/models/seriesConfig/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./colorProcessor.types.js";
-export * from "./extremumGetter.types.js";
+export * from "./cartesianExtremumGetter.types.js";
+export * from "./polarExtremumGetter.types.js";
 export * from "./seriesConfig.types.js";
 export * from "./seriesProcessor.types.js";
 export * from "./tooltipGetter.types.js";
-export * from "./legendGetter.types.js";
+export * from "./legendGetter.types.js";
+export * from "./getSeriesWithDefaultValues.types.js";

package/modern/internals/plugins/models/seriesConfig/index.js

@@ -1,6 +1,8 @@
 export * from "./colorProcessor.types.js";
-export * from "./extremumGetter.types.js";
+export * from "./cartesianExtremumGetter.types.js";
+export * from "./polarExtremumGetter.types.js";
 export * from "./seriesConfig.types.js";
 export * from "./seriesProcessor.types.js";
 export * from "./tooltipGetter.types.js";
-export * from "./legendGetter.types.js";
+export * from "./legendGetter.types.js";
+export * from "./getSeriesWithDefaultValues.types.js";

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

@@ -0,0 +1,16 @@
+import type { PolarChartSeriesType, ChartSeriesDefaultized } from '../../../../models/seriesType/config';
+import type { AxisConfig } from '../../../../models/axis';
+import type { SeriesId } from '../../../../models/seriesType/common';
+type PolarExtremumGetterParams<TSeriesType extends PolarChartSeriesType> = {
+  series: Record<SeriesId, ChartSeriesDefaultized<TSeriesType>>;
+  axis: AxisConfig;
+  axisIndex: number;
+  isDefaultAxis: boolean;
+};
+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/modern/internals/plugins/models/seriesConfig/polarExtremumGetter.types.js

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

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

@@ -1,16 +1,22 @@
 import type { SeriesProcessor } from './seriesProcessor.types';
-import type { CartesianChartSeriesType, ChartSeriesType } from '../../../../models/seriesType/config';
+import type { CartesianChartSeriesType, ChartSeriesType, PolarChartSeriesType } from '../../../../models/seriesType/config';
 import type { ColorProcessor } from './colorProcessor.types';
-import type { CartesianExtremumGetter } from './extremumGetter.types';
+import type { CartesianExtremumGetter } from './cartesianExtremumGetter.types';
 import type { LegendGetter } from './legendGetter.types';
 import type { TooltipGetter } from './tooltipGetter.types';
+import { PolarExtremumGetter } from "./polarExtremumGetter.types.js";
+import { GetSeriesWithDefaultValues } from "./getSeriesWithDefaultValues.types.js";
 export type ChartSeriesTypeConfig<TSeriesType extends ChartSeriesType> = {
   seriesProcessor: SeriesProcessor<TSeriesType>;
   colorProcessor: ColorProcessor<TSeriesType>;
   legendGetter: LegendGetter<TSeriesType>;
   tooltipGetter: TooltipGetter<TSeriesType>;
+  getSeriesWithDefaultValues: GetSeriesWithDefaultValues<TSeriesType>;
 } & (TSeriesType extends CartesianChartSeriesType ? {
   xExtremumGetter: CartesianExtremumGetter<TSeriesType>;
   yExtremumGetter: CartesianExtremumGetter<TSeriesType>;
+} : {}) & (TSeriesType extends PolarChartSeriesType ? {
+  rotationExtremumGetter: PolarExtremumGetter<TSeriesType>;
+  radiusExtremumGetter: PolarExtremumGetter<TSeriesType>;
 } : {});
 export type ChartSeriesConfig<TSeriesType extends ChartSeriesType> = { [Key in TSeriesType]: ChartSeriesTypeConfig<Key> };

package/modern/internals/stackSeries.d.ts

@@ -1,10 +1,8 @@
 import { Series } from '@mui/x-charts-vendor/d3-shape';
-import type { BarSeriesType, LineSeriesType } from '../models/seriesType';
 import type { StackOffsetType, StackOrderType } from '../models/stacking';
-import { SeriesId } from "../models/seriesType/common.js";
-type StackableSeries = Record<SeriesId, BarSeriesType> | Record<SeriesId, LineSeriesType>;
-type FormatterParams = {
-  series: StackableSeries;
+import { SeriesId, StackableSeriesType } from "../models/seriesType/common.js";
+type FormatterParams<T> = {
+  series: Record<SeriesId, T>;
   seriesOrder: SeriesId[];
   defaultStrategy?: {
     stackOrder?: StackOrderType;
@@ -23,5 +21,5 @@ export declare const StackOffset: { [key in StackOffsetType]: (series: Series<an
  * @param series the object of all bars series
  * @returns an array of groups, including the ids, the stacking order, and the stacking offset.
  */
-export declare const getStackingGroups: (params: FormatterParams) => StackingGroupsType;
+export declare const getStackingGroups: <T extends StackableSeriesType>(params: FormatterParams<T>) => StackingGroupsType;
 export {};

package/modern/models/axis.d.ts

@@ -280,7 +280,10 @@ export type AxisValueFormatterContext<S extends ScaleName = ScaleName> = {
    */
   scale: AxisScaleConfig[S]['scale'];
 };
-export type AxisConfig<S extends ScaleName = ScaleName, V = any, AxisProps extends ChartsAxisProps = ChartsXAxisProps | ChartsYAxisProps> = {
+/**
+ * Config that is shared between cartesian and polar axes.
+ */
+type CommonAxisConfig<S extends ScaleName = ScaleName, V = any> = {
   /**
    * Id used to identify the axis.
    */
@@ -318,31 +321,43 @@ export type AxisConfig<S extends ScaleName = ScaleName, V = any, AxisProps exten
    * If `true`, Reverse the axis scaleBand.
    */
   reverse?: boolean;
-  /**
-   * The offset of the axis in pixels. It can be used to move the axis from its default position.
-   * X-axis: A top axis will move up, and a bottom axis will move down.
-   * Y-axis: A left axis will move left, and a right axis will move right.
-   * @default 0
-   */
-  offset?: number;
   /**
    * Defines the axis scale domain based on the min/max values of series linked to it.
    * - 'nice': Rounds the domain at human friendly values.
-   * - 'strict': Set the domain to the min/max value provided. No extras space is added.
+   * - 'strict': Set the domain to the min/max value provided. No extra space is added.
    * - function: Receives the calculated extremums as parameters, and should return the axis domain.
    */
   domainLimit?: 'nice' | 'strict' | ((min: number, max: number) => {
     min: number;
     max: number;
   });
-} & Omit<Partial<AxisProps>, 'axisId'> & Partial<Omit<AxisScaleConfig[S], 'scale'>> & AxisSideConfig<AxisProps> & TickParams & AxisConfigExtension;
+};
+export type PolarAxisConfig<S extends ScaleName = ScaleName, V = any, AxisProps extends ChartsAxisProps = ChartsRotationAxisProps | ChartsRadiusAxisProps> = {
+  /**
+   * The offset of the axis in pixels. It can be used to move the axis from its default position.
+   * X-axis: A top axis will move up, and a bottom axis will move down.
+   * Y-axis: A left axis will move left, and a right axis will move right.
+   * @default 0
+   */
+  offset?: number;
+} & CommonAxisConfig<S, V> & Omit<Partial<AxisProps>, 'axisId'> & Partial<Omit<AxisScaleConfig[S], 'scale'>> & AxisConfigExtension;
+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.
+   * X-axis: A top axis will move up, and a bottom axis will move down.
+   * Y-axis: A left axis will move left, and a right axis will move right.
+   * @default 0
+   */
+  offset?: number;
+} & CommonAxisConfig<S, V> & Omit<Partial<AxisProps>, 'axisId'> & Partial<Omit<AxisScaleConfig[S], 'scale'>> & AxisSideConfig<AxisProps> & TickParams & AxisConfigExtension;
 export interface AxisConfigExtension {}
-export type AxisDefaultized<S extends ScaleName = ScaleName, V = any, AxisProps extends ChartsAxisProps = ChartsXAxisProps | ChartsYAxisProps> = MakeRequired<Omit<AxisConfig<S, V, AxisProps>, 'scaleType'>, 'offset'> & AxisScaleConfig[S] & AxisSideConfig<AxisProps> & 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];
+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.
    */
   tickNumber: number;
-};
+} & (AxisProps extends ChartsXAxisProps ? MakeRequired<AxisSideConfig<AxisProps>, 'height'> : AxisProps extends ChartsYAxisProps ? MakeRequired<AxisSideConfig<AxisProps>, 'width'> : AxisSideConfig<AxisProps>);
 export declare function isBandScaleConfig(scaleConfig: AxisConfig<ScaleName>): scaleConfig is AxisConfig<'band'> & {
   scaleType: 'band';
 };

package/modern/models/axis.js

@@ -3,6 +3,10 @@
  * shouldn't be provided by the user.
  */
 
+/**
+ * Config that is shared between cartesian and polar axes.
+ */
+
 export function isBandScaleConfig(scaleConfig) {
   return scaleConfig.scaleType === 'band';
 }

package/modern/models/seriesType/config.d.ts

@@ -3,6 +3,7 @@ import { ScatterSeriesType, DefaultizedScatterSeriesType, ScatterItemIdentifier,
 import { LineSeriesType, DefaultizedLineSeriesType, LineItemIdentifier } from "./line.js";
 import { BarItemIdentifier, BarSeriesType, DefaultizedBarSeriesType } from "./bar.js";
 import { PieSeriesType, DefaultizedPieSeriesType, PieItemIdentifier, PieValueType, DefaultizedPieValueType } from "./pie.js";
+import { DefaultizedRadarSeriesType, RadarItemIdentifier, RadarSeriesType } from "./radar.js";
 export interface ChartsSeriesConfig {
   bar: {
     /**
@@ -22,7 +23,7 @@ export interface ChartsSeriesConfig {
     itemIdentifier: BarItemIdentifier;
     valueType: number | null;
     canBeStacked: true;
-    cartesian: true;
+    axisType: 'cartesian';
   };
   line: {
     seriesInput: DefaultizedProps<LineSeriesType, 'id'> & {
@@ -33,7 +34,7 @@ export interface ChartsSeriesConfig {
     itemIdentifier: LineItemIdentifier;
     valueType: number | null;
     canBeStacked: true;
-    cartesian: true;
+    axisType: 'cartesian';
   };
   scatter: {
     seriesInput: DefaultizedProps<ScatterSeriesType, 'id'> & {
@@ -43,7 +44,7 @@ export interface ChartsSeriesConfig {
     seriesProp: ScatterSeriesType;
     valueType: ScatterValueType;
     itemIdentifier: ScatterItemIdentifier;
-    cartesian: true;
+    axisType: 'cartesian';
   };
   pie: {
     seriesInput: Omit<DefaultizedProps<PieSeriesType, 'id'>, 'data'> & {
@@ -56,19 +57,28 @@ export interface ChartsSeriesConfig {
     itemIdentifier: PieItemIdentifier;
     valueType: DefaultizedPieValueType;
   };
+  radar: {
+    seriesInput: DefaultizedProps<RadarSeriesType, 'id'> & {
+      color: string;
+    };
+    series: DefaultizedRadarSeriesType;
+    seriesProp: RadarSeriesType;
+    itemIdentifier: RadarItemIdentifier;
+    valueType: number;
+    axisType: 'polar';
+  };
 }
 export type ChartSeriesType = keyof ChartsSeriesConfig;
 export type CartesianChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
-  cartesian: true;
+  axisType: 'cartesian';
+} ? Key : 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] extends {
-  canBeStacked: true;
-} ? ChartsSeriesConfig[T]['seriesInput'] & {
-  stackedData: [number, number][];
-} : ChartsSeriesConfig[T]['seriesInput'];
+export type ChartSeries<T extends ChartSeriesType> = ChartsSeriesConfig[T]['seriesInput'];
 export type ChartSeriesDefaultized<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends {
   canBeStacked: true;
 } ? ChartsSeriesConfig[T]['series'] & {

package/modern/models/seriesType/index.d.ts

@@ -10,6 +10,7 @@ export * from "./line.js";
 export * from "./bar.js";
 export * from "./scatter.js";
 export * from "./pie.js";
+export * from "./radar.js";
 export type { AllSeriesType, CartesianSeriesType, DefaultizedSeriesType, DefaultizedCartesianSeriesType, StackableSeriesType };
 export declare function isDefaultizedBarSeries(series: DefaultizedSeriesType): series is DefaultizedBarSeriesType;
 export declare function isBarSeries(series: AllSeriesType): series is BarSeriesType;

package/modern/models/seriesType/index.js

@@ -6,6 +6,7 @@ export * from "./line.js";
 export * from "./bar.js";
 export * from "./scatter.js";
 export * from "./pie.js";
+export * from "./radar.js";
 // Helpers
 
 export function isDefaultizedBarSeries(series) {

package/modern/models/seriesType/radar.d.ts

@@ -0,0 +1,24 @@
+import { DefaultizedProps } from '@mui/x-internals/types';
+import { CommonDefaultizedProps, CommonSeriesType, SeriesId } from "./common.js";
+export interface RadarSeriesType extends CommonSeriesType<number> {
+  type: 'radar';
+  data: number[];
+  /**
+   * 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` show marks at value position.
+   */
+  showMark?: boolean;
+}
+/**
+ * An object that allows to identify either a radar series or a radar point (if dataIndex is defined).
+ * Used for item interaction
+ */
+export type RadarItemIdentifier = {
+  type: 'radar';
+  seriesId: SeriesId;
+  dataIndex?: number;
+};
+export interface DefaultizedRadarSeriesType extends DefaultizedProps<RadarSeriesType, CommonDefaultizedProps | 'color'> {}

package/modern/models/seriesType/radar.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "8.0.0-alpha.13",
+  "version": "8.0.0-alpha.14",
   "description": "The community edition of the Charts components (MUI X).",
   "author": "MUI Team",
   "main": "./index.js",