BarChart
Bar Chart component for categorical comparisons.
Example
"use client";
import { BarChart } from "@databricks/appkit-ui/react";
export default function BarChartExample() {
return (
<BarChart
data={[
{ category: "Product A", value: 100 },
{ category: "Product B", value: 200 },
{ category: "Product C", value: 150 },
{ category: "Product D", value: 300 },
{ category: "Product E", value: 250 },
]}
xKey="category"
yKey="value"
height={300}
/>
);
}
BarChart
Bar Chart component for categorical comparisons.
Important: This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
Best Practice: Use the built-in data fetching by passing queryKey and parameters props instead of pre-fetching data with useAnalyticsQuery.
Supports both query mode (queryKey + parameters) and data mode (static data).
Source: packages/appkit-ui/src/react/charts/bar/index.tsx
Props
| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
queryKey | string | - | Analytics query key registered with analytics plugin | |
parameters | Record<string, unknown> | - | Query parameters passed to the analytics endpoint | |
format | enum | "auto" | Data format to use - "json": Use JSON format (smaller payloads, simpler) - "arrow": Use Arrow format (faster for large datasets) - "auto": Automatically select based on expected data size | |
transformer | (<T>(data: T) => T) | - | Transform raw data before rendering | |
data | ChartData | - | Arrow Table or JSON array | |
title | string | - | Chart title | |
showLegend | boolean | - | Show legend | |
colorPalette | enum | - | Color palette to use. Auto-selected based on chart type if not specified. - "categorical": Distinct colors for different categories (bar, pie, line) - "sequential": Gradient for magnitude/intensity (heatmap) - "diverging": Two-tone for positive/negative values | |
colors | string[] | - | Custom colors for series (overrides colorPalette) | |
height | number | 300 | Chart height in pixels | |
className | string | - | Additional CSS classes | |
xKey | string | - | X-axis field key. Auto-detected from schema if not provided. | |
yKey | string | string[] | - | Y-axis field key(s). Auto-detected from schema if not provided. | |
ariaLabel | string | - | Accessibility label for screen readers | |
testId | string | - | Test ID for automated testing | |
options | Record<string, unknown> | - | Additional ECharts options to merge | |
orientation | enum | "vertical" | Chart orientation | |
stacked | boolean | - | Stack bars |
Usage
import { BarChart } from '@databricks/appkit-ui';
<BarChart /* props */ />