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.
Using AngularJS in your mashup for more information on integrating the Capability APIs into an existing AngularJS project.
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 | ||||
Theme API | qlik.theme |
Limitations
The following capability API methods are not supported when used with Qlik Cloud Services and Qlik Sense Enterprise on Kubernetes.
Capability API | Methods |
---|---|
Global API |
|
Root API |
|
QVisualization API |
|
Getting started
Learn how to get started embedding Qlik Sense content into a web page.
Loading resources
To use the Capability APIs, you need to include references to the Qlik Sense implementation of RequireJS and one CSS file to ensure visualizations are styled as expected.
CSS
Include the following in the <head> section of your page:
<link rel="stylesheet" href="https://QSE_domain[:port]/<virtual proxy>/resources/autogenerated/qlik-styles.css">
RequireJS
Include the following before the closing </body> tag:
<script type="text/javascript" src="https://QSE_domain[:port]/<virtual proxy>/resources/assets/external/requirejs/require.js"></script>
Connecting to the Qlik associative 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: "QSE_domain", //the address of your Qlik Engine Instance
prefix: "/", //or the virtual proxy to be used. for example "/anonymous/"
port: 443, //or the port to be used if different from the default port
isSecure: true //should be true if connecting over HTTPS
//webIntegrationId: 'web-integration-id-here' //only needed in QCS and QSEoK
};
You then use the config object to tell RequireJS where to set the baseUrl:
const baseUrl = ( config.isSecure ? 'https://' : 'http://' ) + config.host + (config.port ? ':' + config.port : '') + config.prefix;
require.config({
baseUrl: '${baseUrl}resources'
// webIntegrationId: config.webIntegrationId// only needed in QCS or QSEoK
});
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.