Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Heatmap

Signature

sp.heatmap(title, labels=None, values=None, *, variant="basic", col_labels=None, **kwargs) -> Chart

Description

sp.heatmap() is the unified entry point for the entire heatmap family. The variant keyword selects the rendering strategy — every other argument stays consistent across variants. Cell colors are computed in pure Rust, no NumPy required. The matrix is passed as a flat list of length len(labels) * len(col_labels) (row-major).

Variants

Parameters

Returns

Chart — object with .html property and .show() method.

Variant "basic"Required labels, col_labels, valuesReturns Chart
Preview
Variant "annotated"Required labels, col_labels, valuesReturns Chart
Preview
Variant "categorical"Required labels, col_labels, values, paletteReturns Chart
Preview
Variant "unequal" / "variable"Required labels, col_labels, values, widths, rangesReturns Chart
Preview
Variant "log" / "log_scale"Required labels, col_labels, valuesReturns Chart
Preview
Variant "discrete" / "binned"Required labels, col_labels, values, binsReturns Chart
Preview
Variant "correlation" / "corr"Required labels, col_labels, valuesReturns Chart
Preview
Variant "density" / "imshow"Required labels, col_labels, valuesReturns Chart
Preview
Variant "contour"Required labels, col_labels, valuesReturns Chart
Preview
Variant "temporal" / "calendar"Required labels, col_labels, valuesReturns Chart
Preview
Variant "cluster" / "clustermap" / "dendrogram"Required labels, col_labels, valuesReturns Chart

Rows and columns are reordered by average-linkage hierarchical clustering (Euclidean distance on each row/column vector) so similar rows/columns sit next to each other, and the merge tree is drawn as a real dendrogram in the left and top margins — seaborn's clustermap / structured_heatmap look, fully native.

Preview
Variant "bubble" / "punchcard"Required labels, col_labels, valuesReturns Chart
Preview
Variant "marginal" / "with_marginals"Required labels, col_labels, valuesReturns Chart
Preview
Variant "confusion" / "confusion_matrix"Required labels, col_labels, valuesReturns Chart
Preview
Variant "pivot" / "pivot_table"Required labels, col_labels, valuesReturns Chart
Preview
Variant "polar" / "wheel" / "clock" / "carbon_wheel"Required labels, col_labels, valuesReturns Chart
Preview