ExportDataAsync Method

Overloads

ExportDataAsync(NxExportFileType, String, String, NxExportState, Boolean)

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.

* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

* 1000 to export to a CSV file

Default limitations in number of cells

The default maximum number of cells in the export file is:

* 5000000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

ExportDataAsync(AsyncHandle, NxExportFileType, String, String, NxExportState, Boolean)

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.

* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

* 1000 to export to a CSV file

Default limitations in number of cells

The default maximum number of cells in the export file is:

* 5000000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

ExportDataAsync<T>(AsyncHandle, Func<Response, T>, NxExportFileType, String, String, NxExportState, Boolean)

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.

* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

* 1000 to export to a CSV file

Default limitations in number of cells

The default maximum number of cells in the export file is:

* 5000000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

ExportDataAsync(NxExportFileType, String, String, NxExportState, Boolean)

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.
16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.
1000 to export to a CSV file
5000000 to export to a CSV file

Default limitation in number of columns

The default maximum number of columns in the export file is:

Default limitations in number of cells

The default maximum number of cells in the export file is:

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Declaration

      Task<ExportDataResult> ExportDataAsync([QixName("qFileType")] NxExportFileType fileType, [QixName("qPath")] string path = null, [QixName("qFileName")] string fileName = null, [QixName("qExportState")] NxExportState exportState = NxExportState.EXPORT_ALL, [QixName("qServeOnce")] bool serveOnce = false)

Parameters

Type	Name	Description
NxExportFileType	fileType	Type of the file to export.
System.String	path	Path to the definition of the object to be exported. For example, `/qHyperCubeDef` . This parameter is mandatory if the file type is `CSV_C` or `CSV_T` .
System.String	fileName	Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.
NxExportState	exportState	Defines the values to be exported. The default value is A.
System.Boolean	serveOnce	If the exported file should be served only once This parameter is optional and only used in Qlik Sense Enterprise (Windows) Default value: false

Returns

Type	Description
System.Threading.Tasks.Task<ExportDataResult>

Remarks

ExportData method is not supported in SaaS Editions of Qlik Sense.

ExportDataAsync(AsyncHandle, NxExportFileType, String, String, NxExportState, Boolean)

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.
16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.
1000 to export to a CSV file
5000000 to export to a CSV file

Default limitation in number of columns

The default maximum number of columns in the export file is:

Default limitations in number of cells

The default maximum number of cells in the export file is:

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Declaration

      Task<ExportDataResult> ExportDataAsync(AsyncHandle asyncHandle, [QixName("qFileType")] NxExportFileType fileType, [QixName("qPath")] string path = null, [QixName("qFileName")] string fileName = null, [QixName("qExportState")] NxExportState exportState = NxExportState.EXPORT_ALL, [QixName("qServeOnce")] bool serveOnce = false)

Parameters

Type	Name	Description
AsyncHandle	asyncHandle	Handle to asynchronous method request
NxExportFileType	fileType	Type of the file to export.
System.String	path	Path to the definition of the object to be exported. For example, `/qHyperCubeDef` . This parameter is mandatory if the file type is `CSV_C` or `CSV_T` .
System.String	fileName	Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.
NxExportState	exportState	Defines the values to be exported. The default value is A.
System.Boolean	serveOnce	If the exported file should be served only once This parameter is optional and only used in Qlik Sense Enterprise (Windows) Default value: false

Returns

Type	Description
System.Threading.Tasks.Task<ExportDataResult>

Remarks

ExportData method is not supported in SaaS Editions of Qlik Sense.

ExportDataAsync<T>(AsyncHandle, Func<Response, T>, NxExportFileType, String, String, NxExportState, Boolean)

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.
16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.
1000 to export to a CSV file
5000000 to export to a CSV file

Default limitation in number of columns

The default maximum number of columns in the export file is:

Default limitations in number of cells

The default maximum number of cells in the export file is:

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Declaration

      Task<T> ExportDataAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qFileType")] NxExportFileType fileType, [QixName("qPath")] string path = null, [QixName("qFileName")] string fileName = null, [QixName("qExportState")] NxExportState exportState = NxExportState.EXPORT_ALL, [QixName("qServeOnce")] bool serveOnce = false)

Parameters

Type	Name	Description
AsyncHandle	asyncHandle	Handle to asynchronous method request
System.Func<Response, T>	onResult	Continuation function
NxExportFileType	fileType	Type of the file to export.
System.String	path	Path to the definition of the object to be exported. For example, `/qHyperCubeDef` . This parameter is mandatory if the file type is `CSV_C` or `CSV_T` .
System.String	fileName	Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.
NxExportState	exportState	Defines the values to be exported. The default value is A.
System.Boolean	serveOnce	If the exported file should be served only once This parameter is optional and only used in Qlik Sense Enterprise (Windows) Default value: false

Returns

Type	Description
System.Threading.Tasks.Task<T>

Type Parameters

Name	Description
T

Remarks

ExportData method is not supported in SaaS Editions of Qlik Sense.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here