Skip to main content

ExportControlsComponentProps

Options for the ExportControlsComponent

Properties​

allowJpgExport?​

optional allowJpgExport: boolean

Defaults to true.


allowPngExport?​

optional allowPngExport: boolean

Defaults to true.


allowSvgExport?​

optional allowSvgExport: boolean

Defaults to true.


imageOptions?​

optional imageOptions: ImageExportUIOptions

Options for image exports.


label?​

optional label: string

What to show in the label, if visible. Defaults to "Export:".


margins?​

optional margins: PointXY

Optional margins to apply to both SVG and image exports. Will not override any margins specified in svgOptions or imageOptions.


showLabel?​

optional showLabel: boolean

Whether or not to show a label in front of the buttons. Defaults to true.


surfaceId?​

optional surfaceId: string

The ID of surface to attach to. Optional, and likely to be deprecated in a future release. The component is context aware and will try to resolve the Surface/Paper to attach to from an ancestor SurfaceProvider SurfaceComponent or PaperComponent.


svgOptions?​

optional svgOptions: SvgExportUIOptions

Options for SVG exports.