heatmap — 6.0.0

type HeatmapSpec = HeatmapBaseSpec & (Readonly<{
  /** Matrix of categorical values; `null` reserves an empty cell. */
  data: readonly (readonly HeatmapValue[])[];
  /** Exact visual mapping for categorical or already-binned values. */
  levels: readonly HeatmapLevel[];
  threshold?: never;
}> | Readonly<{
  /** Matrix of finite numeric values; `null` reserves an empty cell. */
  data: readonly (readonly (number | null)[])[];
  levels?: never;
  /** Binary visual mapping for raw numeric values. */
  threshold: HeatmapThreshold;
}>);

type HeatmapLevel = Readonly<{
  /** Exact non-null cell value matched by this level. */
  value: Exclude<HeatmapValue, null>;
  /** One-column glyph. Defaults to the heatmap cell symbol. */
  symbol?: string;
  /** ANSI color applied to matching cells and their legend marker. */
  color?: Color;
  /** Legend text. Defaults to the string form of `value`. */
  label?: string;
}>;

type HeatmapThreshold = Readonly<{
  /** Finite comparison value. */
  value: number;
  /** ANSI color used for cells below the threshold. */
  belowColor: Color;
  /** Color used when a cell value equals or exceeds the threshold. */
  aboveColor: Color;
  /** One-column glyph used below the threshold. */
  belowSymbol?: string;
  /** One-column glyph used at or above the threshold. */
  aboveSymbol?: string;
  /** Legend text for values below the threshold. */
  belowLabel?: string;
  /** Legend text for values at or above the threshold. */
  aboveLabel?: string;
}>;

type HeatmapSymbols = Readonly<{
  /** Default one-column categorical cell glyph. */
  cell?: string;
  /** Default one-column glyph for values below a threshold. */
  belowThreshold?: string;
  /** Default one-column glyph for values at or above a threshold. */
  aboveThreshold?: string;
  /** One-column glyph used for `null`. */
  empty?: string;
  /** Display-safe text inserted between cells. */
  gap?: string;
}>;