@mui/x-charts
Version:
The community edition of MUI X Charts components.
40 lines • 1.91 kB
text/typescript
import * as React from 'react';
import { type ChartsAxisProps } from "../ChartsAxis/index.mjs";
import { type ChartsAxisHighlightProps } from "../ChartsAxisHighlight/index.mjs";
import { type ChartsClipPathProps } from "../ChartsClipPath/index.mjs";
import { type ChartsGridProps } from "../ChartsGrid/index.mjs";
import { type ChartsLegendSlotExtension } from "../ChartsLegend/index.mjs";
import { type ChartsOverlayProps } from "../ChartsOverlay/index.mjs";
import { type ChartsContainerProps } from "../ChartsContainer/index.mjs";
import { type AreaPlotProps } from "./AreaPlot.mjs";
import type { LineChartProps } from "./LineChart.mjs";
import { type LineHighlightPlotProps } from "./LineHighlightPlot.mjs";
import { type LinePlotProps } from "./LinePlot.mjs";
import { type MarkPlotProps } from "./MarkPlot.mjs";
import type { ChartsWrapperProps } from "../ChartsWrapper/index.mjs";
import { type LineChartPluginSignatures } from "./LineChart.plugins.mjs";
/**
* A helper function that extracts LineChartProps from the input props
* and returns an object with props for the children components of LineChart.
*
* @param props The input props for LineChart
* @returns An object with props for the children components of LineChart
*/
export declare const useLineChartProps: (props: LineChartProps) => {
chartsWrapperProps: Omit<ChartsWrapperProps, "children">;
chartsContainerProps: ChartsContainerProps<"line", LineChartPluginSignatures>;
gridProps: ChartsGridProps;
clipPathProps: ChartsClipPathProps;
clipPathGroupProps: {
clipPath: string;
};
areaPlotProps: AreaPlotProps;
linePlotProps: LinePlotProps;
markPlotProps: MarkPlotProps;
overlayProps: ChartsOverlayProps;
chartsAxisProps: ChartsAxisProps;
axisHighlightProps: ChartsAxisHighlightProps;
lineHighlightPlotProps: LineHighlightPlotProps;
legendProps: ChartsLegendSlotExtension;
children: React.ReactNode;
};