By allowing users to export your visualization extensions, users can generate insights and share them with people outside the boundaries of a Qlik Sense system. For instance you can cooperate with customers and suppliers and take decisions based on selected data.
To be able to export your visualization extensions, the export functionality must be enabled in the code of the visualization extension. The following export functions can be enabled:
- Export to image
- Export to PDF
- Export story to PowerPoint
- Export story to PDF
- Export data
The following limitations apply:
-
Qlik Sense does not support exporting or printing of visualization extensions that use external resources.
-
Qlik Sense does not support exporting or printing of visualization extensions that use internal and undocumented JavaScript modules or APIs.
-
When exporting as an image, the maximum size that can be exported is 2,000 by 2,000 pixels. If the export would result in a larger image, the user must reduce the size under Custom in the Export as an image dialog in the app.
Export to image, PDF, and PowerPoint
The export property is used to enable or disable the ability to export the visualization extension as an image and as a PDF. It also allows the visualization extension to be included in an export from data storytelling (to PowerPoint or PDF). When export is set to true, the Export as an image and the Export to PDF context menu options will be available for the visualization extension. This also allows visualization extensions to be part of stories exported to PowerPoint or PDF on the Export story to PowerPoint and Export story to PDF context menu options.
Example: Basic example
define(['qlik'], function (qlik) {
return {
support: {
export: true
},
paint: function ($element, layout) {
const dfd = qlik.Promise.defer();
const image = document.createElement('img');
image.src = 'https://shorturl.at/iyHO0';
image.onload = dfd.resolve;
$element.append(image);
return dfd;
}
};
});Example: export as a function
definition : properties,
support : {
export: function( layout ) {
return layout.qHyperCube.qDataPages[0].qMatrix.length;
}
},
paint : function($element, layout) {
As well as this, you must set up the "finished rendering" notification in the paint method.
Export data
The exportData property is used to enable or disable the ability to export data from the visualization extension and save it in an XLSX file. When set to true, the Export data context menu option is enabled for the visualization extension.
As well as this, you must set up the "finished rendering" notification in the paint method.
Example: Basic example
definition : properties,
support : {
exportData: true
},
paint : function($element, layout) {Example: exportData as a function
definition : properties,
support : {
exportData: function( layout ) {
return layout.qHyperCube.qDataPages[0].qMatrix.length;
}
},
paint : function($element, layout) {Set up "finished rendering" notification
To complete the enabling of export you must inform the printing service, in the paint method, that the extension has finished rendering.
// ...,
paint : function() {
return qlik.Promise.resolve();
}
// ...
Troubleshooting
Check out the troubleshooting section if you run into problems when enabling export and printing functionality.