Candlestick Chart 3D
Signature
sp.candlestick3d(title, labels=None, open=None, high=None, low=None, close=None, *, variant="basic", volume=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_candlestick3d_chart(), sp.candlestick_3d(), sp.candlestick3d_chart(), sp.ohlc3d().
Description
sp.candlestick3d() is the 3D twin of sp.candlestick(): every one of the 11 candlestick variants has a 3D form, selected with the same variant keyword and fed with the same quotes. Candles, ticks, ranges, tracks, areas and volume rows are drawn by shared OHLC strategies, so geometry is never hand-written per variant. Colour encodes direction: green when the close is above the open, red when it is below.
Variants
| Variant | Aliases | Uses | 3D form |
|---|---|---|---|
basic | default, classic, filled | labels, open, high, low, close | One filled body per bar between open and close, with a thin wick from low to high; green up, red down. |
hollow | empty, japanese, white_up | labels, open, high, low, close | Same candles with the up bodies softened (hollow look) while down bodies stay solid. |
ohlc | western, bar, tick | labels, open, high, low, close | Western OHLC bars: a stem from low to high with an open tick on the left and a close tick on the right. |
heikin | heikin_ashi, ha, smoothed | labels, open, high, low, close | Heikin-Ashi candles: the quotes are smoothed by the same averaging as the 2D chart before being drawn. |
outlined | outline, stroke, wireframe | labels, open, high, low, close | Slimmer bodies with heavier wicks, giving the outlined wireframe look. |
line | close, lineplot, trend | labels, open, high, low, close | The close series as a stepped track: every segment spans from one close to the next. |
mountain | area, filled_area, shade | labels, open, high, low, close | The close series as an area of columns rising from the price floor, coloured by height. |
range | hl, highlow, spread | labels, open, high, low, close | One thick stem per bar from the low to the high, coloured by direction. |
volume | crypto, with_volume, trading | labels, open, high, low, close, volume | Candles plus a second row of volume columns behind them, scaled to the traded peak. |
milestone | milestones, story, narrative, highlight_reel | labels, open, high, low, close | Candles plus a marker above the highest high and below the lowest low. |
indicators | multi_ma, moving_averages, technical, grafana | labels, open, high, low, close | Candles plus two moving-average tracks (short and long window) laid in front of them. |
Data
labels name each bar; open, high, low and close are the quotes. The volume variant also reads volume. The older three-bar candlestick3d call keeps working.
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.