Skip to main content

ExportControlsComponentProps

Props 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:".


labelProperty?

optional labelProperty: string

The name of the property that holds the label for a vertex


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

Optional ID of the surface to attach to. It is better to nest this component inside a SurfaceComponent or SurfaceProvider.


svgOptions?

optional svgOptions: SvgExportUIOptions

Options for SVG exports.