Renderer

The Renderer class is in charge of rendering graphical objects to a webpage. To create a renderer, use the renderer function:

let r = atlas.renderer("svg", "domId");

Properties

propertyexplanationtypedefault value
typerenderer type, possible values: “svg”, “canvas”, or “webgl”String
domIdDOM ID of the SVG or Canvas element on which this renderer operates onString

Methods

methodexplanationreturn type
render(scene, params)renders the specified scene
scene (Scene): a scene to be rendered
params (Object, optional): contains one or more of the following parameters:
  • collectionBounds (Boolean): draws the bounds of collections, defaults to false
void