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

package/internals/plugins/featurePlugins/useChartClosestPoint/useChartClosestPoint.mjs

@@ -17,10 +17,12 @@ export const useChartClosestPoint = ({
     chartsLayerContainerRef
   } = instance;
   const {
-    disableVoronoi,
-    voronoiMaxRadius,
+    disableHitArea,
+    hitAreaRadius,
     onItemClick
   } = params;
+  const resolvedDisableHitArea = disableHitArea;
+  const resolvedHitAreaRadius = hitAreaRadius;
   const {
     axis: xAxis,
     axisIds: xAxisIds
@@ -39,11 +41,11 @@ export const useChartClosestPoint = ({
   const defaultYAxisId = yAxisIds[0];
   useEnhancedEffect(() => {
     store.set('voronoi', {
-      isVoronoiEnabled: !disableVoronoi
+      isVoronoiEnabled: !resolvedDisableHitArea
     });
-  }, [store, disableVoronoi]);
+  }, [store, resolvedDisableHitArea]);
   React.useEffect(() => {
-    if (chartsLayerContainerRef.current === null || disableVoronoi) {
+    if (chartsLayerContainerRef.current === null || resolvedDisableHitArea) {
       return undefined;
     }
     const element = chartsLayerContainerRef.current;
@@ -64,7 +66,7 @@ export const useChartClosestPoint = ({
         const yAxisId = aSeries.yAxisId ?? defaultYAxisId;
         const xAxisZoom = selectorChartAxisZoomData(store.state, xAxisId);
         const yAxisZoom = selectorChartAxisZoomData(store.state, yAxisId);
-        const maxRadius = voronoiMaxRadius === 'item' ? aSeries.markerSize : voronoiMaxRadius;
+        const maxRadius = resolvedHitAreaRadius === 'item' ? aSeries.markerSize : resolvedHitAreaRadius;
         const xZoomStart = (xAxisZoom?.start ?? 0) / 100;
         const xZoomEnd = (xAxisZoom?.end ?? 100) / 100;
         const yZoomStart = (yAxisZoom?.start ?? 0) / 100;
@@ -174,7 +176,7 @@ export const useChartClosestPoint = ({
       pressHandler.cleanup();
       pressEndHandler.cleanup();
     };
-  }, [chartsLayerContainerRef, yAxis, xAxis, voronoiMaxRadius, onItemClick, disableVoronoi, instance, seriesOrder, series, flatbushMap, defaultXAxisId, defaultYAxisId, store]);
+  }, [chartsLayerContainerRef, yAxis, xAxis, resolvedHitAreaRadius, onItemClick, resolvedDisableHitArea, instance, seriesOrder, series, flatbushMap, defaultXAxisId, defaultYAxisId, store]);
 
   // Instance implementation
   const enableVoronoiCallback = useEventCallback(() => {
@@ -197,15 +199,15 @@ export const useChartClosestPoint = ({
 useChartClosestPoint.getDefaultizedParams = ({
   params
 }) => _extends({}, params, {
-  disableVoronoi: params.disableVoronoi ?? !params.series.some(item => item.type === 'scatter')
+  disableHitArea: params.disableHitArea ?? !params.series.some(item => item.type === 'scatter')
 });
 useChartClosestPoint.getInitialState = params => ({
   voronoi: {
-    isVoronoiEnabled: !params.disableVoronoi
+    isVoronoiEnabled: !params.disableHitArea
   }
 });
 useChartClosestPoint.params = {
-  disableVoronoi: true,
-  voronoiMaxRadius: true,
+  disableHitArea: true,
+  hitAreaRadius: true,
   onItemClick: true
 };

package/internals/plugins/featurePlugins/useChartClosestPoint/useChartClosestPoint.types.d.mts

@@ -27,15 +27,15 @@ export interface UseChartVoronoiState {
 }
 export interface UseChartVoronoiParameters {
   /**
-   * If true, the voronoi interaction are ignored.
+   * If true, the hit area interaction is disabled and falls back to hover events.
    */
-  disableVoronoi?: boolean;
+  disableHitArea?: boolean;
   /**
    * Defines the maximum distance between a scatter point and the pointer that triggers the interaction.
    * If set to `'item'`, the radius is the `markerSize`.
    * If `undefined`, the radius is assumed to be infinite.
    */
-  voronoiMaxRadius?: 'item' | number | undefined;
+  hitAreaRadius?: 'item' | number | undefined;
   /**
    * Callback fired when clicking close to an item.
    * This is only available for scatter plot for now.
@@ -44,12 +44,7 @@ export interface UseChartVoronoiParameters {
    */
   onItemClick?: (event: MouseEvent, scatterItemIdentifier: ScatterItemIdentifier) => void;
 }
-export type UseChartVoronoiDefaultizedParameters = Pick<UseChartVoronoiParameters, 'voronoiMaxRadius' | 'onItemClick'> & {
-  /**
-   * If true, the voronoi plugin is disabled.
-   */
-  disableVoronoi: boolean;
-};
+export type UseChartVoronoiDefaultizedParameters = Pick<UseChartVoronoiParameters, 'hitAreaRadius' | 'disableHitArea' | 'onItemClick'>;
 export type UseChartClosestPointSignature<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartPluginSignature<{
   instance: UseChartVoronoiInstance;
   state: UseChartVoronoiState;

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

@@ -27,15 +27,15 @@ export interface UseChartVoronoiState {
 }
 export interface UseChartVoronoiParameters {
   /**
-   * If true, the voronoi interaction are ignored.
+   * If true, the hit area interaction is disabled and falls back to hover events.
    */
-  disableVoronoi?: boolean;
+  disableHitArea?: boolean;
   /**
    * Defines the maximum distance between a scatter point and the pointer that triggers the interaction.
    * If set to `'item'`, the radius is the `markerSize`.
    * If `undefined`, the radius is assumed to be infinite.
    */
-  voronoiMaxRadius?: 'item' | number | undefined;
+  hitAreaRadius?: 'item' | number | undefined;
   /**
    * Callback fired when clicking close to an item.
    * This is only available for scatter plot for now.
@@ -44,12 +44,7 @@ export interface UseChartVoronoiParameters {
    */
   onItemClick?: (event: MouseEvent, scatterItemIdentifier: ScatterItemIdentifier) => void;
 }
-export type UseChartVoronoiDefaultizedParameters = Pick<UseChartVoronoiParameters, 'voronoiMaxRadius' | 'onItemClick'> & {
-  /**
-   * If true, the voronoi plugin is disabled.
-   */
-  disableVoronoi: boolean;
-};
+export type UseChartVoronoiDefaultizedParameters = Pick<UseChartVoronoiParameters, 'hitAreaRadius' | 'disableHitArea' | 'onItemClick'>;
 export type UseChartClosestPointSignature<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartPluginSignature<{
   instance: UseChartVoronoiInstance;
   state: UseChartVoronoiState;

package/internals/plugins/featurePlugins/useChartHighlight/highlightStates.d.mts

@@ -1,9 +1,8 @@
 import type { HighlightItemIdentifier, SeriesId } from "../../../../models/seriesType/index.mjs";
-import type { ChartsSeriesConfig, ChartSeriesType, HighlightScope } from "../../../../models/seriesType/config.mjs";
+import type { ChartsSeriesConfig, HighlightScope } from "../../../../models/seriesType/config.mjs";
 type SeriesTypeWithBatchRendering = 'bar' | 'line' | (ChartsSeriesConfig extends {
   rangeBar: any;
 } ? 'rangeBar' : never);
-export declare function isBatchRenderingSeriesType(type: ChartSeriesType | undefined): type is SeriesTypeWithBatchRendering;
 export declare function isSeriesHighlighted<SeriesType extends SeriesTypeWithBatchRendering>(scope: Partial<HighlightScope<SeriesType>> | null, item: HighlightItemIdentifier<SeriesType> | null, seriesId: SeriesId): boolean;
 export declare function isSeriesFaded<SeriesType extends SeriesTypeWithBatchRendering>(scope: Partial<HighlightScope<SeriesType>> | null, item: HighlightItemIdentifier<SeriesType> | null, seriesId: SeriesId): boolean;
 /**

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

@@ -1,9 +1,8 @@
 import type { HighlightItemIdentifier, SeriesId } from "../../../../models/seriesType/index.js";
-import type { ChartsSeriesConfig, ChartSeriesType, HighlightScope } from "../../../../models/seriesType/config.js";
+import type { ChartsSeriesConfig, HighlightScope } from "../../../../models/seriesType/config.js";
 type SeriesTypeWithBatchRendering = 'bar' | 'line' | (ChartsSeriesConfig extends {
   rangeBar: any;
 } ? 'rangeBar' : never);
-export declare function isBatchRenderingSeriesType(type: ChartSeriesType | undefined): type is SeriesTypeWithBatchRendering;
 export declare function isSeriesHighlighted<SeriesType extends SeriesTypeWithBatchRendering>(scope: Partial<HighlightScope<SeriesType>> | null, item: HighlightItemIdentifier<SeriesType> | null, seriesId: SeriesId): boolean;
 export declare function isSeriesFaded<SeriesType extends SeriesTypeWithBatchRendering>(scope: Partial<HighlightScope<SeriesType>> | null, item: HighlightItemIdentifier<SeriesType> | null, seriesId: SeriesId): boolean;
 /**

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

@@ -5,13 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getSeriesHighlightedDataIndex = getSeriesHighlightedDataIndex;
 exports.getSeriesUnfadedDataIndex = getSeriesUnfadedDataIndex;
-exports.isBatchRenderingSeriesType = isBatchRenderingSeriesType;
 exports.isSeriesFaded = isSeriesFaded;
 exports.isSeriesHighlighted = isSeriesHighlighted;
-const batchRenderingSeries = new Set(['bar', 'rangeBar', 'line']);
-function isBatchRenderingSeriesType(type) {
-  return batchRenderingSeries.has(type);
-}
 function isSeriesHighlighted(scope, item, seriesId) {
   return scope?.highlight === 'series' && item?.seriesId === seriesId;
 }

package/internals/plugins/featurePlugins/useChartHighlight/highlightStates.mjs

@@ -1,7 +1,3 @@
-const batchRenderingSeries = new Set(['bar', 'rangeBar', 'line']);
-export function isBatchRenderingSeriesType(type) {
-  return batchRenderingSeries.has(type);
-}
 export function isSeriesHighlighted(scope, item, seriesId) {
   return scope?.highlight === 'series' && item?.seriesId === seriesId;
 }

package/internals/plugins/featurePlugins/useChartHighlight/useChartHighlight.selectors.d.mts

@@ -2,7 +2,8 @@ import { type SeriesId } from "../../../../models/seriesType/common.mjs";
 import type { HighlightItemIdentifierWithType } from "../../../../models/seriesType/index.mjs";
 import type { ChartSeriesType, HighlightScope } from "../../../../models/seriesType/config.mjs";
 import type { ComposableChartSeriesType } from "../../../../models/seriesType/composition.mjs";
-type HighlightLookUp<T extends ChartSeriesType> = { [K in T]?: Map<SeriesId, HighlightScope<K>> };
+import { type HighlightState } from "../../../../hooks/useItemHighlightState.mjs";
+type HighlightLookUp<SeriesType extends ChartSeriesType> = { [K in SeriesType]?: Map<SeriesId, HighlightScope<K>> };
 export declare const selectorChartsHighlightScopePerSeriesId: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & Partial<{}> & {
   cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
 }) => HighlightLookUp<keyof import("../../../index.mjs").ChartsSeriesConfig>;
@@ -32,46 +33,26 @@ export declare const selectorChartsHighlightedItem: (args_0: import("../../coreP
 export declare const selectorChartsHighlightScope: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
 }) => import("./highlightConfig.types.mjs").CommonHighlightScope | null;
-declare const selectorChartsIsHighlightedCallbackImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
+declare const selectorChartsHighlightStateCallbackImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
-}) => <TestedSeriesType extends ComposableChartSeriesType<keyof import("../../../index.mjs").ChartsSeriesConfig>>(item: HighlightItemIdentifierWithType<TestedSeriesType> | null) => boolean;
+}) => (item: HighlightItemIdentifierWithType<ComposableChartSeriesType<keyof import("../../../index.mjs").ChartsSeriesConfig>> | null) => HighlightState;
 /**
- * Returns a callback to test if an item is highlighted.
+ * Returns a callback to get the highlight state of an item.
  * Uses an explicit function declaration so that TypeScript preserves
  * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
  * allowing module augmentation from pro/premium packages to extend the accepted types.
  */
-export declare function selectorChartsIsHighlightedCallback<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsHighlightedCallbackImpl>[0]): (item: HighlightItemIdentifierWithType<SeriesType> | null) => boolean;
-declare const selectorChartsIsFadedCallbackImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
+export declare function selectorChartsHighlightStateCallback<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsHighlightStateCallbackImpl>[0]): (item: HighlightItemIdentifierWithType<ComposableChartSeriesType<SeriesType>> | null) => HighlightState;
+declare const selectorChartsHighlightStateImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
-}) => <TestedSeriesType extends ComposableChartSeriesType<keyof import("../../../index.mjs").ChartsSeriesConfig>>(item: HighlightItemIdentifierWithType<TestedSeriesType> | null) => boolean;
+}, item: any) => HighlightState;
 /**
- * Returns a callback to test if an item is faded.
+ * Returns the highlight state of an item.
  * Uses an explicit function declaration so that TypeScript preserves
  * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
  * allowing module augmentation from pro/premium packages to extend the accepted types.
  */
-export declare function selectorChartsIsFadedCallback<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsFadedCallbackImpl>[0]): (item: HighlightItemIdentifierWithType<SeriesType> | null) => boolean;
-declare const selectorChartsIsHighlightedImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
-  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
-}, item: any) => boolean;
-/**
- * Test if an item is highlighted.
- * Uses an explicit function declaration so that TypeScript preserves
- * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
- * allowing module augmentation from pro/premium packages to extend the accepted types.
- */
-export declare function selectorChartsIsHighlighted<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsHighlightedImpl>[0], item: HighlightItemIdentifierWithType<ComposableChartSeriesType<SeriesType>> | null): boolean;
-declare const selectorChartsIsFadedImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
-  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
-}, item: any) => boolean;
-/**
- * Test if an item is faded.
- * Uses an explicit function declaration so that TypeScript preserves
- * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
- * allowing module augmentation from pro/premium packages to extend the accepted types.
- */
-export declare function selectorChartsIsFaded<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsFadedImpl>[0], item: HighlightItemIdentifierWithType<ComposableChartSeriesType<SeriesType>> | null): boolean;
+export declare function selectorChartsHighlightState(state: Parameters<typeof selectorChartsHighlightStateImpl>[0], item: Parameters<typeof selectorChartsHighlightStateImpl>[1]): HighlightState;
 export declare const selectorChartIsSeriesHighlighted: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & import("./useChartHighlight.types.mjs").UseChartHighlightState<keyof import("../../../index.mjs").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
 }, seriesId: string) => boolean;

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

