@superset-ui/core
Version:
108 lines • 5.54 kB
TypeScript
import { ReactNode, RefObject, ComponentType } from 'react';
import { ErrorBoundaryProps, FallbackProps } from 'react-error-boundary';
import { Dimension } from '../../dimension';
import { Props as SuperChartCoreProps } from './SuperChartCore';
import { ChartPropsConfig } from '../models/ChartProps';
export type FallbackPropsWithDimension = FallbackProps & Partial<Dimension>;
export type WrapperProps = Dimension & {
children: ReactNode;
};
export type Props = Omit<SuperChartCoreProps, 'chartProps'> & Omit<ChartPropsConfig, 'width' | 'height'> & {
/**
* Set this to true to disable error boundary built-in in SuperChart
* and let the error propagate to upper level
* and handle by yourself
*/
disableErrorBoundary?: boolean;
/** debounceTime to check for container resize */
debounceTime?: number;
/** enable "No Results" message if empty result set */
enableNoResults?: boolean;
/** Component to render when there are unexpected errors */
FallbackComponent?: ComponentType<FallbackPropsWithDimension>;
/** Event listener for unexpected errors from chart */
onErrorBoundary?: ErrorBoundaryProps['onError'];
/** Prop for form plugins using superchart */
showOverflow?: boolean;
/** Prop for popovercontainer ref */
parentRef?: RefObject<any>;
/** Prop for chart ref */
inputRef?: RefObject<any>;
/** Chart width */
height?: number | string;
/** Chart height */
width?: number | string;
/**
* Component to wrap the actual chart
* after the dynamic width and height are determined.
* This can be useful for handling tooltip z-index, etc.
* e.g. <div style={{ position: 'fixed' }} />
* You cannot just wrap this same component outside of SuperChart
* when using dynamic width or height
* because it will clash with auto-sizing.
*/
Wrapper?: ComponentType<WrapperProps>;
/**
* Component to display when query returns no results.
* If not defined, NoResultsComponent is used
*/
noResults?: ReactNode;
/**
* Determines is the context menu related to the chart is open
*/
inContextMenu?: boolean;
};
declare const _default: import("react").FC<Pick<Pick<Omit<SuperChartCoreProps, "chartProps"> & Omit<ChartPropsConfig, "width" | "height"> & {
/**
* Set this to true to disable error boundary built-in in SuperChart
* and let the error propagate to upper level
* and handle by yourself
*/
disableErrorBoundary?: boolean | undefined;
/** debounceTime to check for container resize */
debounceTime?: number | undefined;
/** enable "No Results" message if empty result set */
enableNoResults?: boolean | undefined;
/** Component to render when there are unexpected errors */
FallbackComponent?: ComponentType<FallbackPropsWithDimension> | undefined;
/** Event listener for unexpected errors from chart */
onErrorBoundary?: ((error: Error, componentStack: string) => void) | undefined;
/** Prop for form plugins using superchart */
showOverflow?: boolean | undefined;
/** Prop for popovercontainer ref */
parentRef?: RefObject<any> | undefined;
/** Prop for chart ref */
inputRef?: RefObject<any> | undefined;
/** Chart width */
height?: string | number | undefined;
/** Chart height */
width?: string | number | undefined;
/**
* Component to wrap the actual chart
* after the dynamic width and height are determined.
* This can be useful for handling tooltip z-index, etc.
* e.g. <div style={{ position: 'fixed' }} />
* You cannot just wrap this same component outside of SuperChart
* when using dynamic width or height
* because it will clash with auto-sizing.
*/
Wrapper?: ComponentType<WrapperProps> | undefined;
/**
* Component to display when query returns no results.
* If not defined, NoResultsComponent is used
*/
noResults?: ReactNode;
/**
* Determines is the context menu related to the chart is open
*/
inContextMenu?: boolean | undefined;
}, "className" | "id" | "filterState" | "ownState" | "behaviors" | "formData" | "datasource" | "annotationData" | "queriesData" | "onRenderFailure" | "onRenderSuccess" | "chartType" | "preTransformProps" | "overrideTransformProps" | "postTransformProps" | "theme" | "initialValues" | "hooks" | "legendState" | "displaySettings" | "appSection" | "isRefreshing" | "inputRef" | "disableErrorBoundary" | "debounceTime" | "onErrorBoundary" | "showOverflow" | "parentRef" | "Wrapper" | "noResults" | "inContextMenu"> & {
width?: string | number | undefined;
height?: string | number | undefined;
enableNoResults?: boolean | undefined;
FallbackComponent?: ComponentType<FallbackPropsWithDimension> | undefined;
} & {}, "width" | "height" | "className" | "id" | "filterState" | "ownState" | "behaviors" | "enableNoResults" | "formData" | "datasource" | "annotationData" | "queriesData" | "onRenderFailure" | "onRenderSuccess" | "chartType" | "preTransformProps" | "overrideTransformProps" | "postTransformProps" | "initialValues" | "hooks" | "legendState" | "displaySettings" | "appSection" | "isRefreshing" | "inputRef" | "FallbackComponent" | "disableErrorBoundary" | "debounceTime" | "onErrorBoundary" | "showOverflow" | "parentRef" | "Wrapper" | "noResults" | "inContextMenu"> & {
theme?: import("@emotion/react").Theme | undefined;
}>;
export default _default;
//# sourceMappingURL=SuperChart.d.ts.map