@mui/x-charts/ChartsTooltip/useItemTooltip.d.mts

The community edition of MUI X Charts components.

import { type ChartSeriesType } from "../models/seriesType/config.mjs";
import { type ItemTooltip, type ItemTooltipWithMultipleValues } from "../internals/plugins/corePlugins/useChartSeriesConfig/index.mjs";
export type UseItemTooltipReturnValue<SeriesType extends ChartSeriesType> = ItemTooltip<SeriesType>;
export type UseRadarItemTooltipReturnValue = ItemTooltipWithMultipleValues<'radar'>;
export declare function useInternalItemTooltip<SeriesType extends ChartSeriesType>(): (SeriesType extends 'radar' ? ItemTooltipWithMultipleValues<SeriesType> : ItemTooltip<SeriesType>) | null;
/**
 * Returns a config object when the tooltip contains a single item to display.
 * Some specific charts like radar need more complex structure. Use specific hook like `useRadarItemTooltip` for them.
 * @returns The tooltip item config
 */
export declare const useItemTooltip: <SeriesType extends Exclude<ChartSeriesType, "radar"> = Exclude<ChartSeriesType, "radar" | "ohlc">>() => UseItemTooltipReturnValue<SeriesType> | null;
/**
 * Contains an object per value with their content and the label of the associated metric.
 * @returns The tooltip item configs
 */
export declare const useRadarItemTooltip: () => UseRadarItemTooltipReturnValue | null;