Skip to content

Heatmap

Prints a labelled grayscale matrix. Use null for cells that should remain blank.

Every row must have the same number of values, with no more than 31 values per row and 256 cells in total. The number of labels must match the number of columns.

Example

{
  "type": "heatmap",
  "labels": [
    "Mon",
    "Tue",
    "Wed"
  ],
  "values": [
    [
      null,
      3,
      1
    ],
    [
      0,
      3,
      2
    ]
  ]
}

Fields

FieldTypeDescription
typerequired"heatmap"

Discriminator for heatmap blocks.

labelsrequiredarray<string>

Labels for the heatmap columns.

  • Minimum items: 1
  • Maximum items: 31
valuesrequiredarray<array<number | null>>

Rows of non-negative values. Rows must have equal lengths and 1 to 31 values each; the complete heatmap may contain at most 256 cells. Use null for a blank cell.

  • Minimum items: 1
  • Maximum items: 16