A newer version of this page is available. Switch to the current version.

JavaScript/jQuery Diagram - 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="".