@mui/x-charts
Version:
The community edition of MUI X Charts components.
68 lines • 11.8 kB
text/typescript
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";
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>;
export declare const selectorChartsHighlightedItem: (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;
}) => {
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.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 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;
}) => (item: HighlightItemIdentifierWithType<ComposableChartSeriesType<keyof import("../../../index.mjs").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.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) => 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.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;
export declare const selectorChartIsSeriesFaded: (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;
export declare const selectorChartSeriesUnfadedItem: (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) => number | null | undefined;
export declare const selectorChartSeriesHighlightedItem: (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) => number | null | undefined;
export {};