@mui/x-charts 8.9.2 → 8.10.0

package/hooks/useTicksGrouped.d.ts

@@ -0,0 +1,28 @@
+import type { ScaleBand, ScalePoint } from '@mui/x-charts-vendor/d3-scale';
+import { AxisConfig, type AxisGroup } from "../models/axis.js";
+import type { TickParams } from "./useTicks.js";
+export type GroupedTickItemType = {
+  /**
+   * This property is undefined only if it's the tick closing the last band
+   */
+  value?: any;
+  formattedValue?: string;
+  offset: number;
+  labelOffset: number;
+  /**
+   * In band scales, we remove some redundant ticks.
+   */
+  ignoreTick?: boolean;
+  dataIndex?: number;
+  /**
+   * The index of the group this tick belongs to. If `getGrouping` returns `[[0, 1], [2, 3]]`
+   * both ticks with value `0` and `2` will have `groupIndex: 0`, and both ticks with value `1` and `3` will have `groupIndex: 1`.
+   */
+  groupIndex?: number;
+};
+export declare function useTicksGrouped(options: {
+  scale: ScaleBand<any> | ScalePoint<any>;
+  valueFormatter?: AxisConfig['valueFormatter'];
+  direction: 'x' | 'y';
+  groups: AxisGroup[];
+} & Pick<TickParams, 'tickNumber' | 'tickInterval' | 'tickPlacement' | 'tickLabelPlacement'>): GroupedTickItemType[];

package/hooks/useTicksGrouped.js

@@ -0,0 +1,104 @@
+"use strict";
+'use client';
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useTicksGrouped = useTicksGrouped;
+var React = _interopRequireWildcard(require("react"));
+var _isBandScale = require("../internals/isBandScale");
+const offsetRatio = {
+  start: 0,
+  extremities: 0,
+  end: 1,
+  middle: 0.5,
+  tick: 0
+};
+function useTicksGrouped(options) {
+  const {
+    scale,
+    tickInterval,
+    tickLabelPlacement = 'middle',
+    tickPlacement = 'extremities',
+    groups
+  } = options;
+  return React.useMemo(() => {
+    const domain = scale.domain();
+    const filteredDomain = typeof tickInterval === 'function' && domain.filter(tickInterval) || typeof tickInterval === 'object' && tickInterval || domain;
+    if (scale.bandwidth() > 0) {
+      // scale type = 'band'
+      const entries = mapToGrouping(filteredDomain, groups, tickPlacement, tickLabelPlacement, scale);
+      if (entries[0]) {
+        entries[0].ignoreTick = true;
+      }
+      return [{
+        formattedValue: undefined,
+        offset: scale.range()[0],
+        labelOffset: 0,
+        groupIndex: groups.length - 1
+      }, ...entries,
+      // Last tick
+      {
+        formattedValue: undefined,
+        offset: scale.range()[1],
+        labelOffset: 0,
+        groupIndex: groups.length - 1
+      }];
+    }
+
+    // scale type = 'point'
+    return mapToGrouping(filteredDomain, groups, tickPlacement, tickLabelPlacement, scale);
+  }, [scale, tickInterval, groups, tickPlacement, tickLabelPlacement]);
+}
+function mapToGrouping(tickValues, groups, tickPlacement, tickLabelPlacement, scale) {
+  const allTickItems = [];
+  // Map to keep track of offsets and their corresponding tick indexes
+  // Used to remove redundant ticks when they are in the same position
+  const dataIndexToTickIndex = new Map();
+  let currentValueCount = 0;
+  for (let groupIndex = 0; groupIndex < groups.length; groupIndex += 1) {
+    for (let dataIndex = 0; dataIndex < tickValues.length; dataIndex += 1) {
+      const tickValue = tickValues[dataIndex];
+      const groupValue = groups[groupIndex].getValue(tickValue, dataIndex);
+      const lastItem = allTickItems[allTickItems.length - 1];
+
+      // Check if this is a new unique value for this group
+      const isNew = lastItem?.value !== groupValue || lastItem?.groupIndex !== groupIndex;
+      if (isNew) {
+        currentValueCount = 1;
+        // Calculate tick offset
+        const tickOffset = (0, _isBandScale.isBandScale)(scale) ? scale(tickValue) - (scale.step() - scale.bandwidth()) / 2 + offsetRatio[tickPlacement] * scale.step() : scale(tickValue);
+
+        // Calculate the label offset
+        const labelOffset = scale.step() * currentValueCount * (offsetRatio[tickLabelPlacement] - offsetRatio[tickPlacement]);
+
+        // Add a new item
+        allTickItems.push({
+          value: groupValue,
+          formattedValue: `${groupValue}`,
+          offset: tickOffset,
+          groupIndex,
+          dataIndex,
+          ignoreTick: false,
+          labelOffset
+        });
+        if (!dataIndexToTickIndex.has(dataIndex)) {
+          dataIndexToTickIndex.set(dataIndex, new Set());
+        }
+        const tickIndexes = dataIndexToTickIndex.get(dataIndex);
+        for (const previousIndex of tickIndexes.values()) {
+          allTickItems[previousIndex].ignoreTick = true;
+        }
+        tickIndexes.add(allTickItems.length - 1);
+      } else {
+        currentValueCount += 1;
+
+        // Calculate the label offset
+        const labelOffset = scale.step() * currentValueCount * (offsetRatio[tickLabelPlacement] - offsetRatio[tickPlacement]);
+        lastItem.labelOffset = labelOffset;
+      }
+    }
+  }
+  return allTickItems;
+}

