exportData method

Note: STABLE.
This API is reliable and breaking changes are unlikely.

exportData(options, callback)

Exports data of the underlying hypercube in OOXML or CSV format.

Note: The entire hypercube is exported, not just the current data-page.

Version history

Introduced 2.1

Parameters

Name Type Description
options Object

Optional.

Properties:

Name Type Description
format String

Data format. Can be one of:

  • OOXML: open XML, default
  • CSV_C: comma separated CSV
  • CSV_T: tab separated CSV
filename String

This parameter is optional and only used in desktop.

Sets the name of the exported file when downloaded.

Example: filename(guid).xlsx

state String

Can be:

  • A: all values
  • P: possible values (default)
download Boolean Automatically start download of file (with window.open).
callback Function

Optional.

Callback function returning the link to the exported file.

Example

Example:  

var qTable = qlik.table(this);

var $exportButton = $( document.createElement('button'));
$exportButton.html('Export');
$exportButton.bind('click', function (  ) {
			qTable.exportData({download: true});
		});
$element.append($exportButton);
		

Example: Using AngularJS in a Qlik Sense visualization extension.


//Main script:
...
paint: function ( ) {
		//setup scope.table
		if ( !this.$scope.table ) {
		this.$scope.table = qlik.table( this );
		}
	}
...

//In your template:
<button ng-click="table.exportData({download:true})">Create Excel file</button>
		

Did this information help you?

Can you tell us why it did not help you and how we can improve it?