@@ -2,7 +2,8 @@ import { type SeriesId } from "../../../../models/seriesType/common.js";
 import type { HighlightItemIdentifierWithType } from "../../../../models/seriesType/index.js";
 import type { ChartSeriesType, HighlightScope } from "../../../../models/seriesType/config.js";
 import type { ComposableChartSeriesType } from "../../../../models/seriesType/composition.js";
-type HighlightLookUp<T extends ChartSeriesType> = { [K in T]?: Map<SeriesId, HighlightScope<K>> };
+import { type HighlightState } from "../../../../hooks/useItemHighlightState.js";
+type HighlightLookUp<SeriesType extends ChartSeriesType> = { [K in SeriesType]?: Map<SeriesId, HighlightScope<K>> };
 export declare const selectorChartsHighlightScopePerSeriesId: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & Partial<{}> & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;
 }) => HighlightLookUp<keyof import("../../../index.js").ChartsSeriesConfig>;
@@ -32,46 +33,26 @@ export declare const selectorChartsHighlightedItem: (args_0: import("../../coreP
 export declare const selectorChartsHighlightScope: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;
 }) => import("./highlightConfig.types.js").CommonHighlightScope | null;
-declare const selectorChartsIsHighlightedCallbackImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
+declare const selectorChartsHighlightStateCallbackImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;
-}) => <TestedSeriesType extends ComposableChartSeriesType<keyof import("../../../index.js").ChartsSeriesConfig>>(item: HighlightItemIdentifierWithType<TestedSeriesType> | null) => boolean;
+}) => (item: HighlightItemIdentifierWithType<ComposableChartSeriesType<keyof import("../../../index.js").ChartsSeriesConfig>> | null) => HighlightState;
 /**
- * Returns a callback to test if an item is highlighted.
+ * Returns a callback to get the highlight state of an item.
  * Uses an explicit function declaration so that TypeScript preserves
  * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
  * allowing module augmentation from pro/premium packages to extend the accepted types.
  */