package/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v8.9.2
+ * @mui/x-charts v8.10.0
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the

package/internals/getScale.d.ts

@@ -1,2 +1,2 @@
 import { ContinuousScaleName, D3ContinuousScale } from "../models/axis.js";
-export declare function getScale(scaleType: ContinuousScaleName, domain: any[], range: any[]): D3ContinuousScale;
+export declare function getScale(scaleType: ContinuousScaleName, domain: readonly any[], range: readonly any[]): D3ContinuousScale;

package/internals/plugins/featurePlugins/useChartCartesianAxis/createAxisFilterMapper.d.ts

@@ -1,4 +1,4 @@
-import { AxisId, ChartsXAxisProps, ChartsYAxisProps, ScaleName } from "../../../../models/axis.js";
+import { AxisId, ChartsXAxisProps, ChartsYAxisProps, ContinuousScaleName, ScaleName } from "../../../../models/axis.js";
 import { CartesianChartSeriesType } from "../../../../models/seriesType/config.js";
 import { ProcessedSeries } from "../../corePlugins/useChartSeries/index.js";
 import { AxisConfig } from "../../../../models/index.js";
@@ -19,4 +19,6 @@ export declare function createAxisFilterMapper(params: {
   formattedSeries: ProcessedSeries;
   direction: 'y';
 }): (axis: AxisConfig<ScaleName, any, ChartsYAxisProps>, axisIndex: number) => ExtremumFilter | null;
+export declare function createDiscreteScaleGetAxisFilter(axisData: AxisConfig['data'], zoomStart: number, zoomEnd: number, direction: 'x' | 'y'): ExtremumFilter;
+export declare function createContinuousScaleGetAxisFilter(scaleType: ContinuousScaleName | undefined, extrema: readonly [number, number], zoomStart: number, zoomEnd: number, direction: 'x' | 'y', axisData: AxisConfig['data']): ExtremumFilter;
 export declare const createGetAxisFilters: (filters: ZoomAxisFilters) => GetZoomAxisFilters;

package/internals/plugins/featurePlugins/useChartCartesianAxis/createAxisFilterMapper.js

@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createAxisFilterMapper = createAxisFilterMapper;
+exports.createContinuousScaleGetAxisFilter = createContinuousScaleGetAxisFilter;
+exports.createDiscreteScaleGetAxisFilter = createDiscreteScaleGetAxisFilter;
 exports.createGetAxisFilters = void 0;
 var _isDefined = require("../../../isDefined");
 var _getAxisExtremum = require("./getAxisExtremum");
