analytics/webcontent/bi/js/gemini/api/LayoutAPI.js

"use strict";

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

/**
 * Licensed Materials - Property of IBM
 * IBM Business Analytics (C) Copyright IBM Corp. 2018, 2019
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @typedef {Object} layoutRenderOptions
 * @property {Boolean} isBackgrounRun - Indicate that the rendering is non-interactive, for example thumbnail rendering
 */

/**
 * @class LayoutAPI
 * @hideconstructor
 * @classdesc
 */
define([], function () {
	var LayoutAPI = function () {
		function LayoutAPI() {
			_classCallCheck(this, LayoutAPI);
		}

		/**
   * Return a list of of child layout APIs
   * @function LayoutAPI#getChildrenList
   * @return {LayoutAPI[]}
   */
		LayoutAPI.prototype.getChildrenList = function getChildrenList() {};

		/**
   * Get the parent layout API
   * @function LayoutAPI#getParentLayout
   * @return {LayoutAPI} Null is returned if this is the top level layout
   */


		LayoutAPI.prototype.getParentLayout = function getParentLayout() {};

		/**
   * @function LayoutAPI#getWidget
   * Get the widget API for the widget inside this layout
   * @return {WidgetAPI} Null is returned if the layout does not contain a widget
   */


		LayoutAPI.prototype.getWidget = function getWidget() {};

		/**
   * Shows the layout
   * @function LayoutAPI#render
   * @param {layoutRenderOptions} [options]
   */


		LayoutAPI.prototype.render = function render() {};

		return LayoutAPI;
	}();

	return LayoutAPI;
});
//# sourceMappingURL=LayoutAPI.js.map