-export declare function selectorChartsIsHighlightedCallback<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsHighlightedCallbackImpl>[0]): (item: HighlightItemIdentifierWithType<SeriesType> | null) => boolean;
-declare const selectorChartsIsFadedCallbackImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
+export declare function selectorChartsHighlightStateCallback<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsHighlightStateCallbackImpl>[0]): (item: HighlightItemIdentifierWithType<ComposableChartSeriesType<SeriesType>> | null) => HighlightState;
+declare const selectorChartsHighlightStateImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;
-}) => <TestedSeriesType extends ComposableChartSeriesType<keyof import("../../../index.js").ChartsSeriesConfig>>(item: HighlightItemIdentifierWithType<TestedSeriesType> | null) => boolean;
+}, item: any) => HighlightState;
 /**
- * Returns a callback to test if an item is faded.
+ * Returns the highlight state of an item.
  * Uses an explicit function declaration so that TypeScript preserves
  * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
  * allowing module augmentation from pro/premium packages to extend the accepted types.
  */
-export declare function selectorChartsIsFadedCallback<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsFadedCallbackImpl>[0]): (item: HighlightItemIdentifierWithType<SeriesType> | null) => boolean;
-declare const selectorChartsIsHighlightedImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
-  cacheKey: import("../../models/index.js").ChartStateCacheKey;
-}, item: any) => boolean;
-/**
- * Test if an item is highlighted.
- * Uses an explicit function declaration so that TypeScript preserves
- * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
- * allowing module augmentation from pro/premium packages to extend the accepted types.
- */
-export declare function selectorChartsIsHighlighted<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsHighlightedImpl>[0], item: HighlightItemIdentifierWithType<ComposableChartSeriesType<SeriesType>> | null): boolean;
-declare const selectorChartsIsFadedImpl: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
-  cacheKey: import("../../models/index.js").ChartStateCacheKey;
-}, item: any) => boolean;
-/**
- * Test if an item is faded.
- * Uses an explicit function declaration so that TypeScript preserves
- * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
- * allowing module augmentation from pro/premium packages to extend the accepted types.
- */
-export declare function selectorChartsIsFaded<SeriesType extends ChartSeriesType>(state: Parameters<typeof selectorChartsIsFadedImpl>[0], item: HighlightItemIdentifierWithType<ComposableChartSeriesType<SeriesType>> | null): boolean;
+export declare function selectorChartsHighlightState(state: Parameters<typeof selectorChartsHighlightStateImpl>[0], item: Parameters<typeof selectorChartsHighlightStateImpl>[1]): HighlightState;
 export declare const selectorChartIsSeriesHighlighted: (args_0: import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.js").UseChartSeriesConfigState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.js").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartHighlight.types.js").UseChartHighlightState<keyof import("../../../index.js").ChartsSeriesConfig> & Partial<{}> & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;
 }, seriesId: string) => boolean;

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

