@mui/x-charts/ChartsOverlay/ChartsOverlay.d.ts

The community edition of the Charts components (MUI X).

import * as React from 'react';
import { SxProps, Theme } from '@mui/material/styles';
import { SlotComponentPropsFromProps } from '../internals/SlotComponentPropsFromProps';
export declare function useNoData(): boolean;
export type CommonOverlayProps = React.SVGAttributes<SVGTextElement> & {
    /**
     * The message displayed by the overlay.
     */
    message?: string;
    sx?: SxProps<Theme>;
};
export interface ChartsOverlaySlots {
    /**
     * Overlay component rendered when the chart is in a loading state.
     * @default ChartsLoadingOverlay
     */
    loadingOverlay?: React.ElementType<CommonOverlayProps>;
    /**
     * Overlay component rendered when the chart has no data to display.
     * @default ChartsNoDataOverlay
     */
    noDataOverlay?: React.ElementType<CommonOverlayProps>;
}
export interface ChartsOverlaySlotProps {
    loadingOverlay?: SlotComponentPropsFromProps<CommonOverlayProps, {}, {}>;
    noDataOverlay?: SlotComponentPropsFromProps<CommonOverlayProps, {}, {}>;
}
export interface ChartsOverlayProps {
    /**
     * If `true`, a loading overlay is displayed.
     * @default false
     */
    loading?: boolean;
    /**
     * Overridable component slots.
     * @default {}
     */
    slots?: ChartsOverlaySlots;
    /**
     * The props used for each component slot.
     * @default {}
     */
    slotProps?: ChartsOverlaySlotProps;
}
export declare function ChartsOverlay(props: ChartsOverlayProps): React.JSX.Element | null;