## ChartJSNodeCanvas **Kind**: global class * [ChartJSNodeCanvas](#ChartJSNodeCanvas) * [new ChartJSNodeCanvas(options)](#new_ChartJSNodeCanvas_new) * [.renderToDataURL(configuration, mimeType)](#ChartJSNodeCanvas+renderToDataURL) * [.renderToDataURLSync(configuration, mimeType)](#ChartJSNodeCanvas+renderToDataURLSync) * [.renderToBuffer(configuration, mimeType)](#ChartJSNodeCanvas+renderToBuffer) * [.renderToBufferSync(configuration, mimeType)](#ChartJSNodeCanvas+renderToBufferSync) * [.renderToStream(configuration, mimeType)](#ChartJSNodeCanvas+renderToStream) * [.registerFont(path, options)](#ChartJSNodeCanvas+registerFont) ### new ChartJSNodeCanvas(options) Create a new instance of CanvasRenderService. | Param | Description | | --- | --- | | options | Configuration for this instance | ### chartJSNodeCanvas.renderToDataURL(configuration, mimeType) Render to a data url. **Kind**: instance method of [ChartJSNodeCanvas](#ChartJSNodeCanvas) **See**: https://github.com/Automattic/node-canvas#canvastodataurl | Param | Default | Description | | --- | --- | --- | | configuration | | The Chart JS configuration for the chart to render. | | mimeType | image/png | The image format, `image/png` or `image/jpeg`. | ### chartJSNodeCanvas.renderToDataURLSync(configuration, mimeType) Render to a data url synchronously. **Kind**: instance method of [ChartJSNodeCanvas](#ChartJSNodeCanvas) **See**: https://github.com/Automattic/node-canvas#canvastodataurl | Param | Default | Description | | --- | --- | --- | | configuration | | The Chart JS configuration for the chart to render. | | mimeType | image/png | The image format, `image/png` or `image/jpeg`. | ### chartJSNodeCanvas.renderToBuffer(configuration, mimeType) Render to a buffer. **Kind**: instance method of [ChartJSNodeCanvas](#ChartJSNodeCanvas) **See**: https://github.com/Automattic/node-canvas#canvastobuffer | Param | Default | Description | | --- | --- | --- | | configuration | | The Chart JS configuration for the chart to render. | | mimeType | image/png | A string indicating the image format. Valid options are `image/png`, `image/jpeg` (if node-canvas was built with JPEG support) or `raw` (unencoded ARGB32 data in native-endian byte order, top-to-bottom). Defaults to `image/png` for image canvases, or the corresponding type for PDF or SVG canvas. | ### chartJSNodeCanvas.renderToBufferSync(configuration, mimeType) Render to a buffer synchronously. **Kind**: instance method of [ChartJSNodeCanvas](#ChartJSNodeCanvas) **See**: https://github.com/Automattic/node-canvas#canvastobuffer | Param | Default | Description | | --- | --- | --- | | configuration | | The Chart JS configuration for the chart to render. | | mimeType | image/png | A string indicating the image format. Valid options are `image/png`, `image/jpeg` (if node-canvas was built with JPEG support), `raw` (unencoded ARGB32 data in native-endian byte order, top-to-bottom), `application/pdf` (for PDF canvases) and image/svg+xml (for SVG canvases). Defaults to `image/png` for image canvases, or the corresponding type for PDF or SVG canvas. | ### chartJSNodeCanvas.renderToStream(configuration, mimeType) Render to a stream. **Kind**: instance method of [ChartJSNodeCanvas](#ChartJSNodeCanvas) **See**: https://github.com/Automattic/node-canvas#canvascreatepngstream | Param | Default | Description | | --- | --- | --- | | configuration | | The Chart JS configuration for the chart to render. | | mimeType | image/png | A string indicating the image format. Valid options are `image/png`, `image/jpeg` (if node-canvas was built with JPEG support), `application/pdf` (for PDF canvases) and image/svg+xml (for SVG canvases). Defaults to `image/png` for image canvases, or the corresponding type for PDF or SVG canvas. | ### chartJSNodeCanvas.registerFont(path, options) Use to register the font with Canvas to use a font file that is not installed as a system font, this must be done before the Canvas is created. **Kind**: instance method of [ChartJSNodeCanvas](#ChartJSNodeCanvas) | Param | Description | | --- | --- | | path | The path to the font file. | | options | The font options. | **Example** ```js registerFont('comicsans.ttf', { family: 'Comic Sans' }); ```