QlikWorld 2020 Global Conference. Join us to discover how to get the most from your data. Act fast. Register now and save.

registerExtension method

This API is reliable and breaking changes are unlikely.

qlik.registerExtension(id, impl, metadata)

Registers an extension for use in this mashup. The extension is not installed on the Qlik Sense server and only available in the session where it is created.

As long as a JavaScript module is created in the correct format, it can be sent to the registerExtension function.

Version history

Introduced 2.2



Type: String

Set the ID of the visualization extension.


Type: Object

Set the extension implementation.


Type: Object

Optional. Extension meta-data, same format as the QEXT file.

Default: {"type":"visualization"}

Anatomy of the QEXT file


Example: Hello world on the fly

//define the helloworld extension
var helloworld = {

		paint: function ($element) {
			$element.html( "Hello world!!" );
//register the extension
qlik.registerExtension( 'helloworld', helloworld );
var app = qlik.openApp( 'app file name or ID', config );
//create and show an object using the extension
app.visualization.create( 'helloworld', ["Case Owner Group"] ).then( function ( helloworld ) {
    helloworld.show( "QV00" );
} );

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?