English Qlik Sense Developers 2.0

Getting started building visualization extensions with Qlik Sense Workbench

This topic describes how to create your first visualization extension, based on the Hello world example which is included in your Qlik Sense installation.

Do the following:

  1. Open Qlik Sense Workbench.

    See: Launching Qlik Sense Workbench

  2. Click Create new and fill in the details.

    Name the visualization extension HelloWorld and use the Basic Visualization template and then click Create.

    The new visualization extension is created and visible in the items list.

  3. Click on the newly created HelloWorld visualization extension and select Edit.

    It is launched in the Extension editor.

  4. Import the preview image file.

    Click Import file and browse to ..Users\<UserName>\Documents\Qlik\Examples\Extensions\HelloWorld and select the helloworld.png file. Then click Open.

    The image file is included in the project and visible on the right hand side panel.

  5. Update the QEXT file.

    	"name": "Hello World",
    	"description": "Hello World example",
      	"preview": "helloworld.png",
    	"type": "visualization",
    	"version": 1,
    	"author": ""
    The preview file previously imported is defined in the "preview" field.
  6. Add your rendering code to the JavaScript file.

    define( [
    function ( ) {
    	return {
    		paint: function ($element) {
    			//add your rendering code here
    			$element.html( "Hello world!!" );
    } );
  7. Click Save.

    The visualization extension has now been saved and is available from Qlik Sense.