Skip to content

Interface: DownloadImageOptions ​

Options of chart.downloadImage / downloadImage(el, …).

Extends ​

Properties ​

PropertyModifierTypeDescriptionInherited from
filename?readonlystringFile name without extension. Default 'newplot' (Plotly's).-
format?readonlyImageFormatImage format. Default 'png'.ToImageOptions.format
height?readonlynumber | nullHeight in CSS px; see width.ToImageOptions.height
imageDataOnly?readonlybooleanResolve to the base64 data without the data:image/…;base64, prefix (Plotly).ToImageOptions.imageDataOnly
scale?readonlynumberPixels per CSS px: the image is width·scale × height·scale pixels. Default 1 (not the screen's device pixel ratio, so exports are the same on every screen).ToImageOptions.scale
transparent?readonlybooleanDrop the paper background (the default look's #0a0a0f), and the plot-area background unless the figure sets layout.plot_bgcolor itself, for an image with an alpha channel. Ignored for jpeg, which has none. Default false.ToImageOptions.transparent
width?readonlynumber | nullWidth of the exported figure in CSS px: the figure is laid out again at this size. Default (also null): the chart's current width (layout.width, else 700 for a figure object).ToImageOptions.width

Released under the MIT License.