@mui/x-charts
Version:
The community edition of MUI X Charts components.
16 lines • 832 B
text/typescript
import { type DefaultizedScatterSeriesType, type ScatterItemIdentifier, type ScatterValueType } from "../models/seriesType/scatter.mjs";
export interface ResolvedScatterItem {
cx: number;
cy: number;
series: DefaultizedScatterSeriesType;
scatterPoint: ScatterValueType;
}
/**
* Resolves a scatter item identifier to its on-screen position and the owning
* series. Shared by `FocusedScatterMark`, `HighlightedScatterMark`, and other
* overlay components that need to draw an SVG element at a specific scatter point.
*
* Returns `null` if the identifier is missing, the identifier doesn't point to
* a scatter series, or the referenced point can't be resolved.
*/
export declare function useScatterItemPosition(item: Pick<ScatterItemIdentifier, 'seriesId' | 'dataIndex'> | null | undefined): ResolvedScatterItem | null;