@mui/x-charts 8.8.0 → 8.9.0

package/esm/models/axis.d.ts

@@ -281,11 +281,37 @@ export type AxisValueFormatterContext<S extends ScaleName = ScaleName> = {
    * - `'legend'` The value is displayed in the legend when using color legend.
    * - `'zoom-slider-tooltip'` The value is displayed in the zoom slider tooltip.
    */
-  location: 'tick' | 'tooltip' | 'zoom-slider-tooltip';
+  location: 'tooltip' | 'zoom-slider-tooltip';
   /**
    * The d3-scale instance associated to the axis.
    */
   scale: AxisScaleConfig[S]['scale'];
+} | {
+  /**
+   * Location indicates where the value will be displayed.
+   * - `'tick'` The value is displayed on the axis ticks.
+   * - `'tooltip'` The value is displayed in the tooltip when hovering the chart.
+   * - `'legend'` The value is displayed in the legend when using color legend.
+   * - `'zoom-slider-tooltip'` The value is displayed in the zoom slider tooltip.
+   */
+  location: 'tick';
+  /**
+   * The d3-scale instance associated to the axis.
+   */
+  scale: AxisScaleConfig[S]['scale'];
+  /**
+   * The tick label shown by default if the value isn't formatted.
+   * This value might be an empty string if no tick label should be displayed, which is particularly useful in log
+   * scales where we want to show ticks to demonstrate it's a log scale, but not labels to avoid them overlapping.
+   * @see See {@link https://d3js.org/d3-scale/log#log_tickFormat D3 log scale docs} for more details.
+   */
+  defaultTickLabel: string;
+  /**
+   * A suggestion of the number of ticks to show.
+   * Can be provided to the scale's `ticks` method to compute the ticks, or to `tickFormat` to format the ticks.
+   * Can be `undefined` if the scale doesn't support it, e.g., band, point scales.
+   */
+  tickNumber?: number;
 };
 /**
  * Config that is shared between cartesian and polar axes.

package/esm/models/seriesType/bar.d.ts

@@ -25,6 +25,16 @@ export interface BarSeriesType extends CommonSeriesType<number | null>, Cartesia
    * @default 'diverging'
    */
   stackOffset?: StackOffsetType;
+  /**
+   * If provided, the value will be used as the minimum size of the bar in pixels.
+   * This is useful to avoid bars with a size of 0.
+   *
+   * The property is ignored if the series value is `null` or `0`.
+   * It also doesn't work with stacked series.
+   *
+   * @default 0px
+   */
+  minBarSize?: number;
 }
 /**
  * An object that allows to identify a single bar.
@@ -35,4 +45,4 @@ export type BarItemIdentifier = {
   seriesId: SeriesId;
   dataIndex: number;
 };
-export interface DefaultizedBarSeriesType extends DefaultizedProps<BarSeriesType, CommonDefaultizedProps | 'color' | 'layout'> {}
+export interface DefaultizedBarSeriesType extends DefaultizedProps<BarSeriesType, CommonDefaultizedProps | 'color' | 'layout' | 'minBarSize'> {}

package/esm/models/seriesType/common.d.ts

@@ -1,6 +1,6 @@
-import type { ChartsLabelMarkProps } from "../../ChartsLabel/index.js";
 import { HighlightScope } from "../../internals/plugins/featurePlugins/useChartHighlight/highlightConfig.types.js";
 import type { StackOffsetType, StackOrderType } from "../stacking.js";
+import type { ChartsLabelMarkType } from "../../ChartsLabel/ChartsLabelMark.js";
 export type SeriesId = number | string;
 export type SeriesValueFormatterContext = {
   /**
@@ -10,7 +10,13 @@ export type SeriesValueFormatterContext = {
 };
 export type SeriesValueFormatter<TValue> = (value: TValue, context: SeriesValueFormatterContext) => string | null;
 export type CommonSeriesType<TValue> = {
+  /**
+   * The id of this series.
+   */
   id?: SeriesId;
+  /**
+   * Color to use when displaying the series.
+   */
   color?: string;
   /**
    * Formatter used to render values in tooltip or other data display.
@@ -22,13 +28,13 @@ export type CommonSeriesType<TValue> = {
   /**
    * The scope to apply when the series is highlighted.
    */
-  highlightScope?: Partial<HighlightScope>;
+  highlightScope?: HighlightScope;
   /**
    * Defines the mark type for the series.
    *
    * There is a default mark type for each series type.
    */
