ImageExportUIOptions

Options for an ImageExportUI

Name	Type	Description
dimensions?	Array<{   height:number,   width:number }>	Optional list of dimensions
downloadButtonLabel?	string	Optional label to use on the download button. Defaults to "Download".
filename?	string	Optional filename to use - defaults to visuallyjs-export. You do not need to provide the extension.
height?	number	Optional height for the export. The exported image's aspect ratio will always be honoured so if you provide both this and width, this will be ignored. If you don't provide this the natural height of the underlying SVG will be used.
margins?	PointXY	Optional margin to set around the content. Defaults to 50px in x and y
onDimensionsChanged?	(width:number, height:number, url:string) => any	Optional function to invoke when the user changes the selected dimensions.
onShow?	(el:Element, width:number, height:number, url:string) => any	Optional function to invoke after the UI has been displayed.
quality?	number	Optional quality of the resulting image - only used for jpeg. Defaults to 1.0.
showGrid?	boolean	Whether or not to show the grid in the export (the UI itself has to be showing a grid for the export to have one). Defaults to true.
style?	string | Record<string,any>	Optional style to set in a style element in the SVG header. You can provide the CSS for the style element as a string, or you can provide a JS object.
type?	string	Content type for the export. Defaults to image/png. Most modern browsers also support image/jpeg.
width?	number	Optional width for the export. The exported image's aspect ratio will always be honoured so if you provide both this and height, height will be ignored. If you don't provide this the natural width of the underlying SVG will be used.