@@ -25,32 +27,41 @@ function createAxisFilterMapper({
       // No zoom, or zoom with all data visible
       return null;
     }
-    let extremums = [];
     const scaleType = axis.scaleType;
     if (scaleType === 'point' || scaleType === 'band') {
-      extremums = [0, (axis.data?.length ?? 1) - 1];
-    } else {
-      extremums = (0, _getAxisExtremum.getAxisExtremum)(axis, direction, seriesConfig, axisIndex, formattedSeries);
+      return createDiscreteScaleGetAxisFilter(axis.data, zoom.start, zoom.end, direction);
     }
-    let min;
-    let max;
-    const continuousScaleType = !scaleType || scaleType === 'band' || scaleType === 'point' ? 'linear' : scaleType;
-    [min, max] = (0, _getScale.getScale)(continuousScaleType, extremums, [0, 100]).nice().domain();
-    min = min instanceof Date ? min.getTime() : min;
-    max = max instanceof Date ? max.getTime() : max;
-    const minVal = min + zoom.start * (max - min) / 100;
-    const maxVal = min + zoom.end * (max - min) / 100;
-    return (value, dataIndex) => {
-      const val = value[direction] ?? axis.data?.[dataIndex];
-      if (val == null) {
-        // If the value does not exist because of missing data point, or out of range index, we just ignore.
-        return true;
-      }
-      if (axis.scaleType === 'point' || axis.scaleType === 'band' || typeof val === 'string') {
-        return dataIndex >= minVal && dataIndex <= maxVal;
-      }
-      return val >= minVal && val <= maxVal;
-    };
+    return createContinuousScaleGetAxisFilter(scaleType, (0, _getAxisExtremum.getAxisExtremum)(axis, direction, seriesConfig, axisIndex, formattedSeries), zoom.start, zoom.end, direction, axis.data);
+  };
+}
+function createDiscreteScaleGetAxisFilter(axisData, zoomStart, zoomEnd, direction) {
+  const maxIndex = axisData?.length ?? 0;
+  const minVal = Math.floor(zoomStart * maxIndex / 100);
+  const maxVal = Math.ceil(zoomEnd * maxIndex / 100);
+  return function filterAxis(value, dataIndex) {
+    const val = value[direction] ?? axisData?.[dataIndex];
+    if (val == null) {
+      // If the value does not exist because of missing data point, or out of range index, we just ignore.
+      return true;
+    }
+    return dataIndex >= minVal && dataIndex < maxVal;
+  };
+}
+function createContinuousScaleGetAxisFilter(scaleType, extrema, zoomStart, zoomEnd, direction, axisData) {
+  let min;
+  let max;
+  [min, max] = (0, _getScale.getScale)(scaleType ?? 'linear', extrema, [0, 100]).nice().domain();
+  min = min instanceof Date ? min.getTime() : min;
+  max = max instanceof Date ? max.getTime() : max;
+  const minVal = min + zoomStart * (max - min) / 100;
+  const maxVal = min + zoomEnd * (max - min) / 100;
+  return function filterAxis(value, dataIndex) {
+    const val = value[direction] ?? axisData?.[dataIndex];
+    if (val == null) {
+      // If the value does not exist because of missing data point, or out of range index, we just ignore.
+      return true;
+    }
+    return val >= minVal && val <= maxVal;
   };
 }
 const createGetAxisFilters = filters => ({

package/internals/plugins/featurePlugins/useChartCartesianAxis/getAxisExtremum.d.ts

@@ -3,4 +3,4 @@ import { CartesianChartSeriesType } from "../../../../models/seriesType/config.j
 import { ChartSeriesConfig } from "../../models/seriesConfig/index.js";
 import { ProcessedSeries } from "../../corePlugins/useChartSeries/useChartSeries.types.js";
 import { GetZoomAxisFilters } from "./zoom.types.js";
-export declare const getAxisExtremum: <T extends CartesianChartSeriesType>(axis: AxisConfig, axisDirection: "x" | "y", seriesConfig: ChartSeriesConfig<T>, axisIndex: number, formattedSeries: ProcessedSeries<T>, getFilters?: GetZoomAxisFilters) => number[];
+export declare const getAxisExtremum: <T extends CartesianChartSeriesType>(axis: AxisConfig, axisDirection: "x" | "y", seriesConfig: ChartSeriesConfig<T>, axisIndex: number, formattedSeries: ProcessedSeries<T>, getFilters?: GetZoomAxisFilters) => [number, number];

package/models/axis.d.ts

@@ -180,6 +180,21 @@ export interface ChartsRadiusAxisProps extends ChartsAxisProps {
 }
 export type ScaleName = keyof AxisScaleConfig;
 export type ContinuousScaleName = 'linear' | 'log' | 'symlog' | 'pow' | 'sqrt' | 'time' | 'utc';
+export type AxisGroup = {
+  /**
+   * The function used to return the value for this group.
+   *
+   * @param {any} value The value of the axis item.
+   * @param {number} dataIndex  The index of the data item.
+   * @returns {string | number | Date} The value that will be used to group the axis items.
+   */
+  getValue: (value: any, dataIndex: number) => string | number | Date;
+  /**
+   * The size of the tick in pixels.
+   * @default 6
+   */
+  tickSize?: number;
+};
 export interface AxisScaleConfig {
   band: {
     scaleType: 'band';
@@ -197,11 +212,57 @@ export interface AxisScaleConfig {
      */
     barGapRatio: number;
     colorMap?: OrdinalColorConfig | ContinuousColorConfig | PiecewiseColorConfig;
+    /**
+     * Each group will have a label that is the stringified value of the group.
+     *
+     * @example
+     * If the axis is grouped by day, month and year.
+     *
+     * ```tsx
+     * [
+     *   { getValue: getDate },
+     *   { getValue: getMonth },
+     *   { getValue: getFullYear }
+     * ]
+     * ```
+     *
+     * Then the axis will have three rows, one for each group.
+     *
+     * ```bash
+     * | 31   | 1    | 2    |
+     * | Jan  | Feb         |
+     * | 2021               |
+     * ```
+     */
+    groups?: AxisGroup[];
   } & Pick<TickParams, 'tickPlacement' | 'tickLabelPlacement'>;
   point: {
     scaleType: 'point';
     scale: ScalePoint<number | Date | string>;
     colorMap?: OrdinalColorConfig | ContinuousColorConfig | PiecewiseColorConfig;
+    /**
+     * Each group will have a label that is the stringified value of the group.
+     *
+     * @example
+     * If the axis is grouped by day, month and year.
+     *
+     * ```tsx
+     * [
+     *   { getValue: getDate },
+     *   { getValue: getMonth },
+     *   { getValue: getFullYear }
+     * ]
+     * ```
+     *
+     * Then the axis will have three rows, one for each group.
+     *
+     * ```bash
+     * | 31   | 1    | 2    |
+     * | Jan  | Feb         |
+     * | 2021               |
+     * ```
+     */
+    groups?: AxisGroup[];
   };
   log: {
     scaleType: 'log';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "8.9.2",
+  "version": "8.10.0",
   "author": "MUI Team",
   "description": "The community edition of MUI X Charts components.",
   "main": "./index.js",
@@ -36,8 +36,8 @@
     "reselect": "^5.1.1",
     "use-sync-external-store": "^1.5.0",
     "@mui/x-charts-vendor": "8.6.0",
-    "@mui/x-internal-gestures": "0.2.2",
-    "@mui/x-internals": "8.9.2"
+    "@mui/x-internal-gestures": "0.2.3",
+    "@mui/x-internals": "8.10.0"
   },
   "peerDependencies": {
     "@emotion/react": "^11.9.0",
@@ -59,7 +59,6 @@
     "node": ">=14.0.0"
   },
   "private": false,
-  "module": "./esm/index.js",
   "exports": {
     "./package.json": "./package.json",
     ".": {