-  labelMarkType?: ChartsLabelMarkProps['type'];
+  labelMarkType?: ChartsLabelMarkType;
 };
 export type CommonDefaultizedProps = 'id' | 'valueFormatter' | 'data';
 export type CartesianSeriesType = {

package/esm/models/seriesType/line.d.ts

@@ -34,7 +34,9 @@ export interface LineSeriesType extends CommonSeriesType<number | null>, Cartesi
    * The key used to retrieve data from the dataset.
    */
   dataKey?: string;
-  stack?: string;
+  /**
+   * If `true`, the series is rendered as an area instead of a line.
+   */
   area?: boolean;
   /**
    * The label to display on the tooltip or the legend. It can be a string or a function.

package/esm/models/seriesType/scatter.d.ts

@@ -12,6 +12,9 @@ export type ScatterValueType = {
 export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType | null>, CartesianSeriesType {
   type: 'scatter';
   data?: readonly ScatterValueType[];
+  /**
+   * Size of the markers in the scatter plot, in pixels.
+   */
   markerSize?: number;
   /**
    * The label to display on the tooltip or the legend. It can be a string or a function.
@@ -52,7 +55,7 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType | n
   };
   preview?: {
     /**
-     * The size of the preview marker.
+     * The size of the preview marker in pixels.
      * @default 1
      */
     markerSize?: number;

package/esm/tests/web-components.js

@@ -0,0 +1,49 @@
+const renderSymbol = Symbol.for('render');
+const connectedSymbol = Symbol.for('connected');
+const contextSymbol = Symbol.for('context');
+const propsSymbol = Symbol.for('props');
+
+// This function creates a custom web component that wraps a React component.
+// Adapted from https://github.com/bitovi/react-to-web-component/blob/b1372bfd7bc67fe49920db840f1ed9cf736b2724/packages/core/src/core.ts
+export function reactToWebComponent(ReactComponent, options, renderer) {
+  class ReactWebComponent extends HTMLElement {
+    static get observedAttributes() {
+      return [];
+    }
+    constructor() {
+      super();
+      this[connectedSymbol] = true;
+      this[contextSymbol] = void 0;
+      this[propsSymbol] = {};
+      this.container = void 0;
+      if (options.shadow) {
+        this.container = this.attachShadow({
+          mode: options.shadow
+        });
+      } else {
+        this.container = this;
+      }
+      this[propsSymbol].container = this.container;
+    }
+    connectedCallback() {
+      this[connectedSymbol] = true;
+      this[renderSymbol]();
+    }
+    disconnectedCallback() {
+      this[connectedSymbol] = false;
+      if (this[contextSymbol]) {
+        renderer.unmount(this[contextSymbol]);
+      }
+      delete this[contextSymbol];
+    }
+    [renderSymbol]() {
+      if (!this[connectedSymbol]) {
+        return;
+      }
+      if (!this[contextSymbol]) {
+        this[contextSymbol] = renderer.mount(this.container, ReactComponent, this[propsSymbol]);
+      }
+    }
+  }
+  return ReactWebComponent;
+}

package/hooks/useTicks.d.ts

@@ -49,8 +49,13 @@ export type TickItemType = {
   offset: number;
   labelOffset: number;
 };
+export declare function getTicks(options: {
+  scale: D3Scale;
+  valueFormatter?: AxisConfig['valueFormatter'];
+  isInside: (offset: number) => boolean;
+} & Pick<TickParams, 'tickInterval' | 'tickPlacement' | 'tickLabelPlacement'> & Required<Pick<TickParams, 'tickNumber'>>): TickItemType[];
 export declare function useTicks(options: {
   scale: D3Scale;
   valueFormatter?: AxisConfig['valueFormatter'];
   direction: 'x' | 'y';
-} & Pick<TickParams, 'tickNumber' | 'tickInterval' | 'tickPlacement' | 'tickLabelPlacement'>): TickItemType[];
+} & Pick<TickParams, 'tickInterval' | 'tickPlacement' | 'tickLabelPlacement'> & Required<Pick<TickParams, 'tickNumber'>>): TickItemType[];

package/hooks/useTicks.js

@@ -5,6 +5,7 @@ var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWild
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getTicks = getTicks;
 exports.useTicks = useTicks;
 var React = _interopRequireWildcard(require("react"));
 var _ChartProvider = require("../context/ChartProvider");
