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

Arc Diagram 3D

Signature

sp.arc_diagram3d(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=500, x_label="", y_label="", z_label="", **kwargs) -> Chart

Aliases: sp.build_arc_diagram3d_chart(), sp.arc_diagram_3d(), sp.arc_diagram3d_chart(), sp.arc_diagram3d_family(), sp.linear_network3d().

Description

sp.arc_diagram3d() is the 3D twin of sp.arc_diagram(): all 5 arc-diagram variants share the same 3D form, selected with the same variant keyword and fed with the same edges. Every node sits as a small marker along a single line; every edge rises as an arc above (or, for bilateral, alternately above and below) the line, its apex height carrying the same read as the 2D chart’s own arc height.

Variants

VariantAliasesUses3D form
basicdefault, classiclabels, edges_i, edges_j, edges_wOne marker per node on a line, one arc per edge above it.
bilateralboth, duallabels, edges_i, edges_j, edges_wThe same line with arcs alternating above and below it.
weightedwidth, valuelabels, edges_i, edges_j, edges_wThe same arcs, thickness scaling with edges_w.
minimalthin, cleanlabels, edges_i, edges_j, edges_wThe same arcs, thin and understated.
directedarrows, flow, dependencylabels, edges_i, edges_j, edges_wThe same arcs as basic; the source end reads from the marker order along the line.

Data

labels names each node in line order, edges_i/edges_j give the source/target node index of every arc 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.