export property

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

export(enable)

Enables or disables the ability to export the visualization extension as an image or as a PDF. It also allows the visualization extension to be included in an export from Storytelling (PowerPoint or PDF).

When set to true, the Export as an image and the Export to PDF context menu options for the visualization extension are enabled. This also allows the 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.

Version history

Introduced 3.0

Parameters

enable

Type: Boolean

Set to true to enable the Export as an image and the Export to PDF context menu options 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.

Set to false to disable.

Default is false.

Limitation

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.

Examples

Example: Basic example

var ext = {
	support: {
		snapshot: true,
		export: true,
		exportData: true
	}
};

Example: exportImage as a function

In this example, the export property is used as a function and does not allow export as an image when no data is available in the visualization extension.
{
	support: {
		export: function( layout ) {
			return layout.qHyperCube.qDataPages[0].qMatrix.length;
		}
	}
}

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

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