Skip to content

Export methods for transforming and downloading SVG

License

Notifications You must be signed in to change notification settings

d3plus/d3plus-export

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

d3plus-export

Export methods for transforming and downloading SVG.

Installing

If using npm, npm install d3plus-export. Otherwise, you can download the latest release from GitHub or load from a CDN.

import modules from "d3plus-export";

d3plus-export can be loaded as a standalone library or bundled as part of D3plus. ES modules, AMD, CommonJS, and vanilla environments are supported. In vanilla, a d3plus global is exported:

<script src="https://cdn.jsdelivr.net/npm/d3plus-export@1"></script>
<script>
  console.log(d3plus);
</script>

Examples

Live examples can be found on d3plus.org, which includes a collection of example visualizations using d3plus-react. These examples are powered by the d3plus-storybook repo, and PRs are always welcome. 🍻

API Reference

  • saveElement - Downloads an HTML Element as a bitmap PNG image.

d3plus.saveElement(elem, [options], [renderOptions]) <>

Downloads an HTML Element as a bitmap PNG image.

This is a global function.

Param Type Default Description
elem HTMLElement A single element to be saved to one file.
[options] Object Additional options to specify.
[options.filename] String "download" Filename for the downloaded file, without the extension.
[options.type] String "png" File type of the saved document. Accepted values are "png" and "jpg".
[options.callback] function Function to be invoked after saving is complete.
[renderOptions] Object Custom options to be passed to the html-to-image function.

Documentation generated on Tue, 04 Apr 2023 21:45:19 GMT