Skip to main content

Chart

ChartContainer

Source: packages/appkit-ui/src/react/ui/chart.tsx

Props

PropTypeRequiredDefaultDescription
configChartConfig--

Usage

import { ChartContainer } from '@databricks/appkit-ui';

<ChartContainer /* props */ />

ChartLegend

A wrapper component for Recharts Legend with proper typing and documentation support. It is needed to ensure the correct name is displayed in the docs.

Source: packages/appkit-ui/src/react/ui/chart.tsx

Props

PropTypeRequiredDefaultDescription
contentContentType--
dangerouslySetInnerHTML{ __html: string; }--
onCopyAdaptChildClipboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCopyCaptureAdaptChildClipboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCutAdaptChildClipboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCutCaptureAdaptChildClipboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPasteAdaptChildClipboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPasteCaptureAdaptChildClipboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCompositionEndAdaptChildCompositionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCompositionEndCaptureAdaptChildCompositionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCompositionStartAdaptChildCompositionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCompositionStartCaptureAdaptChildCompositionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCompositionUpdateAdaptChildCompositionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCompositionUpdateCaptureAdaptChildCompositionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onFocusAdaptChildFocusEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onFocusCaptureAdaptChildFocusEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onBlurAdaptChildFocusEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onBlurCaptureAdaptChildFocusEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onChangeAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onChangeCaptureAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onBeforeInputAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onBeforeInputCaptureAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onInputAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onInputCaptureAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onResetAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onResetCaptureAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSubmitAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSubmitCaptureAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onInvalidAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onInvalidCaptureAdaptChildFormEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onErrorAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onErrorCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onKeyDownAdaptChildKeyboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onKeyDownCaptureAdaptChildKeyboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onKeyPressAdaptChildKeyboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onKeyPressCaptureAdaptChildKeyboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onKeyUpAdaptChildKeyboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onKeyUpCaptureAdaptChildKeyboardEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAbortAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAbortCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCanPlayAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCanPlayCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCanPlayThroughAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onCanPlayThroughCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDurationChangeAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDurationChangeCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onEmptiedAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onEmptiedCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onEncryptedAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onEncryptedCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onEndedAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onEndedCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadedDataAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadedDataCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadedMetadataAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadedMetadataCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadStartAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLoadStartCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPauseAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPauseCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPlayAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPlayCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPlayingAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPlayingCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onProgressAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onProgressCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onRateChangeAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onRateChangeCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSeekedAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSeekedCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSeekingAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSeekingCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onStalledAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onStalledCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSuspendAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSuspendCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTimeUpdateAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTimeUpdateCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onVolumeChangeAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onVolumeChangeCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onWaitingAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onWaitingCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAuxClickAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAuxClickCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onClick((data: Payload, index: number, event: MouseEvent<Element, MouseEvent>) => void)--
onClickCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onContextMenuAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onContextMenuCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDoubleClickAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDoubleClickCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragEndAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragEndCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragEnterAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragEnterCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragExitAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragExitCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragLeaveAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragLeaveCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragOverAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragOverCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragStartAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDragStartCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDropAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onDropCaptureAdaptChildDragEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseDownAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseDownCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseEnter((data: Payload, index: number, event: MouseEvent<Element, MouseEvent>) => void)--
onMouseLeave((data: Payload, index: number, event: MouseEvent<Element, MouseEvent>) => void)--
onMouseMoveAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseMoveCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseOutAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseOutCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseOverAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseOverCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseUpAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onMouseUpCaptureAdaptChildMouseEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSelectAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onSelectCaptureAdaptChildReactEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchCancelAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchCancelCaptureAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchEndAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchEndCaptureAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchMoveAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchMoveCaptureAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchStartAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTouchStartCaptureAdaptChildTouchEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerDownAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerDownCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerMoveAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerMoveCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerUpAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerUpCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerCancelAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerCancelCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerEnterAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerLeaveAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerOverAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerOverCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerOutAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerOutCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onGotPointerCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onGotPointerCaptureCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLostPointerCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onLostPointerCaptureCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onScrollAdaptChildUIEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onScrollCaptureAdaptChildUIEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onWheelAdaptChildWheelEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onWheelCaptureAdaptChildWheelEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAnimationStartAdaptChildAnimationEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAnimationStartCaptureAdaptChildAnimationEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAnimationEndAdaptChildAnimationEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAnimationEndCaptureAdaptChildAnimationEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAnimationIterationAdaptChildAnimationEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onAnimationIterationCaptureAdaptChildAnimationEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTransitionEndAdaptChildTransitionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onTransitionEndCaptureAdaptChildTransitionEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
formatterFormatter--
payloadPayload[]--
payloadUniqByUniqueOption<Payload>--
wrapperStyleCSSProperties--
onPointerEnterCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
onPointerLeaveCaptureAdaptChildPointerEventHandler<any, ReactElement<unknown, string | JSXElementConstructor<any>>>--
iconSizenumber--
iconTypeenum--
layoutenum--
alignenum--
verticalAlignenum--
inactiveColorstring--
chartWidthnumber--
chartHeightnumber--
margin{ top?: number; left?: number; bottom?: number | undefined; right?: number | undefined; } | undefined--
onBBoxUpdate((box: DOMRect | null) => void)--