@@ -16,7 +17,7 @@ const offsetRatio = {
   end: 1,
   middle: 0.5
 };
-function useTicks(options) {
+function getTicks(options) {
   const {
     scale,
     tickNumber,
@@ -24,75 +25,111 @@ function useTicks(options) {
     tickInterval,
     tickPlacement = 'extremities',
     tickLabelPlacement: tickLabelPlacementProp,
-    direction
+    isInside
   } = options;
-  const {
-    instance
-  } = (0, _ChartProvider.useChartContext)();
-  return React.useMemo(() => {
-    // band scale
-    if ((0, _isBandScale.isBandScale)(scale)) {
-      const domain = scale.domain();
-      const tickLabelPlacement = tickLabelPlacementProp ?? 'middle';
-      if (scale.bandwidth() > 0) {
-        // scale type = 'band'
-        const filteredDomain = typeof tickInterval === 'function' && domain.filter(tickInterval) || typeof tickInterval === 'object' && tickInterval || domain;
-        return [...filteredDomain.map(value => ({
+
+  // band scale
+  if ((0, _isBandScale.isBandScale)(scale)) {
+    const domain = scale.domain();
+    const tickLabelPlacement = tickLabelPlacementProp ?? 'middle';
+    if (scale.bandwidth() > 0) {
+      // scale type = 'band'
+      const filteredDomain = typeof tickInterval === 'function' && domain.filter(tickInterval) || typeof tickInterval === 'object' && tickInterval || domain;
+      return [...filteredDomain.map(value => {
+        const defaultTickLabel = `${value}`;
+        return {
           value,
           formattedValue: valueFormatter?.(value, {
             location: 'tick',
-            scale
-          }) ?? `${value}`,
+            scale,
+            tickNumber,
+            defaultTickLabel
+          }) ?? defaultTickLabel,
           offset: scale(value) - (scale.step() - scale.bandwidth()) / 2 + offsetRatio[tickPlacement] * scale.step(),
           labelOffset: tickLabelPlacement === 'tick' ? 0 : scale.step() * (offsetRatio[tickLabelPlacement] - offsetRatio[tickPlacement])
-        })), ...(tickPlacement === 'extremities' ? [{
-          formattedValue: undefined,
-          offset: scale.range()[1],
-          labelOffset: 0
-        }] : [])];
-      }
+        };
+      }), ...(tickPlacement === 'extremities' ? [{
+        formattedValue: undefined,
+        offset: scale.range()[1],
+        labelOffset: 0
+      }] : [])];
+    }
 
-      // scale type = 'point'
-      const filteredDomain = typeof tickInterval === 'function' && domain.filter(tickInterval) || typeof tickInterval === 'object' && tickInterval || domain;
-      return filteredDomain.map(value => ({
+    // scale type = 'point'
+    const filteredDomain = typeof tickInterval === 'function' && domain.filter(tickInterval) || typeof tickInterval === 'object' && tickInterval || domain;
+    return filteredDomain.map(value => {
+      const defaultTickLabel = `${value}`;
+      return {
         value,
         formattedValue: valueFormatter?.(value, {
           location: 'tick',
-          scale
-        }) ?? `${value}`,
+          scale,
+          tickNumber,
+          defaultTickLabel
+        }) ?? defaultTickLabel,
         offset: scale(value),
         labelOffset: 0
-      }));
-    }
-    const domain = scale.domain();
-    // Skip axis rendering if no data is available
-    // - The domains contains Infinity for continuous scales.
-    if (domain.some(_isInfinity.isInfinity)) {
-      return [];
-    }
-    const tickLabelPlacement = tickLabelPlacementProp;
-    const ticks = typeof tickInterval === 'object' ? tickInterval : scale.ticks(tickNumber);
+      };
+    });
+  }
+  const domain = scale.domain();
+  // Skip axis rendering if no data is available
+  // - The domains contains Infinity for continuous scales.
+  if (domain.some(_isInfinity.isInfinity)) {
+    return [];
+  }
+  const tickLabelPlacement = tickLabelPlacementProp;
+  const ticks = typeof tickInterval === 'object' ? tickInterval : scale.ticks(tickNumber);
 
-    // Ticks inside the drawing area
-    const visibleTicks = [];
-    for (let i = 0; i < ticks.length; i += 1) {
-      const value = ticks[i];
-      const offset = scale(value);
-      const isInside = direction === 'x' ? instance.isXInside(offset) : instance.isYInside(offset);
-      if (isInside) {
-        visibleTicks.push({
-          value,
-          formattedValue: valueFormatter?.(value, {
-            location: 'tick',
-            scale
-          }) ?? scale.tickFormat(tickNumber)(value),
-          offset,
-          // Allowing the label to be placed in the middle of a continuous scale is weird.
-          // But it is useful in some cases, like funnel categories with a linear scale.
-          labelOffset: tickLabelPlacement === 'middle' ? scale(ticks[i - 1] ?? 0) - (offset + scale(ticks[i - 1] ?? 0)) / 2 : 0
-        });
-      }
+  // Ticks inside the drawing area
+  const visibleTicks = [];
+  for (let i = 0; i < ticks.length; i += 1) {
+    const value = ticks[i];
+    const offset = scale(value);
+    if (isInside(offset)) {
+      /* If d3 returns an empty string, it means that a tick should be shown, but its label shouldn't.
+       * This is especially useful in a log scale where we want to show ticks to demonstrate it's a log
+       * scale, but don't want to show labels because they would overlap.
+       * https://github.com/mui/mui-x/issues/18239 */
+      const defaultTickLabel = scale.tickFormat(tickNumber)(value);
+      visibleTicks.push({
+        value,
+        formattedValue: valueFormatter?.(value, {
+          location: 'tick',
+          scale,
+          tickNumber,
+          defaultTickLabel
+        }) ?? defaultTickLabel,
+        offset,
+        // Allowing the label to be placed in the middle of a continuous scale is weird.
+        // But it is useful in some cases, like funnel categories with a linear scale.
+        labelOffset: tickLabelPlacement === 'middle' ? scale(ticks[i - 1] ?? 0) - (offset + scale(ticks[i - 1] ?? 0)) / 2 : 0
+      });
     }
-    return visibleTicks;
-  }, [scale, tickLabelPlacementProp, tickInterval, tickNumber, tickPlacement, valueFormatter, direction, instance]);
+  }
+  return visibleTicks;
+}
+function useTicks(options) {
+  const {
+    scale,
+    tickNumber,
+    valueFormatter,
+    tickInterval,
+    tickPlacement = 'extremities',
+    tickLabelPlacement,
+    direction
+  } = options;
+  const {
+    instance
+  } = (0, _ChartProvider.useChartContext)();
+  const isInside = direction === 'x' ? instance.isXInside : instance.isYInside;
+  return React.useMemo(() => getTicks({
+    scale,
+    tickNumber,
+    tickPlacement,
+    tickInterval,
+    tickLabelPlacement,
+    valueFormatter,
+    isInside
+  }), [scale, tickNumber, tickPlacement, tickInterval, tickLabelPlacement, valueFormatter, isInside]);
 }

