Skip to content

Interface: ChartThree ​

Escape hatches into three.js (plan §7.2, E8.13). renderer and scene are three.js objects; the members typed by the render package (root, overlay, viewports, subplot) are experimental like that package.

Properties ​

PropertyModifierTypeDescription
overlayreadonlyViewportExperimental The overlay viewport.
rendererreadonlyWebGLRendererThe renderer that draws this chart. With config.sharedRenderer it also draws other charts, and its domElement is not this chart's canvas: use root.canvas.
rootreadonlyRenderRootExperimental The render root: render loop, viewports, resources.
scenereadonlySceneThe overlay viewport's scene (paper-space, drawn last): add custom objects here.
viewportsreadonlyreadonly Viewport[]Experimental Every viewport, in draw order.

Methods ​

subplot() ​

ts
subplot(id):
  | Viewport
  | undefined;

Experimental

The viewport of a cartesian subplot ('xy', 'x2y2').

Parameters ​

ParameterType
idstring

Returns ​

| Viewport | undefined

Released under the MIT License.