Skip to main content

Heatmap Spec

Defines a word cloud chart.

Overview​

Compatible Specs​

Heatmap is a standalone spec and cannot be combined with other specs except for supported global specs.

warning

The Heatmap spec is NOT compatible with the Axis spec, it currently uses it's own internal axis implentation. The only axis controls are listed in the Props below.

Overrides​

  • specType -> SpecType.Series
  • chartType -> ChartType.Heatmap

Props​

All props can be found via HeatmapProps type.

Spec Props​

Inherits Spec props

data​

  • Type: data: D[]

colorScale​

  • Type: colorScale: HeatmapBandsColorScale

xAccessor​

  • Type: xAccessor: Accessor<D> | AccessorFn<D>
  • Default: (d) => d?.x

yAccessor​

  • Type: yAccessor: Accessor<D> | AccessorFn<D>
  • Default: (d) => d?.y

valueAccessor​

  • Type: valueAccessor: Accessor<never> | AccessorFn
  • Default: ({ value }) => value

valueFormatter​

  • Type: valueFormatter: ValueFormatter
  • Default: (value) => ${value}

xSortPredicate​

  • Type: xSortPredicate: Predicate
  • Default: Predicate.AlphaAsc

ySortPredicate​

  • Type: ySortPredicate: Predicate
  • Default: Predicate.AlphaAsc

xScale​

  • Type: xScale: RasterTimeScale | OrdinalScale | LinearScale
  • Default: { type: X_SCALE_DEFAULT.type }

highlightedData​

  • Type: highlightedData?: HeatmapHighlightedData

name​

  • Type: name?: string

timeZone​

  • Type: timeZone: string
  • Default: 'UTC'

xAxisTitle​

  • Type: xAxisTitle: string
  • Default: ''

xAxisLabelName​

  • Type: xAxisLabelName: string
  • Default: 'X Value'

xAxisLabelFormatter​

  • Type: xAxisLabelFormatter: LabelAccessor<string | number>
  • Default: String

yAxisTitle​

  • Type: yAxisTitle: string
  • Default: ''

yAxisLabelName​

  • Type: yAxisLabelName: string
  • Default: 'Y Value'

yAxisLabelFormatter​

  • Type: yAxisLabelFormatter: LabelAccessor<string | number>
  • Default: String