vega-canvas

vega-canvas

Canvas and Image object instantiation utilities. Creates an HTML5 Canvas, using either the web browser DOM or a node-canvas library.

This package attempts three forms of canvas creation, in this order:

• If in a browser environment, use DOM methods to create a new canvas.
• If the node-canvas library is present, use that.
• Otherwise, return null.

To ensure error-free build processes for client-side code, this module does not include any direct or optional dependencies on the node-canvas library. Projects that use this pacakge and require canvas support for server-side (node.js) operations must include a canvas dependency in their own package.json file.

API Reference

# vega.canvas([width, height, type]) <>

Creates a new Canvas instance, with an optional width and height (in pixels). If width and height are omitted, creates a 0 x 0 canvas. The optional type parameter is a node-canvas type parameter to enable PDF or SVG output modes; this parameter is applied only if node-canvas is used. This method first attempts to create a canvas using the DOM document.createElement method. If that fails, the method then attempts to instantiate a canvas using the node-canvas library. If that also fails, returns null.

# vega.domCanvas([width, height]) <>

Creates a new Canvas instance, with an optional width and height (in pixels). If width and height are omitted, creates a 0 x 0 canvas. This method first attempts to create a canvas using the DOM document.createElement method. If that fails, returns null.

# vega.nodeCanvas([width, height, type]) <>

Creates a new Canvas instance, with an optional width and height (in pixels). If width and height are omitted, creates a 0 x 0 canvas. The optional type parameter is a node-canvas type parameter to enable PDF or SVG output modes. This method attempts to instantiate a canvas using using the node-canvas library. If that fails, returns null. This method is not exported in browser-only builds.

# vega.image() <>

Returns a reference to the Image constructor. In a web browser environment, simply returns the built-in Image object. Otherwise, attempts to return the Image instance exported by a node canvas library. If all attempts to find a canvas library fail, returns null.