@mui/x-charts/internals/plugins/featurePlugins/useChartHighlight/useChartHighlight.selectors.d.ts

The community edition of MUI X Charts components.

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";
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>;
export declare const selectorChartsHighlightedItem: (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;
}) => {
  type: "line";
  seriesId: SeriesId;
  dataIndex?: number;
} | {
  type: "bar";
  seriesId: SeriesId;
  dataIndex?: number | undefined;
} | {
  type: "scatter";
  seriesId: SeriesId;
  dataIndex?: number;
} | {
  type: "pie";
  seriesId: SeriesId;
  dataIndex?: number;
} | {
  type: "radar";
  seriesId: SeriesId;
  dataIndex?: number;
} | null;
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 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;
}) => (item: HighlightItemIdentifierWithType<ComposableChartSeriesType<keyof import("../../../index.js").ChartsSeriesConfig>> | null) => HighlightState;
/**
 * 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 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;
}, item: any) => HighlightState;
/**
 * 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 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;
export declare const selectorChartIsSeriesFaded: (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;
export declare const selectorChartSeriesUnfadedItem: (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) => number | null | undefined;
export declare const selectorChartSeriesHighlightedItem: (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) => number | null | undefined;
export {};