@mui/x-charts
Version:
The community edition of MUI X Charts components.
19 lines • 1.65 kB
TypeScript
import type { HighlightItemIdentifier, SeriesId } from "../../../../models/seriesType/index.js";
import type { ChartsSeriesConfig, HighlightScope } from "../../../../models/seriesType/config.js";
type SeriesTypeWithBatchRendering = 'bar' | 'line' | (ChartsSeriesConfig extends {
rangeBar: any;
} ? 'rangeBar' : never);
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;
/**
* Returns the data index of the highlighted item for a specific series.
* If the item is not highlighted, it returns `null`.
*/
export declare function getSeriesHighlightedDataIndex<SeriesType extends SeriesTypeWithBatchRendering>(scope: Partial<HighlightScope<SeriesType>> | null, item: HighlightItemIdentifier<SeriesType> | null, seriesId: SeriesId): number | null | undefined;
/**
* Returns the data index of the "unfaded item" for a specific series.
* An "unfaded item" is the only item of a faded series that shouldn't be faded.
* If the series is not faded or if there is no highlighted item, it returns `null`.
*/
export declare function getSeriesUnfadedDataIndex<SeriesType extends SeriesTypeWithBatchRendering>(scope: Partial<HighlightScope<SeriesType>> | null, item: HighlightItemIdentifier<SeriesType> | null, seriesId: SeriesId): number | null | undefined;
export {};