Waterfall Chart 3D
Signature
sp.waterfall3d(title, labels=None, values=None, *, variant="basic", sort_order="none", orientation3d="iso", scene="default", theme="none", bg_color="#1a1a2e", width=900, height=560, x_label="", y_label="", z_label="", **kwargs) -> Chart
Aliases: sp.build_waterfall3d_chart(), sp.waterfall_3d(), sp.waterfall3d_chart().
Description
sp.waterfall3d() is the 3D twin of sp.waterfall(): every one of the 7 waterfall variants has a 3D form, selected with the same variant keyword and fed with the same labels and deltas. Floating bars, stems, arrow tips and running-total tracks come from shared step strategies, so geometry is never hand-written per variant. Colour encodes the step: green for a rise, red for a fall, yellow for a total.
Variants
| Variant | Aliases | Uses | 3D form |
|---|---|---|---|
basic | default, classic, bars | labels, values | One floating bar per step between the running total before and after it; totals stand from the floor. |
stepped | step, staircase, stairs | labels, values | Bars widened until they touch, so the steps read as a continuous staircase. |
lollipop | stick, popsicle, lolly | labels, values | A thin stem across each step topped by a head cube at the new running total. |
arrowed | arrow, directional, tipped | labels, values | Floating bars with a small tip beyond the new total, pointing up for a rise and down for a fall. |
delta | percent, annotated, pct | labels, values | Tones graded by the size of the change, so big moves stand out from small ones. |
horizontal | rows, sideways, h | labels, values | The basic layout turned a quarter-turn: steps run along the depth axis. |
trend | running_total, cumulative_line, with_trend | labels, values | Floating bars plus a running-total track laid beside them. |
Data
labels name each step and values are the deltas. A label containing total, net or final is drawn as a total from the floor to the running sum, 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.