qlik-isolated
Version:
Load Qlik Sense's qlik.js in a isolated non-conflicting way and embed Qlik Sense objects
1,634 lines (482 loc) • 24.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="version"><span class="type-signature"></span>version<span class="type-signature"></span></h4>
<div class="description">
{string} version
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="qlik-isolated.js.html">qlik-isolated.js</a>, <a href="qlik-isolated.js.html#line244">line 244</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getObjectIsolated"><span class="type-signature"></span>getObjectIsolated<span class="signature">(element, appid, obj<span class="signature-attributes">opt</span>, sheet<span class="signature-attributes">opt</span>, baseUrl<span class="signature-attributes">opt</span>, showSelectionBar<span class="signature-attributes">opt</span>, clearSelection<span class="signature-attributes">opt</span>, disableInteraction<span class="signature-attributes">opt</span>, disableSelection<span class="signature-attributes">opt</span>, disableAnimation<span class="signature-attributes">opt</span>, selections<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Load a qlik object in a isolated iframe
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">HTMLElement</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">HTML element into which the object must be loaded</td>
</tr>
<tr>
<td class="name"><code>appid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">Qlik app id. Eg: Consumer Sales.qvf</td>
</tr>
<tr>
<td class="name"><code>obj</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">id of the object to be loaded. Eg: prgzES</td>
</tr>
<tr>
<td class="name"><code>sheet</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">id of the sheet. Either obj or sheet must be specified</td>
</tr>
<tr>
<td class="name"><code>baseUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">URL of the Qlik server</td>
</tr>
<tr>
<td class="name"><code>showSelectionBar</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">show / hide the selection bar</td>
</tr>
<tr>
<td class="name"><code>clearSelection</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">clear selections on load</td>
</tr>
<tr>
<td class="name"><code>disableInteraction</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">enable / disable interactions</td>
</tr>
<tr>
<td class="name"><code>disableSelection</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">enable / disable selections</td>
</tr>
<tr>
<td class="name"><code>disableAnimation</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">enable / disable animations</td>
</tr>
<tr>
<td class="name"><code>selections</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">array of key-values to be selected on load</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="qlik-isolated.js.html">qlik-isolated.js</a>, <a href="qlik-isolated.js.html#line184">line 184</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getQlik"><span class="type-signature"></span>getQlik<span class="signature">(url, prefix<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
Load Qlik in an isolated context
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">Qlik Server base url</td>
</tr>
<tr>
<td class="name"><code>prefix</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'/'
</td>
<td class="description last">Qlik Server prefix for resources folder</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="qlik-isolated.js.html">qlik-isolated.js</a>, <a href="qlik-isolated.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Promise that gets resolved when qlik sense is successfully loaded
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getSelectionBarIsolated"><span class="type-signature"></span>getSelectionBarIsolated<span class="signature">(element, appid, baseUrl<span class="signature-attributes">opt</span>, clearSelection<span class="signature-attributes">opt</span>, disableInteraction<span class="signature-attributes">opt</span>, disableSelection<span class="signature-attributes">opt</span>, disableAnimation<span class="signature-attributes">opt</span>, selections<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Load a qlik selection bar in a isolated iframe
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">HTMLElement</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">HTML element into which the object must be loaded</td>
</tr>
<tr>
<td class="name"><code>appid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">Qlik app id. Eg: Consumer Sales.qvf</td>
</tr>
<tr>
<td class="name"><code>baseUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">URL of the Qlik server</td>
</tr>
<tr>
<td class="name"><code>clearSelection</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">clear selections on load</td>
</tr>
<tr>
<td class="name"><code>disableInteraction</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">enable / disable interactions</td>
</tr>
<tr>
<td class="name"><code>disableSelection</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">enable / disable selections</td>
</tr>
<tr>
<td class="name"><code>disableAnimation</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">enable / disable animations</td>
</tr>
<tr>
<td class="name"><code>selections</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">array of key-values to be selected on load</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="qlik-isolated.js.html">qlik-isolated.js</a>, <a href="qlik-isolated.js.html#line212">line 212</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="qlikIsolatedLoadConfig">qlikIsolatedLoadConfig</h4>
<div class="description">
Configuration options for qlik-isolated
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">Qlik server base url</td>
</tr>
<tr>
<td class="name"><code>perfix</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'/'
</td>
<td class="description last">Qlik Server prefix for resources folder</td>
</tr>
<tr>
<td class="name"><code>makeGlobal</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">after autoloading,aAssign qlik to window object</td>
</tr>
<tr>
<td class="name"><code>successCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">function to callback when qlik is loaded</td>
</tr>
<tr>
<td class="name"><code>failureCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">function to callback when qlik load failed</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="qlik-isolated.js.html">qlik-isolated.js</a>, <a href="qlik-isolated.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#getObjectIsolated">getObjectIsolated</a></li><li><a href="global.html#getQlik">getQlik</a></li><li><a href="global.html#getSelectionBarIsolated">getSelectionBarIsolated</a></li><li><a href="global.html#version">version</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.3</a> on Thu Aug 03 2017 23:26:10 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>