UNPKG

@mui/x-charts

Version:

The community edition of MUI X Charts components.

29 lines 1.49 kB
import * as React from 'react'; import { type ChartsAxisProps } from "../ChartsAxis/index.js"; import { type ChartsAxisHighlightProps } from "../ChartsAxisHighlight/index.js"; import { type ChartsGridProps } from "../ChartsGrid/index.js"; import { type ChartsLegendSlotExtension } from "../ChartsLegend/index.js"; import { type ChartsOverlayProps } from "../ChartsOverlay/index.js"; import { type ChartContainerProps } from "../ChartContainer/index.js"; import type { ScatterChartProps } from "./ScatterChart.js"; import type { ScatterPlotProps } from "./ScatterPlot.js"; import type { ChartsWrapperProps } from "../ChartsWrapper/index.js"; import { type ScatterChartPluginSignatures } from "./ScatterChart.plugins.js"; /** * A helper function that extracts ScatterChartProps from the input props * and returns an object with props for the children components of ScatterChart. * * @param props The input props for ScatterChart * @returns An object with props for the children components of ScatterChart */ export declare const useScatterChartProps: (props: ScatterChartProps) => { chartsWrapperProps: Omit<ChartsWrapperProps, "children">; chartContainerProps: ChartContainerProps<"scatter", ScatterChartPluginSignatures>; chartsAxisProps: ChartsAxisProps; gridProps: ChartsGridProps; scatterPlotProps: ScatterPlotProps; overlayProps: ChartsOverlayProps; legendProps: ChartsLegendSlotExtension; axisHighlightProps: ChartsAxisHighlightProps; children: React.ReactNode; };