All docs
V21.1
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
Box
Map
Vue
A newer version of this page is available. Switch to the current version.

export

Configures export settings.

Type:

Object

These settings are used when a diagram is exported via a UI.

The Export button invokes a drop-down menu that lists export commands. The following formats are supported: PNG, JPEG, and SVG.

fileName

Specifies the name of the file to which the diagram is exported.

Type:

String

Default Value: 'Diagram'

proxyUrl Deprecated

IMPORTANT
Since v10, Safari browser supports API for saving files, and this property is no longer required.

Specifies the URL of the server-side proxy that streams the resulting file and enables export in Safari.

Type:

String

Default Value: undefined

Safari does not implement an API for saving files. In this case, the Diagram UI component can POST the content to a server-side proxy which streams the file back to the user. To enable this functionality, set the export.proxyUrl property to the proxy.

NOTE
  • Your proxy receives a POST request with the following parameters in the request body: fileName, contentType (the MIME type of the file) and base64 (the base-64 encoded file content).
  • The proxy should return the decoded file with the "Content-Disposition" header set to attachment; filename="".