@@ -3,11 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.selectorChartsHighlightedItem = exports.selectorChartsHighlightScopePerSeriesId = exports.selectorChartsHighlightScope = exports.selectorChartSeriesUnfadedItem = exports.selectorChartSeriesHighlightedItem = exports.selectorChartIsSeriesHighlighted = exports.selectorChartIsSeriesFaded = void 0;
-exports.selectorChartsIsFaded = selectorChartsIsFaded;
-exports.selectorChartsIsFadedCallback = selectorChartsIsFadedCallback;
-exports.selectorChartsIsHighlighted = selectorChartsIsHighlighted;
-exports.selectorChartsIsHighlightedCallback = selectorChartsIsHighlightedCallback;
+exports.selectorChartsHighlightScopePerSeriesId = exports.selectorChartsHighlightScope = exports.selectorChartSeriesUnfadedItem = exports.selectorChartSeriesHighlightedItem = exports.selectorChartIsSeriesHighlighted = exports.selectorChartIsSeriesFaded = void 0;
+exports.selectorChartsHighlightState = selectorChartsHighlightState;
+exports.selectorChartsHighlightStateCallback = selectorChartsHighlightStateCallback;
+exports.selectorChartsHighlightedItem = void 0;
 var _store = require("@mui/x-internals/store");
 var _highlightStates = require("./highlightStates");
 var _useChartKeyboardNavigation = require("../useChartKeyboardNavigation");
