Skip to main content

HeatmapChart

Heatmap Chart component for matrix-style data visualization.

Example

"use client";

import { HeatmapChart } from "@databricks/appkit-ui/react";

export default function HeatmapChartExample() {
  const data = [];
  const days = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"];
  const hours = ["00:00", "04:00", "08:00", "12:00", "16:00", "20:00"];

  for (const day of days) {
    for (const hour of hours) {
      data.push({
        day,
        hour,
        count: Math.floor(Math.random() * 100),
      });
    }
  }

  return (
    <HeatmapChart
      data={data}
      xKey="day"
      yAxisKey="hour"
      yKey="count"
      height={300}
    />
  );
}

HeatmapChart

Heatmap Chart component for matrix-style data visualization.

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.

Data should be in "long format" with three fields:

  • xKey: X-axis category (columns)
  • yAxisKey: Y-axis category (rows)
  • yKey: The numeric value for each cell

Supports both query mode (queryKey + parameters) and data mode (static data).

Source: packages/appkit-ui/src/react/charts/heatmap/index.tsx

Props

PropTypeRequiredDefaultDescription
queryKeystring-Analytics query key registered with analytics plugin
parametersRecord<string, unknown>-Query parameters passed to the analytics endpoint
format"auto" | "json_array" | "arrow_stream" | "json" | "arrow""auto"Data format to use - "json_array": Use JSON format (smaller payloads, simpler) - "arrow_stream": 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
dataChartDataInput-Arrow Table or an array of row objects (interfaces and as const arrays too).
titlestring-Chart title
showLegendboolean-Show legend
colorPalette"categorical" | "sequential" | "diverging"-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
colorsstring[]-Custom colors for series (overrides colorPalette) as hex, rgb() or hsl() strings, since ECharts draws on a canvas and cannot resolve var() or parse oklch() (those draw gray); without it, series colors are the CSS variables --chart-cat-1 to --chart-cat-8 on :root (--chart-seq-* and --chart-div-* for the sequential and diverging palettes), held to the same formats.
heightnumber-Chart height in pixels. Defaults to filling its parent (see chartSizeStyle).
classNamestring-Additional CSS classes
xKeystring-X-axis field key. Auto-detected from schema if not provided.
yKeystring | string[]-Y-axis field key(s). Auto-detected from schema if not provided.
ariaLabelstring-Accessibility label for screen readers
testIdstring-Test ID for automated testing
optionsRecord<string, unknown>-Additional ECharts options to merge
valueFormatterChartValueFormatter-(value: string | number, field: string) =&gt; string. Formats measure values in the chart's built-in value axes, tooltips, and value labels. field is the corresponding yKey, so one formatter can select a different format for each series.
onDataClick((datum: ChartClickDatum) => void)-Pointer-only: charts render to <canvas>, so this does not fire for keyboard users. Provide a keyboard-accessible equivalent (e.g. a table row action) for the same action.
selectedstring | string[]-Controlled selection by category name. Matching data element(s) render at full prominence while the rest are dimmed. Drive it from your own state to reflect a cross-filter or selection. Categorical charts (bar, pie/donut) show emphasis; other chart types ignore it.
yAxisKeystring-Field key for the Y-axis categories. For heatmaps, data should have: xKey (column), yAxisKey (row), and yKey (value).
minnumber-Min value for color scale (auto-detected if not provided)
maxnumber-Max value for color scale (auto-detected if not provided)
showLabelsbooleanfalseShow value labels on cells

Usage

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

<HeatmapChart /* props */ />

Databricks Developer Hub

Ready to ship your next agentic app in minutes?

Read docs