package/index.js

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

package/internals/plugins/featurePlugins/useChartHighlight/createIsFaded.d.ts

@@ -1,3 +1,3 @@
 import { HighlightScope } from "./highlightConfig.types.js";
 import { HighlightItemData } from "./useChartHighlight.types.js";
-export declare const createIsFaded: (highlightScope: HighlightScope | null | undefined, highlightedItem: HighlightItemData | null) => (item: HighlightItemData | null) => boolean;
+export declare function createIsFaded(highlightScope: HighlightScope | null | undefined, highlightedItem: HighlightItemData | null): (item: HighlightItemData | null) => boolean;

package/internals/plugins/featurePlugins/useChartHighlight/createIsFaded.js

@@ -3,17 +3,24 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createIsFaded = void 0;
-const createIsFaded = (highlightScope, highlightedItem) => item => {
-  if (!highlightScope || !highlightedItem || !item) {
-    return false;
-  }
-  if (highlightScope.fade === 'series') {
-    return item.seriesId === highlightedItem.seriesId && item.dataIndex !== highlightedItem.dataIndex;
-  }
-  if (highlightScope.fade === 'global') {
-    return item.seriesId !== highlightedItem.seriesId || item.dataIndex !== highlightedItem.dataIndex;
-  }
+exports.createIsFaded = createIsFaded;
+function alwaysFalse() {
   return false;
-};
-exports.createIsFaded = createIsFaded;
+}
+function createIsFaded(highlightScope, highlightedItem) {
+  if (!highlightScope || !highlightedItem) {
+    return alwaysFalse;
+  }
+  return function isFaded(item) {
+    if (!item) {
+      return false;
+    }
+    if (highlightScope.fade === 'series') {
+      return item.seriesId === highlightedItem.seriesId && item.dataIndex !== highlightedItem.dataIndex;
+    }
+    if (highlightScope.fade === 'global') {
+      return item.seriesId !== highlightedItem.seriesId || item.dataIndex !== highlightedItem.dataIndex;
+    }
+    return false;
+  };
+}

