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

Treemap Chart 3D

Signature

sp.treemap3d(title, labels=None, values=None, *, variant="basic", parents=None, comparisons=None, sort_order="none", orientation3d="iso", scene="default", theme="none", zone=None, max_points=None, bg_color="#1a1a2e", width=900, height=560, x_label="", y_label="", z_label="", **kwargs) -> Chart

Aliases: sp.build_treemap3d_chart(), sp.treemap_3d(), sp.treemap3d_chart(), sp.treemap3d_family(), sp.treemaps3d().

Description

sp.treemap3d() is the 3D twin of sp.treemap(): every one of the 9 treemap variants has a 3D form, selected with the same variant keyword and fed with the same hierarchy. Every leaf rectangle of the 2D pack becomes a block at the same footprint, so the packing algorithm (squarified, flat, or the organic voronoi layout) is never re-derived in 3D. A non-leaf container (the root, a branch group) always flattens to a thin base pad instead of standing as tall as its own leaves, so the real data never disappears under its own container. Height and colour both come from a shared hierarchy strategy also used by sunburst3D and icicle3D.

Variants

VariantAliasesUses3D form
basicdefault, classic, roundedlabels, valuesLeaf rectangles tiled edge to edge on the floor at the 2D pack’s own footprint, toned by top-level branch.
flatmosaic, edge, tiledlabels, valuesThe same tiled, branch-toned leaves as basic, from the flat-mosaic 2D pack.
outlinedoutline, stroke, wireframelabels, valuesThe same tiled leaves pressed to a much lower height, a wireframe-like reading of the tree.
gappedspaced, isolated, paddedlabels, valuesA small margin shrinks every rectangle away from its neighbours, opening a visible gap between leaves.
nestedgrouped, framed, parentlabels, values, parentsLeaf rectangles plus a thin frame plate under every parent group, so branches read as a shape of their own.
heatramp, magnitude, intensitylabels, valuesEvery leaf toned by its own value on a continuous ramp, brightest for the largest, independent of branch.
monomonochrome, single, uniformlabels, valuesEvery leaf takes the same flat tone, leaving only the footprint to read the hierarchy.
trendchange, delta, yoylabels, values, comparisonsEvery leaf toned green or red by whether its value rose or fell against comparisons.
voronoivoronoi_treemap, organic, polygon_treemap, power_diagramlabels, values, parentsThe same tiled, branch-toned leaves as basic, from the organic power-diagram 2D pack.

Data

labels name each node, values its own weight and parents the label of its parent (empty for a root, omit entirely for a flat single-level treemap). comparisons gives the prior value read by trend.

3D planes

The viewpoint is independent from the variant: orientation3d picks the initial camera plane and applies to every variant; the view always stays draggable.

orientation3d="iso" — Isometric three-quarter view (default).
orientation3d="horizontal" — Side-on view, almost at floor level.
orientation3d="vertical" — Top-down view from above.
orientation3d="front" — Front elevation, nearly flat.

3D scenes

scene swaps the environment the columns are drawn in and applies to every variant and every plane.

scene="default" — Each series keeps its own categorical palette color, rendered as shaded 3D bars on a flat grid.
scene="terrain" — The data is resampled onto a dense grid and rendered as hundreds of thin colormap-colored columns, forming a continuous mountain-of-bars terrain.
scene="tower" — The data is resampled onto a dense field of round skyscraper-like towers instead of boxes, for a city-skyline reading of magnitude.
scene="radial" — The data is resampled onto a dense polar grid of rings and wedges radiating from the center, like a 3D radar/sonar sweep of the value field.
scene="podium" — The data is resampled onto a dense grid and quantized into stepped terrace levels, like a rice-terrace contour map, to read value bands at a glance.

Themes

theme restyles the whole canvas (colour grade and glow) and applies to every variant, scene and plane.

theme="deluxe"
theme="prism"
theme="aurora"
theme="inferno"
theme="frost"
theme="glow"
theme="glass"
theme="neon"
theme="cosmic"

Auto-scaling zone

The 3D zone (floor, walls, axes and camera) scales to the elements: its length, width and height follow the extents of the drawn blocks, a minimum floor depth keeps single rows readable, wide scenes are drawn flatter and the camera frames the whole box. The axis ticks read the real data range. Pass zone=[x, y, z] to force the proportions of the box instead; the longest side is normalised to 1.

Parameters

Returns

Chart object with an .html property and a .show() method.