d3-svg-to-png

d3-svg-to-png

Converts SVG elements in the browser to PNG and other image formats, while keeping CSS styles. Optionally, it returns the data as a promise or downloads it. It can also rescale the svg image, ignore certain DOM elements...

Installation

$ npm i d3-svg-to-png

Usage

const d3ToPng = require('d3-svg-to-png');
d3ToPng('selector', 'name');

Mandatory fields

• Selector (String): Commonly 'svg' or DOM Element.
• Name (String): Name for the file output, without extension.

Output: name.png

Options

const d3ToPng = require('d3-svg-to-png');
d3ToPng('svg', 'name', {
  scale: 3,
  format: 'webp',
  quality: 0.01,
  download: false,
  ignore: '.ignored',
  background: 'white'
}).then(fileData => {
  //do something with the data
});

• scale (number): Rescale the image by this factor. Default: 1
• format (string): The format to output to. Compatibility might vary between browsers. See HTMLCanvasElement.toDataURL() . Default: png
• quality (number): Between 0 (lowest) and 1. Affects formats with compression, like jpg. Default: .92
• download (boolean): Whether to download the resulting image. Default: true
• ignore (string): A CSS selector that, the matched elements of which will not be added to the output. Default: null
• background (string): A style to be added to the svg element. The value will be added as the background shorthand css property, so it can be a single color, an image a gradient or any thing that is a valid background. Default: null

Notes

Please report any problem, as this has not been thoroughly tested and could be improved. This module works outside of D3. It was created for the GoPro Telemetry Extractor

Contribution

Please make your changes to the dev branch, so that automated tests can be run before merging to master. Also, if possible, provide tests for new functionality.

TODO

• Add tests and continuous integration
• Test on multiple browsers

More creative coding

If you liked this you might like some of my app prototyping.

Acknowledgements/credits

• Juan Irache - Main developer
• Thành Trang - Contributor
• dwiesner - Contributor