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

Histogram Chart 3D

Signature

sp.histogram3d(title, values=None, *, variant="basic", bins=0, overlay=None, color_groups=None, series_names=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_histogram3d_chart(), sp.histogram_3d(), sp.histogram3d_chart(), sp.hist3d().

Description

sp.histogram3d() is the 3D twin of sp.histogram(): every one of the 7 histogram variants has a 3D form, selected with the same variant keyword and binned by the same rule as the 2D chart. Columns, stacks, side-by-side rows and plates come from the shared column strategies, so geometry is never hand-written per variant.

Variants

VariantAliasesUses3D form
basicsimple, default, verticalvalues, binsOne column per bin; height is the sample count.
horizontalh, barh, hbarvalues, binsThe basic layout turned a quarter-turn: bins run along the depth axis.
normalizedprobability, density, norm, pdfvalues, binsHeights are probability densities, so the columns integrate to one.
cumulativecdf, cumvalues, binsHeights accumulate from the first bin to the last, ending at the sample count.
stackedstack, stack_byvalues, color_groupsEach bin stacks one segment per color_groups category.
overlayoverlapping, compare, abvalues, overlay, series_namesA second sample set (overlay) drawn as a parallel row beside the first.
stepoutline, stairvalues, binsOnly the top of every bin as a thin plate, giving the outlined staircase look.

Data

values are the raw samples and bins the bin count (0 picks it automatically). color_groups splits the samples into stacked groups and overlay adds a second sample set drawn beside the first.

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.