export

Configures client-side exporting.

Type:

Object

When exporting is enabled, the new 'Export to Excel file' entity is added to the context menu. You can specify exporting options using this object.

NOTE
Client-side exporting requires the JSZip library. Learn where you can get it from topics in the Installation section.

enabled

Enables client-side exporting.

Type:

Boolean

Default Value: false

fileName

Specifies a default name for the file to which grid data is exported.

Type:

String

Default Value: 'PivotGrid'

ignoreExcelErrors

Specifies whether Excel should hide warnings if there are errors in the exported document.

Type:

Boolean

Default Value: true

proxyUrl

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

Type:

String

Default Value: undefined

Generally, exporting is performed using client-side API in browsers. However, the Safari (integrated in Mac OS) browser does not implement an API for saving files. In this instance, the PivotGrid 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="".

The sample proxy implementation for ASPx-based and PHP-based web servers is presented in the Client-Side Exporting article.