Correlogram Chart 3D
Signature
sp.correlogram3d(title, labels=None, matrix=None, *, variant="circle", 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_correlogram3d_chart(), sp.correlogram_3d(), sp.correlogram3d_chart(), sp.correlogram3d_family(), sp.correlograms3d().
Description
sp.correlogram3d() is the 3D twin of sp.correlogram(): every one of the 7 correlogram variants has the same 3D form, a grid of signed columns over the correlation matrix, one column per variable pair, rising above the floor for a positive correlation and sinking below it for a negative one. The 2D variants only change how a correlation is drawn (circle, shaded square, number, ellipse, pie slice); the matrix itself never changes, so the 3D reading is intentionally identical across every one of them.
Variants
| Variant | Aliases | Uses | 3D form |
|---|---|---|---|
circle | default, classic | labels, matrix | A signed column per variable pair: up for a positive correlation, down for a negative one. |
heatmap | heat, square | labels, matrix | The same signed grid as circle, from the 2D chart’s shaded-square layout. |
text | number, value | labels, matrix | The same signed grid as circle, from the 2D chart’s printed-number layout. |
ellipse | oval | labels, matrix | The same signed grid as circle, from the 2D chart’s tilted-ellipse layout. |
mixed | combo, both | labels, matrix | The same signed grid as circle, from the 2D chart’s split upper/lower-triangle layout. |
pie_square | pie, mixed_pie | labels, matrix | The same signed grid as circle, from the 2D chart’s pie-slice layout. |
circle_legend | legend, scale | labels, matrix | The same signed grid as circle, plus a colour-scale legend in the 2D chart. |
Data
labels names each variable and matrix is its row-major correlation matrix (values in -1..1); the diagonal reads as a perfect self-correlation.
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.