Heatmap

Heatmap data Primitive

A two-dimensional grid of toned cells — rows × buckets, thresholds driving good/warn/bad tones, never colour alone (the value is IN the cell).

Layer: L1 surface · Recipe: unset — see docs/agent/pick-a-surface.md. Curriculum: AGENTS.md; pick matrix: docs/agent/pick-a-surface.md; blast radius: CONSUMER_MAP.md.

MonTueWed
API 99.9 99.7 97.2
Webhooks 96.1 89.4 99.2

Copy this

html
<div class="heatmap-region hm-measure-lg" data-heatmap>
  <div class="heatmap-scroll">
    <table class="heatmap-grid">
      <thead>
        <tr>
          <th></th>
          <th>Mon</th>
          <th>Tue</th>
          <th>Wed</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td class="heatmap-row-label">API</td>
          <td class="heatmap-cell" data-heatmap-tone="good"> 99.9 </td>
          <td class="heatmap-cell" data-heatmap-tone="good"> 99.7 </td>
          <td class="heatmap-cell" data-heatmap-tone="warn"> 97.2 </td>
        </tr>
        <tr>
          <td class="heatmap-row-label">Webhooks</td>
          <td class="heatmap-cell" data-heatmap-tone="warn"> 96.1 </td>
          <td class="heatmap-cell" data-heatmap-tone="bad"> 89.4 </td>
          <td class="heatmap-cell" data-heatmap-tone="good"> 99.2 </td>
        </tr>
      </tbody>
    </table>
  </div>
</div>

Server exchange

This Hyperpart has no server exchange — it is presentation or client chrome only. htmx does not issue a request on this part's behalf. If you put an affordance (hx-*) on a control that uses this markup, that action's exchange belongs to the action, not this part. See Swap contract for host-owned envelopes.

Swap contract

Agent-visible HTMX topology (ADR-0054 / decision 0012). exchange envelope = what the response may re-emit relative to the persistent slot (body_only | outer | none | host_owned | document). dual-lock validates part markup only — not this envelope. Stem: stems/morph-safe-hypermedia.md; decision: docs/decisions/0012-swap-identity-contract.md.

No host HTMX exchange on this part — presentation or client chrome only. exchange envelope: n/a.

If a host wraps this markup in hx-*, that host owns the swap contract (sole identity + envelope). Prefer innerMorph / outerMorph for stable slots; replacement for flash; body-only responses under inner swaps.

Envelope response examples

This part has no owned exchange (envelope n/a). If a host adds hx-*, that host’s envelope applies — typically body_only:

html
<!-- Host wraps this presentation part with hx-* (host owns envelope) -->
<!-- Prefer: hx-swap="innerMorph" hx-target="#panel-body" -->
<!-- Server returns body_only interior for #panel-body -->
<div class="dz-stack">content…</div>

Do not re-own the slot:

html
<!-- WRONG: server returns the presentation root with a new id every poll -->
<div id="heatmap-root" data-dz-region>…</div>

How to use it

No extended guidance authored yet — start from Copy this and the dependency chips (Primitive = markup only; controller = load listed JS; Endpoint = implement Server exchange).

Seams

  • copy the partial under Copy this; keep root class and data-* modifiers so the CSS/JS bundle matches
  • no Server exchange on this part — pure presentation or client chrome
  • satisfy the DOM contract tables (CI stop-ship)

DOM contract

What the emitted HTML must satisfy — the table is the required surface; Python under contracts/ is the package-internal dual-lock CI runs (tests/test_contracts.py), not an app route. Standalone HTMX4: implement the API so responses match this markup. Dazzle: the agent emits SSR that already satisfies it. Do not invent attrs outside these tables. For request/response wiring see Server exchange.

contracts/heatmap.py

Required in the DOM: root [data-heatmap] (part heatmap). Emit only these attributes — inventing extras is fine only if controllers ignore them; omitting required ones fails CI (tests/test_contracts.py).

NodeAttrConstraint
[data-heatmap]data-heatmappresent (any value)

Ingestion model HeatmapRow

Server-side shape before render — one normalisation boundary for producers.

FieldTypeRequired
labelstringrequired
cellsarrayoptional

Exemplar render()

Executable in CI: the Python below is render(); the boxed preview is render(EXEMPLARS[0]) — the first fixture the dual-lock tests emit, not a separate widget and not gallery mock data.

python
def render(h: Heatmap) -> str:
    """Model → heatmap region."""
    if not h.rows:
        return (
            f'<div class="dz-heatmap-region" data-dz-heatmap>'
            f'<p class="dz-empty-dense" role="status">'
            f"{html.escape(h.empty_message)}</p>"
            f"</div>"
        )

    head_cols = "".join(f"<th>{html.escape(c)}</th>" for c in h.columns)
    thead = f"<thead><tr><th></th>{head_cols}</tr></thead>"
    body_rows: list[str] = []
    for row in h.rows:
        cells_html = ""
        for cell in row.cells:
            cells_html += (
                f'<td class="dz-heatmap-cell"{_tone_attr(cell, h.thresholds)}> {cell:.1f} </td>'
            )
        body_rows.append(
            f'<tr><td class="dz-heatmap-row-label">{html.escape(row.label)}</td>{cells_html}</tr>'
        )
    tbody = f"<tbody>{''.join(body_rows)}</tbody>"
    overflow_html = ""
    if h.total > len(h.rows):
        overflow_html = f'<p class="dz-heatmap-overflow">Showing {len(h.rows)} of {h.total}</p>'
    return (
        f'<div class="dz-heatmap-region" data-dz-heatmap>'
        f'<div class="dz-heatmap-scroll">'
        f'<table class="dz-heatmap-grid">{thead}{tbody}</table>'
        f"</div>"
        f"{overflow_html}"
        f"</div>"
    )

Live output of render(EXEMPLARS[0]) — fixture markup the dual-lock validates (sample field values only).

MonTueWed
API 99.9 99.7 97.2
Webhooks 96.1 89.4 99.2

Notes

Dual-lock root is data-heatmap (contracts/heatmap.py). Cell tones ride data-heatmap-tone="good|warn|bad", resolved server-side against the declared thresholds — and the numeric value always renders inside the cell, so tone is reinforcement, not the only signal. Overflowing grids append a heatmap-overflow count line; the scroll wrapper keeps wide grids inside their card.

Source files

Canonical registration in the registry. No dedicated controller — CSS for this part lives in the layered bundle.

site/registry.py · contracts/heatmap.py