English Qlik Sense Developers 3.2

Capability APIs

Overview

The Capability APIs are a collection of JavaScript APIs that allows you to easily embed Qlik Sense content into a web page. With just a few lines of code it is possible to create a visualization that leverages the Qlik Sense visualization library.

The Capability APIs are dependent on AngularJS and RequireJS, so you will need to take this into consideration when integrating the Capability APIs into an existing project that also uses these libraries.

See: Using AngularJS in your mashup for more information on integrating the Capability APIs into an existing AngularJS project.

The term Capability API was introduced with Qlik Sense 2.1. Some of the Capability APIs were available before this version, published under the name Mashup API.

Capabilities

Use these resources to build and bring capabilities into visualization extensions (), widgets (), custom components () and mashups ().

Capability API Namespace Usage
Root API qlik  
App API qlik.app
Bookmark API qlik.app.bookmark  
Field API qlik.app.field  
Selection API qlik.app.selectionState  
Variable API qlik.app.variable  
Visualization API qlik.app.visualization      
Global API qlik.global  
Navigation API qlik.navigation  
Table API qlik.table

Getting started

Learn how to get started embedding Qlik Sense content into a web page.

This example assumes you are already authenticated or have allowed anonymous access to your Qlik Sense instance.

Loading resources

To use the Capability APIs, you need to include references to the Qlik Sense implementation of RequireJS and two CSS files to ensure visualizations are styled as expected.

CSS

Include the following in the <head> section of your page:

<link rel="stylesheet" href="https://<qlik server>[:port]/<virtual proxy>/resources/autogenerated/qlikui.css">
<link rel="stylesheet" href="https://<qlik server>[:port]/<virtual proxy>/resources/assets/client/client.css" media="all">

RequireJS

Include the following before the closing </body> tag:

<script type="text/javascript" src="https://<qlik server>[:port]/<virtual proxy>/resources/assets/external/requirejs/require.js"></script>
The virtual proxy may be omitted if you are connecting to the default virtual proxy.
The port may be omitted if you are using the default ports for the current protocol (HTTP - 80, HTTPS - 443).

Connecting to the Qlik engine instance

You must create a config object to configure the baseUrl for RequireJS so that it knows where to fetch all the resources required:

var config = {
    host: "myhost.com", //the address of your Qlik Engine Instance
    prefix: "/", //the virtual proxy to be used. for example "/anonymous/"
    port: window.location.port, //the port to be used if different from the current port  
    isSecure: true //should be true if connecting over HTTPS
};

You then use the config object to tell RequireJS where to set the baseUrl:

require.config({
    baseUrl: ( config.isSecure ? "https://" : "http://" ) + config.host + (config.port ? ":" + config.port: "") + config.prefix + "resources",
  });

You can now load the main qlik.js file, which contains all the Capability APIs:

require(['js/qlik'], function(qlik) {
    //if there's any error we catch it here
    qlik.setOnError( function ( error ) {
        console.log(error);
    });
});

The qlik object is an instance of the Root API. With your connection to the server, you can now open a Qlik Sense app:

var app = qlik.openApp("app name or id", config);

You can now work with your app, that uses the App API.

Version history

Each method and property contain information around when it was introduced, updated, deprecated or removed. A list of all relevant API changes per version release can be found in API version history.