@@ -41,70 +40,46 @@ const selectorChartsHighlightScope = exports.selectorChartsHighlightScope = (0,
   }
   return highlightScope;
 });
-const alwaysFalse = () => false;
-const selectorChartsIsHighlightedCallbackImpl = (0, _store.createSelectorMemoized)(selectorChartsHighlightScope, selectorChartsHighlightedItem, _useChartSeriesConfig.selectorChartSeriesConfig, function selectorChartsIsHighlightedCallbackCombiner(highlightScope, highlightedItem, seriesConfig) {
+const alwaysNone = () => 'none';
+const selectorChartsHighlightStateCallbackImpl = (0, _store.createSelectorMemoized)(selectorChartsHighlightScope, selectorChartsHighlightedItem, _useChartSeriesConfig.selectorChartSeriesConfig, function selectorChartsHighlightStateCallbackCombiner(highlightScope, highlightedItem, seriesConfig) {
   if (highlightedItem === null || highlightScope === null) {
-    return alwaysFalse;
+    return alwaysNone;
   }
-  return seriesConfig[highlightedItem.type].isHighlightedCreator(highlightScope, highlightedItem);
+  const config = seriesConfig[highlightedItem.type];
+  const isHighlighted = config.isHighlightedCreator(highlightScope, highlightedItem);
+  const isFaded = config.isFadedCreator(highlightScope, highlightedItem);
+  return item => {
+    if (isHighlighted(item)) {
+      return 'highlighted';
+    }
+    if (isFaded(item)) {
+      return 'faded';
+    }
+    return 'none';
+  };
 });
 
 /**
- * Returns a callback to test if an item is highlighted.
+ * Returns a callback to get the highlight state of an item.
  * Uses an explicit function declaration so that TypeScript preserves
  * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
  * allowing module augmentation from pro/premium packages to extend the accepted types.
  */
-function selectorChartsIsHighlightedCallback(state) {
-  return selectorChartsIsHighlightedCallbackImpl(state);
+function selectorChartsHighlightStateCallback(state) {
+  return selectorChartsHighlightStateCallbackImpl(state);
 }
-const selectorChartsIsFadedCallbackImpl = (0, _store.createSelectorMemoized)(selectorChartsHighlightScope, selectorChartsHighlightedItem, _useChartSeriesConfig.selectorChartSeriesConfig, function selectorChartsIsFadedCallbackCombiner(highlightScope, highlightedItem, seriesConfig) {
-  if (highlightedItem === null || highlightScope === null) {
-    return alwaysFalse;
-  }
-  return seriesConfig[highlightedItem.type].isFadedCreator(highlightScope, highlightedItem);
-});
-
-/**
- * Returns a callback to test if an item is faded.
- * Uses an explicit function declaration so that TypeScript preserves
- * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
- * allowing module augmentation from pro/premium packages to extend the accepted types.
- */
-function selectorChartsIsFadedCallback(state) {
-  return selectorChartsIsFadedCallbackImpl(state);
-}
-const selectorChartsIsHighlightedImpl = (0, _store.createSelector)(selectorChartsHighlightScope, selectorChartsHighlightedItem, _useChartSeriesConfig.selectorChartSeriesConfig, function selectorChartsIsHighlightedCombiner(highlightScope, highlightedItem, seriesConfig, item) {
-  if (highlightedItem === null || highlightScope === null) {
-    return false;
-  }
-  return seriesConfig[highlightedItem.type].isHighlightedCreator(highlightScope, highlightedItem)(item);
-});
-
-/**
- * Test if an item is highlighted.
- * Uses an explicit function declaration so that TypeScript preserves
- * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
- * allowing module augmentation from pro/premium packages to extend the accepted types.
- */
-function selectorChartsIsHighlighted(state, item) {
-  return selectorChartsIsHighlightedImpl(state, item);
-}
-const selectorChartsIsFadedImpl = (0, _store.createSelector)(selectorChartsHighlightScope, selectorChartsHighlightedItem, _useChartSeriesConfig.selectorChartSeriesConfig, function selectorChartsIsFadedCombiner(highlightScope, highlightedItem, seriesConfig, item) {
-  if (highlightedItem === null || highlightScope === null) {
-    return false;
-  }
-  return seriesConfig[highlightedItem.type].isFadedCreator(highlightScope, highlightedItem)(item);
+const selectorChartsHighlightStateImpl = (0, _store.createSelectorMemoized)(selectorChartsHighlightStateCallback, function selectorChartsHighlightStateCombiner(getHighlightState, item) {
+  return getHighlightState(item);
 });
 
 /**
- * Test if an item is faded.
+ * Returns the highlight state of an item.
  * Uses an explicit function declaration so that TypeScript preserves
  * the `HighlightItemIdentifier<ChartSeriesType>` reference in `.d.ts` output,
  * allowing module augmentation from pro/premium packages to extend the accepted types.
  */
-function selectorChartsIsFaded(state, item) {
-  return selectorChartsIsFadedImpl(state, item);
+function selectorChartsHighlightState(state, item) {
+  return selectorChartsHighlightStateImpl(state, item);
 }
 
 // ==========================================================================================
@@ -116,26 +91,14 @@ function selectorChartsIsFaded(state, item) {
 // ==========================================================================================
 
 const selectorChartIsSeriesHighlighted = exports.selectorChartIsSeriesHighlighted = (0, _store.createSelector)(selectorChartsHighlightScope, selectorChartsHighlightedItem, function selectorChartIsSeriesHighlighted(scope, item, seriesId) {
-  if (!(0, _highlightStates.isBatchRenderingSeriesType)(item?.type)) {
-    return false;
-  }
   return (0, _highlightStates.isSeriesHighlighted)(scope, item, seriesId);
 });
 const selectorChartIsSeriesFaded = exports.selectorChartIsSeriesFaded = (0, _store.createSelector)(selectorChartsHighlightScope, selectorChartsHighlightedItem, function selectorChartIsSeriesFaded(scope, item, seriesId) {
-  if (!(0, _highlightStates.isBatchRenderingSeriesType)(item?.type)) {
-    return false;
-  }
   return (0, _highlightStates.isSeriesFaded)(scope, item, seriesId);
 });
 const selectorChartSeriesUnfadedItem = exports.selectorChartSeriesUnfadedItem = (0, _store.createSelector)(selectorChartsHighlightScope, selectorChartsHighlightedItem, function selectorChartSeriesUnfadedItem(scope, item, seriesId) {
-  if (!(0, _highlightStates.isBatchRenderingSeriesType)(item?.type)) {
-    return null;
-  }
   return (0, _highlightStates.getSeriesUnfadedDataIndex)(scope, item, seriesId);
 });
 const selectorChartSeriesHighlightedItem = exports.selectorChartSeriesHighlightedItem = (0, _store.createSelector)(selectorChartsHighlightScope, selectorChartsHighlightedItem, function selectorChartSeriesHighlightedItem(scope, item, seriesId) {
-  if (!(0, _highlightStates.isBatchRenderingSeriesType)(item?.type)) {
-    return null;
-  }
   return (0, _highlightStates.getSeriesHighlightedDataIndex)(scope, item, seriesId);
 });