analytics/webcontent/bi/js/gemini/features/dashboard/rendererExtension/api/ReactRendererAPI.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. 2020
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @interface ReactRendererAPI
 * @hideconstructor
 * @classdesc  API class that is used to provide a renderer provider extension point
 */
define([], function () {
	var ReactRendererAPI = function () {
		function ReactRendererAPI() {
			_classCallCheck(this, ReactRendererAPI);
		}

		/**
   * 
   * @function ReactRendererAPI#canRender
   * @description Indicates if there is a registered provider that can render the state
   * @param {Object} state An object that contains the renderer state information
   * @returns {Boolean} canRender
   */
		ReactRendererAPI.prototype.canRender = function canRender() {};

		/**
   * @function ReactRendererAPI#getComponentList
   * @description Get the list of react components to be rendered
   * @param {Object} state renderer state
   * @return  {Component[]} children An array of react components that will be placed in the cell
   *
   */


		ReactRendererAPI.prototype.getComponentList = function getComponentList() {};

		/**
   * 
   * @function ReactRendererAPI#registerProvider
   * @description Register a  renderer provider
   * @param {Renderer} renderer - instance of a class that has a getComponent() function
   */


		ReactRendererAPI.prototype.registerProvider = function registerProvider() {};

		/**
   * @public
   * @function ReactRendererAPI#deregisterProvider
   * @description Deregister a  renderer provider
   * @returns {Renderer} renderer
   */


		ReactRendererAPI.prototype.deregisterProvider = function deregisterProvider() {};

		return ReactRendererAPI;
	}();

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