Sankey Chart 3D
Signature
sp.sankey3d(title, labels=None, edges_i=None, edges_j=None, edges_w=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_sankey3d_chart(), sp.sankey_3d(), sp.sankey3d_chart(), sp.sankey3d_family(), sp.sankeys3d().
Description
sp.sankey3d() is the 3D twin of sp.sankey(): all 8 sankey variants share the same 3D form, selected with the same variant keyword and fed with the same flow. Every node stands as a column at its layered layer/stack position, height following its total flow; every edge is a thin ribbon running from its source’s column to its target’s, thickness and tone following its own weight against the flow’s peak.
Variants
| Variant | Aliases | Uses | 3D form |
|---|---|---|---|
basic | default, classic | labels, edges_i, edges_j, edges_w | One column per node, one weighted ribbon per link. |
gapped | spaced, separated | labels, edges_i, edges_j, edges_w | The same layout as basic, from the 2D chart’s wider node spacing. |
ribbon | wide, thick | labels, edges_i, edges_j, edges_w | The same layout as basic with visibly thicker ribbons. |
minimal | thin, outline | labels, edges_i, edges_j, edges_w | The same layout as basic with thin, understated ribbons. |
sorted | reordered, by_flow, ranked | labels, edges_i, edges_j, edges_w | The same nodes reordered within each layer by their own total flow. |
hourglass | radiant_flow, nutrient_flow, braided, flow_bloom | labels, edges_i, edges_j, edges_w | The same layout as basic, fed by the 2D chart’s radiant hub-and-spoke flow. |
matrix | mosaic, dot_matrix, grid_flow, big_data | labels, edges_i, edges_j, edges_w | The same layout as basic, fed by the 2D chart’s dense grid-of-flows data. |
beacon | flight_radar, route_wheel, departure_board, hub_wheel | labels, edges_i, edges_j, edges_w | The same layout as basic, fed by the 2D chart’s hub-and-route flow. |
Data
labels names each node, edges_i/edges_j give the source/target node index of every link and edges_w its weight.
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.