Vue VectorMap - export

Configures the exporting and printing features.

Type:

Object

These features allow a user to export your widget into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the widget. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

NOTE
IE9 and Safari on Mac OS do not implement an API for saving files. Therefore, exporting in these browsers requires setting up a server-side proxy. For details, refer to the proxyUrl option description.
See Also

Watch Video

backgroundColor

Specifies the color that will fill transparent regions in the resulting file or document.

Type:

String

Default Value: '#ffffff'

This option supports the following colors:

enabled

Enables the client-side exporting in the widget.

Type:

Boolean

Default Value: false

fileName

Specifies a default name for the file to which the widget will be exported.

Type:

String

Default Value: 'file'

formats

Specifies a set of formats available for exporting into.

Type:

Array<String>

Default Value: ['PNG', 'PDF', 'JPEG', 'SVG', 'GIF']

By default, a user can export the widget into five formats: PNG, PDF, JPEG, SVG and GIF. If you need to alter this set, assign an array of the required formats to this option.

printingEnabled

Enables the printing feature in the widget. Applies only if the export.enabled option is true.

Type:

Boolean

Default Value: true

When printing is enabled, the export menu contains an item that invokes the Print window of the user's browser. It lets the user to select preferred printing options and to send the print job to the printer.

proxyUrl

Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable exporting in IE9 and Safari browsers.

Type:

String

Default Value: undefined

Generally, exporting is performed using client-side API in browsers. However, the IE9 and Safari (integrated in Mac OS) browsers do not implement an API for saving files. In this instance, the widget can POST the content to a server-side proxy, which will stream the file back to the end user. To enable this functionality, set the export.proxyUrl option to the proxy, which will stream the file to the end user. When implementing the proxy, take the following information into account.

  • Your proxy will receive 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="".
See Also