package/internals/plugins/featurePlugins/useChartHighlight/createIsHighlighted.d.ts

@@ -1,3 +1,3 @@
 import { HighlightScope } from "./highlightConfig.types.js";
 import { HighlightItemData } from "./useChartHighlight.types.js";
-export declare const createIsHighlighted: (highlightScope: HighlightScope | null | undefined, highlightedItem: HighlightItemData | null) => (item: HighlightItemData | null) => boolean;
+export declare function createIsHighlighted(highlightScope: HighlightScope | null | undefined, highlightedItem: HighlightItemData | null): (item: HighlightItemData | null) => boolean;

package/internals/plugins/featurePlugins/useChartHighlight/createIsHighlighted.js

@@ -3,17 +3,24 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createIsHighlighted = void 0;
-const createIsHighlighted = (highlightScope, highlightedItem) => item => {
-  if (!highlightScope || !highlightedItem || !item) {
-    return false;
-  }
-  if (highlightScope.highlight === 'series') {
-    return item.seriesId === highlightedItem.seriesId;
-  }
-  if (highlightScope.highlight === 'item') {
-    return item.dataIndex === highlightedItem.dataIndex && item.seriesId === highlightedItem.seriesId;
-  }
+exports.createIsHighlighted = createIsHighlighted;
+function alwaysFalse() {
   return false;
-};
-exports.createIsHighlighted = createIsHighlighted;
+}
+function createIsHighlighted(highlightScope, highlightedItem) {
+  if (!highlightScope || !highlightedItem) {
+    return alwaysFalse;
+  }
+  return function isHighlighted(item) {
+    if (!item) {
+      return false;
+    }
+    if (highlightScope.highlight === 'series') {
+      return item.seriesId === highlightedItem.seriesId;
+    }
+    if (highlightScope.highlight === 'item') {
+      return item.dataIndex === highlightedItem.dataIndex && item.seriesId === highlightedItem.seriesId;
+    }
+    return false;
+  };
+}

package/internals/plugins/featurePlugins/useChartHighlight/useChartHighlight.selectors.js

@@ -20,8 +20,10 @@ const selectorChartsHighlightScopePerSeriesId = exports.selectorChartsHighlightS
   });
   return map;
 });