Usage

import { ChartLegend } from '@databricks/appkit-ui';

<ChartLegend /* props */ />

ChartLegendContent

Source: packages/appkit-ui/src/react/ui/chart.tsx

Props

PropTypeRequiredDefaultDescription
verticalAlignenum--
payloadany[][] as any[]-
hideIconbooleanfalse-
nameKeystring--

Usage

import { ChartLegendContent } from '@databricks/appkit-ui';

<ChartLegendContent /* props */ />

ChartStyle

Source: packages/appkit-ui/src/react/ui/chart.tsx

Props

PropTypeRequiredDefaultDescription
idstring--
configChartConfig--

Usage

import { ChartStyle } from '@databricks/appkit-ui';

<ChartStyle /* props */ />

ChartTooltip

A wrapper component for Recharts Tooltip with proper typing and documentation support. It is needed to ensure the correct name is displayed in the docs.

Source: packages/appkit-ui/src/react/ui/chart.tsx

Props

PropTypeRequiredDefaultDescription
separatorstring--
wrapperClassNamestring--
labelClassNamestring--
formatterFormatter<any, any>--
contentStyleCSSProperties--
itemStyleCSSProperties--
labelStyleCSSProperties--
labelFormatter((label: any, payload: Payload<any, any>[]) => ReactNode)--
labelany--
payloadPayload<any, any>[]--
itemSorter((item: Payload<any, any>) => string | number)--
accessibilityLayerboolean--
activeboolean-If true, then Tooltip is always displayed, once an activeIndex is set by mouse over, or programmatically. If false, then Tooltip is never displayed. If active is undefined, Recharts will control when the Tooltip displays. This includes mouse and keyboard controls.
includeHiddenboolean-If true, then Tooltip will information about hidden series (defaults to false). Interacting with the hide property of Area, Bar, Line, Scatter.
allowEscapeViewBoxAllowInDimension--
animationDurationnumber--
animationEasingenum--
contentContentType<any, any>--
coordinatePartial<Coordinate>--
cursorboolean | ReactElement<unknown, string | JSXElementConstructor<any>> | SVGProps<SVGElement>--
filterNullboolean--
defaultIndexnumber--
isAnimationActiveboolean--
offsetnumber--
payloadUniqByUniqueOption<Payload<any, any>>--
positionPartial<Coordinate>--
reverseDirectionAllowInDimension--
sharedboolean--
triggerenum--
useTranslate3dboolean--
viewBoxCartesianViewBox--
wrapperStyleCSSProperties--

Usage

import { ChartTooltip } from '@databricks/appkit-ui';

<ChartTooltip /* props */ />

ChartTooltipContent

Source: packages/appkit-ui/src/react/ui/chart.tsx

Props

PropTypeRequiredDefaultDescription
activeboolean--
payloadany[]--
labelstring"" as string-
labelFormatter((value: any, payload: any[]) => ReactNode)--
formatter((value: any, name: any, item: any, index: number, payload: any) => ReactNode)--
hideLabelbooleanfalse-
hideIndicatorbooleanfalse-
indicatorenumdot-
labelClassNamestring--
nameKeystring--
labelKeystring--

Usage

import { ChartTooltipContent } from '@databricks/appkit-ui';

<ChartTooltipContent /* props */ />