Circle Pack Chart 3D
Signature
sp.circle_pack3d(title, labels=None, parents=None, values=None, *, variant="basic", 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_circle_pack3d_chart(), sp.circle_pack_3d(), sp.circle_pack3d_chart(), sp.circle_pack3d_family(), sp.circlepacks3d().
Description
sp.circle_pack3d() is the 3D twin of sp.circle_pack(): every one of the 7 circle-pack variants has a 3D form, selected with the same variant keyword and fed with the same hierarchy. Every circle of the 2D pack becomes a cylinder at the same centre and radius. A non-leaf container circle (the root, a branch) always flattens to a thin base pad instead of standing as tall as its own children, so a big root never swallows the smaller leaves under it; leaf_focus goes further and drops containers from the scene entirely. Up to NODE_CAP circles are kept, the largest first.
Variants
| Variant | Aliases | Uses | 3D form |
|---|---|---|---|
basic | default, classic | labels, parents, values | Circles packed and stacked as cylinders at the pack’s own position; containers flatten to a thin base so the real leaves stand out on top. |
flat | single, packed | labels, parents, values | The same packed cylinders all pressed to one thin height, a flat schematic reading of the pack. |
outlined | outline, stroke | labels, parents, values | The same flattened packed cylinders as flat, from the outlined 2D pack. |
bubble | bubbles, plain | labels, parents, values | The same packed-with-flattened-containers treatment as basic, from the plain bubble 2D pack. |
leaf_focus | leaves, leaves_only, focus | labels, parents, values | Only the true leaves are drawn, each a full-height cylinder at its packed position; every container circle is dropped. |
swarm | commit_swarm, commit_history, dev_swarm, orca | labels, parents, values | The same packed-with-flattened-containers treatment as basic, from the commit-swarm styled 2D pack. |
matrix | grid, swarm_matrix, category_grid, space_wars | labels, parents, values | Only the leaves, moved off their packed position onto a uniform square grid, each cylinder still sized by its value. |
Data
labels name each node, parents gives the label of its parent (empty or omitted for a root/flat pack) and values its own weight, exactly like the 2D chart.
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.