-const selectorChartsHighlightedItem = exports.selectorChartsHighlightedItem = (0, _selectors.createSelector)([selectHighlight], highlight => highlight.item);
-const selectorChartsHighlightScope = exports.selectorChartsHighlightScope = (0, _selectors.createSelector)([selectorChartsHighlightScopePerSeriesId, selectorChartsHighlightedItem], (seriesIdToHighlightScope, highlightedItem) => {
+const selectorChartsHighlightedItem = exports.selectorChartsHighlightedItem = (0, _selectors.createSelector)([selectHighlight], function selectorChartsHighlightedItem(highlight) {
+  return highlight.item;
+});
+const selectorChartsHighlightScope = exports.selectorChartsHighlightScope = (0, _selectors.createSelector)([selectorChartsHighlightScopePerSeriesId, selectorChartsHighlightedItem], function selectorChartsHighlightScope(seriesIdToHighlightScope, highlightedItem) {
   if (!highlightedItem) {
     return null;
   }
@@ -33,5 +35,9 @@ const selectorChartsHighlightScope = exports.selectorChartsHighlightScope = (0,
 });
 const selectorChartsIsHighlightedCallback = exports.selectorChartsIsHighlightedCallback = (0, _selectors.createSelector)([selectorChartsHighlightScope, selectorChartsHighlightedItem], _createIsHighlighted.createIsHighlighted);
 const selectorChartsIsFadedCallback = exports.selectorChartsIsFadedCallback = (0, _selectors.createSelector)([selectorChartsHighlightScope, selectorChartsHighlightedItem], _createIsFaded.createIsFaded);
-const selectorChartsIsHighlighted = exports.selectorChartsIsHighlighted = (0, _selectors.createSelector)([selectorChartsHighlightScope, selectorChartsHighlightedItem, (_, item) => item], (highlightScope, highlightedItem, item) => (0, _createIsHighlighted.createIsHighlighted)(highlightScope, highlightedItem)(item));
-const selectorChartsIsFaded = exports.selectorChartsIsFaded = (0, _selectors.createSelector)([selectorChartsHighlightScope, selectorChartsHighlightedItem, (_, item) => item], (highlightScope, highlightedItem, item) => (0, _createIsFaded.createIsFaded)(highlightScope, highlightedItem)(item));
+const selectorChartsIsHighlighted = exports.selectorChartsIsHighlighted = (0, _selectors.createSelector)([selectorChartsHighlightScope, selectorChartsHighlightedItem, (_, item) => item], function selectorChartsIsHighlighted(highlightScope, highlightedItem, item) {
+  return (0, _createIsHighlighted.createIsHighlighted)(highlightScope, highlightedItem)(item);
+});
+const selectorChartsIsFaded = exports.selectorChartsIsFaded = (0, _selectors.createSelector)([selectorChartsHighlightScope, selectorChartsHighlightedItem, (_, item) => item], function selectorChartsIsFaded(highlightScope, highlightedItem, item) {
+  return (0, _createIsFaded.createIsFaded)(highlightScope, highlightedItem)(item);
+});

package/internals/plugins/featurePlugins/useChartInteraction/useChartInteraction.js

@@ -11,7 +11,7 @@ var _fastObjectShallowCompare = require("@mui/x-internals/fastObjectShallowCompa
 const useChartInteraction = ({
   store
 }) => {
-  const cleanInteraction = (0, _useEventCallback.default)(() => {
+  const cleanInteraction = (0, _useEventCallback.default)(function cleanInteraction() {
     store.update(prev => {
       return (0, _extends2.default)({}, prev, {
         interaction: {
@@ -21,7 +21,7 @@ const useChartInteraction = ({
       });
     });
   });
-  const removeItemInteraction = (0, _useEventCallback.default)(itemToRemove => {
+  const removeItemInteraction = (0, _useEventCallback.default)(function removeItemInteraction(itemToRemove) {
     store.update(prev => {
       const prevItem = prev.interaction.item;
       if (!itemToRemove) {
@@ -43,7 +43,7 @@ const useChartInteraction = ({
       });
     });
   });
-  const setItemInteraction = (0, _useEventCallback.default)(newItem => {
+  const setItemInteraction = (0, _useEventCallback.default)(function setItemInteraction(newItem) {
     store.update(prev => {
       if ((0, _fastObjectShallowCompare.fastObjectShallowCompare)(prev.interaction.item, newItem)) {
         return prev;
@@ -55,7 +55,7 @@ const useChartInteraction = ({
       });
     });
   });
-  const setPointerCoordinate = (0, _useEventCallback.default)(coordinate => {
+  const setPointerCoordinate = (0, _useEventCallback.default)(function setPointerCoordinate(coordinate) {
     store.update(prev => (0, _extends2.default)({}, prev, {
       interaction: (0, _extends2.default)({}, prev.interaction, {
         pointer: coordinate

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

@@ -17,6 +17,8 @@ var _useChartInteraction = require("../useChartInteraction");
 var _useChartPolarAxis = require("./useChartPolarAxis.selectors");
 var _getSVGPoint = require("../../../getSVGPoint");
 var _coordinateTransformation = require("./coordinateTransformation");
+var _getAxisIndex = require("./getAxisIndex");
+var _useChartSeries = require("../../corePlugins/useChartSeries");
 const useChartPolarAxis = ({
   params,
   store,
@@ -37,6 +39,7 @@ const useChartPolarAxis = ({
     }
   }
   const drawingArea = (0, _useSelector.useSelector)(store, _useChartDimensions.selectorChartDrawingArea);
+  const processedSeries = (0, _useSelector.useSelector)(store, _useChartSeries.selectorChartSeriesProcessed);
   const center = (0, _useSelector.useSelector)(store, _useChartPolarAxis.selectorChartPolarCenter);
   const isInteractionEnabled = (0, _useSelector.useSelector)(store, _useChartInteraction.selectorChartsInteractionIsInitialized);
   const {
@@ -163,6 +166,45 @@ const useChartPolarAxis = ({
       pressEndHandler.cleanup();
     };
   }, [svgRef, store, center, radiusAxisWithScale, usedRadiusAxisId, rotationAxisWithScale, usedRotationAxisId, instance, params.disableAxisListener, isInteractionEnabled, svg2rotation]);
+  React.useEffect(() => {
+    const element = svgRef.current;
+    const onAxisClick = params.onAxisClick;
+    if (element === null || !onAxisClick) {
+      return () => {};
+    }
+    const axisClickHandler = instance.addInteractionListener('tap', event => {
+      let dataIndex = null;
+      let isRotationAxis = false;
+      const svgPoint = (0, _getSVGPoint.getSVGPoint)(element, event.detail.srcEvent);
+      const rotation = (0, _coordinateTransformation.generateSvg2rotation)(center)(svgPoint.x, svgPoint.y);
+      const rotationIndex = (0, _getAxisIndex.getAxisIndex)(rotationAxisWithScale[usedRotationAxisId], rotation);
+      isRotationAxis = rotationIndex !== -1;
+      dataIndex = isRotationAxis ? rotationIndex : null; // radius index is not yet implemented.
+
+      const USED_AXIS_ID = isRotationAxis ? usedRotationAxisId : usedRadiusAxisId;
+      if (dataIndex == null || dataIndex === -1) {
+        return;
+      }
+
+      // The .data exist because otherwise the dataIndex would be null or -1.
+      const axisValue = (isRotationAxis ? rotationAxisWithScale : radiusAxisWithScale)[USED_AXIS_ID].data[dataIndex];
+      const seriesValues = {};
+      Object.keys(processedSeries).filter(seriesType => seriesType === 'radar').forEach(seriesType => {
+        processedSeries[seriesType]?.seriesOrder.forEach(seriesId => {
+          const seriesItem = processedSeries[seriesType].series[seriesId];
+          seriesValues[seriesId] = seriesItem.data[dataIndex];
+        });
+      });
+      onAxisClick(event.detail.srcEvent, {
+        dataIndex,
+        axisValue,
+        seriesValues
+      });
+    });
+    return () => {
+      axisClickHandler.cleanup();
+    };
+  }, [center, instance, params.onAxisClick, processedSeries, radiusAxisWithScale, rotationAxisWithScale, svgRef, usedRadiusAxisId, usedRotationAxisId]);
   return {
     instance: {
       svg2polar,
@@ -176,7 +218,8 @@ useChartPolarAxis.params = {
   rotationAxis: true,
   radiusAxis: true,
   dataset: true,
-  disableAxisListener: true
+  disableAxisListener: true,
+  onAxisClick: true
 };
 useChartPolarAxis.getInitialState = params => ({
   polarAxis: {

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

@@ -1,6 +1,6 @@
 import { ChartPluginSignature } from "../../models/index.js";
 import { ChartSeriesType, DatasetType } from "../../../../models/seriesType/config.js";
-import { ScaleName, AxisConfig, ChartsRotationAxisProps, ChartsRadiusAxisProps, RadiusAxis, RotationAxis } from "../../../../models/axis.js";
+import { ScaleName, AxisConfig, ChartsRotationAxisProps, ChartsRadiusAxisProps, RadiusAxis, RotationAxis, ChartsAxisData } from "../../../../models/axis.js";
 import { UseChartSeriesSignature } from "../../corePlugins/useChartSeries/index.js";
 import { UseChartInteractionSignature } from "../useChartInteraction/index.js";
 export interface UseChartPolarAxisInstance {
@@ -49,6 +49,13 @@ export interface UseChartPolarAxisParameters {
    * @default false
    */
   disableAxisListener?: boolean;
+  /**
+   * The function called for onClick events.
+   * The second argument contains information about all line/bar elements at the current mouse position.
+   * @param {MouseEvent} event The mouse event recorded on the `<svg/>` element.
+   * @param {null | ChartsAxisData} data The data about the clicked axis and items associated with it.
+   */
+  onAxisClick?: (event: MouseEvent, data: null | ChartsAxisData) => void;
 }
 export type UseChartPolarAxisDefaultizedParameters = UseChartPolarAxisParameters & {};
 export interface UseChartPolarAxisState {