/**
* @fileOverview qlik-isolated.js : Load Qlik Sense's qlik.js in a isolated non-conflicting way and
* embed Qlik Sense objects
* @author Hari Vikas Janarthanan | hrivks@gmail.com | https://github/hrivks
* @version 1.0.5
* @license MIT
*/
/**
* Configuration options for qlik-isolated
* @typedef {Object} qlikIsolatedLoadConfig
* @property {string} url Qlik server base url
* @property {string} [perfix = '/'] Qlik Server prefix for resources folder
* @property {boolean} [makeGlobal = false] after autoloading,aAssign qlik to window object
* @property {function} successCallback function to callback when qlik is loaded
* @property {function} failureCallback function to callback when qlik load failed
*/
var qlikIsolated = (function () {
var qlik;
/** @type {string} **/
var qlikServerBaseUrl;
/** @type {string} **/
var qlikServerPrefix = '/';
/** @constant **/
var SINGLE_URL_APPID_PLACEHOLDER = '#APPID#';
/** @constant **/
var SINGLE_URL_OBJ_PLACEHOLDER = '#OBJ#';
/** @constant **/
var SINGLE_URL_OPT_PLACEHOLDER = '#OPT#';
/** @constant **/
var SINGLE_URL_SHEET_PLACEHOLDER = '#SHEET#';
/** @constant **/
var SINGLE_URL_OPT_SELECTION_BAR = 'currsel,';
var SINGLE_URL_OPT_NO_INTERACTION = 'nointeraction,';
/** @constant **/
var SINGLE_URL_OPT_NO_SELECTION = 'noselections,';
/** @constant **/
var SINGLE_URL_OPT_NO_ANIMATION = 'noanimate,';
/** @constant **/
var SINGLE_URL_CLEAR_SELECTION = '&select=clearall';
/** @constant **/
var SINGLE_URL = '/single/?appid=' + SINGLE_URL_APPID_PLACEHOLDER
+ '&obj=' + SINGLE_URL_OBJ_PLACEHOLDER
+ '&sheet=' + SINGLE_URL_SHEET_PLACEHOLDER
+ '&opt=' + SINGLE_URL_OPT_PLACEHOLDER;
/** @function */
var resolve;
/** @function */
var reject;
/**
* Load Qlik in an isolated context
* @function getQlik
* @param {string} url Qlik Server base url
* @param {string} [prefix='/'] Qlik Server prefix for resources folder
* @return {Promise} Promise that gets resolved when qlik sense is successfully loaded
*/
function getQlik(url, prefix) {
if (!url && !qlikServerBaseUrl)
throw 'qlik-Isolated: Qlik Server URL is required';
var p = new Promise(function (res, rej) {
resolve = res;
reject = rej;
});
if (qlik) {
resolve(qlik);
return p;
}
qlikServerBaseUrl = url || qlikServerBaseUrl;
qlikServerPrefix = prefix || qlikServerPrefix;
// create an iframe for an isolated context
var qFrame = document.createElement('iframe');
qFrame.style.display = 'none';
qFrame.id = 'qFrame';
document.body.appendChild(qFrame);
qFrame.contentWindow.document.open();
qFrame.contentWindow.document.write(getQFrameHtml());
qFrame.contentWindow.document.close();
return p;
}
/**
* Get HTML to be writen into the qframe
*/
function getQFrameHtml() {
var jsUrl = qlikServerBaseUrl + qlikServerPrefix + 'resources';
return '<html>'
+ '<head>'
+ '<script src="' + jsUrl + '/assets/external/requirejs/require.js"></script>'
+ '</head>'
+ '<body><p>Isolated iframe to load Qlik.js </p>'
+ '<script>'
+ 'try {'
+ 'require.config({ baseUrl: "' + jsUrl + '" });'
+ 'require(["js/qlik"], function(q) { parent.qlikIsolated._qFrameLoadSuccess(q); });'
+ '} catch(e) { parent.qlikIsolated._qFrameLoadFailure(e); }'
+ '</script>'
+ '</body>'
+ '</html>';
}
/**
* callback function called from the iframe when qlik is loaded
*/
function _qFrameLoadSuccess(q) {
qlik = q;
resolve(qlik);
}
/*
* callback function called from the iframe when qlik load failed
*/
function _qFrameLoadFailure(e) {
reject(e);
}
/**
* Create iframe element for loading qlik object
* @param {string} appid Qlik app id. Eg: Consumer Sales.qvf
* @param {string} [obj] id of the object to be loaded. Eg: prgzES
* @param {string} [sheet] id of the sheet. Either obj or sheet must be specified
* @param {string} [baseUrl] URL of the Qlik server
* @param {boolean} [showSelectionBar = false] show / hide the selection bar
* @param {boolean} [clearSelection = false] clear selections on load
* @param {boolean} [disableInteraction = false] enable / disable interactions
* @param {boolean} [disableSelection = false] enable / disable selections
* @param {boolean} [disableAnimation = false] enable / disable animations
* @param {string[]} [selections] array of key-values to be selected on load
*/
function createIframe(appid, obj, sheet, baseUrl, showSelectionBar, clearSelection,
disableInteraction, disableSelection, disableAnimation, selections) {
if (typeof appid !== 'string')
throw 'qlik-Isolated: appid must be a vaild string';
if ((typeof obj !== 'string') && (typeof sheet !== 'string'))
throw 'qlik-Isolated: obj or sheet must be a vaild string';
// form Qlik Sense Single integration URL
var url = baseUrl || qlikServerBaseUrl;
if (!url)
throw 'qlik-Isolated: baseUrl is required';
var options = '';
options += showSelectionBar ? SINGLE_URL_OPT_SELECTION_BAR : '';
options += disableInteraction ? SINGLE_URL_OPT_NO_INTERACTION : '';
options += disableAnimation ? SINGLE_URL_OPT_NO_ANIMATION : '';
options += disableSelection ? SINGLE_URL_OPT_NO_SELECTION : '';
options = options.substring(0, options.lastIndexOf(','));
obj = obj || '';
sheet = sheet || '';
url += SINGLE_URL
.replace(SINGLE_URL_APPID_PLACEHOLDER, appid)
.replace(SINGLE_URL_OBJ_PLACEHOLDER, obj)
.replace(SINGLE_URL_OPT_PLACEHOLDER, options)
.replace(SINGLE_URL_SHEET_PLACEHOLDER, sheet);
if (clearSelection)
url += SINGLE_URL_CLEAR_SELECTION;
if (selections && (selections instanceof Array)) {
url += '&select=' + selections.join('&select=');
}
// add iframe to single integration URL
var singleIntegrationFrame = document.createElement('iframe');
singleIntegrationFrame.style.border = 'none';
singleIntegrationFrame.style.width = '100%';
singleIntegrationFrame.style.height = '100%';
singleIntegrationFrame.className = 'qlik-isolated';
singleIntegrationFrame.src = url;
return singleIntegrationFrame;
}
/**
* Load a qlik object in a isolated iframe
* @function getObjectIsolated
* @param {HTMLElement} element HTML element into which the object must be loaded
* @param {string} appid Qlik app id. Eg: Consumer Sales.qvf
* @param {string} [obj] id of the object to be loaded. Eg: prgzES
* @param {string} [sheet] id of the sheet. Either obj or sheet must be specified
* @param {string} [baseUrl] URL of the Qlik server
* @param {boolean} [showSelectionBar = false] show / hide the selection bar
* @param {boolean} [clearSelection = false] clear selections on load
* @param {boolean} [disableInteraction = false] enable / disable interactions
* @param {boolean} [disableSelection = false] enable / disable selections
* @param {boolean} [disableAnimation = false] enable / disable animations
* @param {string[]} [selections] array of key-values to be selected on load
*/
function getObjectIsolated(element, appid, obj, sheet, baseUrl,
showSelectionBar, clearSelection, disableInteraction,
disableSelection, disableAnimation, selections) {
if (!element)
throw 'qlik-Isolated: element must be a HTML element or a jQuery selection';
var singleIntegrationFrame = createIframe(appid, obj, sheet, baseUrl, showSelectionBar,
clearSelection, disableInteraction,
disableSelection, disableAnimation, selections);
element.append(singleIntegrationFrame);
}
/**
* Load a qlik selection bar in a isolated iframe
* @function getSelectionBarIsolated
* @param {HTMLElement} element HTML element into which the object must be loaded
* @param {string} appid Qlik app id. Eg: Consumer Sales.qvf
* @param {string} [baseUrl] URL of the Qlik server
* @param {boolean} [clearSelection = false] clear selections on load
* @param {boolean} [disableInteraction = false] enable / disable interactions
* @param {boolean} [disableSelection = false] enable / disable selections
* @param {boolean} [disableAnimation = false] enable / disable animations
* @param {string[]} [selections] array of key-values to be selected on load
*/
function getSelectionBarIsolated(element, appid, baseUrl, clearSelection, disableInteraction,
disableSelection, disableAnimation, selections) {
if (!element)
throw 'qlik-Isolated: element must be a HTML element or a jQuery selection';
var singleIntegrationFrame = createIframe(appid, 'CurrentSelections', '', baseUrl,
false, clearSelection, disableInteraction,
disableSelection, disableAnimation, selections);
singleIntegrationFrame.className = 'qlik-isolated qlik-isolated-selection-bar';
singleIntegrationFrame.style.marginTop = '-50px';
element.append(singleIntegrationFrame);
}
return {
getQlik: getQlik,
getObjectIsolated: getObjectIsolated,
getSelectionBarIsolated: getSelectionBarIsolated,
_qFrameLoadSuccess: _qFrameLoadSuccess,
_qFrameLoadFailure: _qFrameLoadFailure,
/** {string} version */
version: '1.0.5'
};
}());
/* autoload if qlikIsolatedLoadConfig exists */
if (typeof qlikIsolatedLoadConfig !== 'undefined') {
if (typeof qlikIsolatedLoadConfig.url === 'string') {
qlikIsolated.getQlik(qlikIsolatedLoadConfig.url, qlikIsolatedLoadConfig.prefix)
.then(function (q) {
console.log('qlik-isolated: qlik.js auto loaded');
if (qlikIsolatedLoadConfig.makeGlobal) {
window.qlik = q;
}
if (typeof qlikIsolatedLoadConfig.successCallback === 'function') {
qlikIsolatedLoadConfig.successCallback(q);
}
}, function (e) {
console.log('qlik-isolated: error auto loading qlik');
console.log(e);
if (typeof qlikIsolatedLoadConfig.failureCallback === 'function') {
qlikIsolatedLoadConfig.failureCallback(e);
}
});
}
}