analytics/webcontent/bi/js/dashboard-analytics/features/dashboard/visDefinitions/api/VisDefinitionsAPI.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.
 */

/**
 * @class VisDefinitionsAPI
 * @hideconstructor
 * @classdesc Represents the API to access the visualization definitions that are registered in the dashboard application.
 */

define([], function () {
	var VisDefinitionsAPI = function () {
		function VisDefinitionsAPI() {
			_classCallCheck(this, VisDefinitionsAPI);
		}

		/**
   * @function VisDefinitionsAPI#getList
   * @description Return a list of visualization definitions.
   * @public
   *
   * @return {VisDefinitionAPI[]}
   *
   */
		VisDefinitionsAPI.prototype.getList = function getList() {};

		/**
   * @function VisDefinitionsAPI#getById
   * @description Return a list of visualization definitions.
   * @public
   *
   * @param {String} id
   * @return {VisDefinitionAPI}
   *
   */


		VisDefinitionsAPI.prototype.getById = function getById() /* id */{};

		/**
   * @function VisDefinitionsAPI#getByType
   * @description Return a list of visualization definitions.
   * @public
   *
   * @param {String} type
   * @return {VisDefinitionAPI}
   *
   */


		VisDefinitionsAPI.prototype.getByType = function getByType() /* type */{};

		/**
   * @function VisDefinitionsAPI#refresh
   * @description Refresh definitions
   * @public
   *
   * @return {Promise<undefined>}
   */


		VisDefinitionsAPI.prototype.refresh = function refresh() {};

		/**
   * @function VisDefinitionsAPI#loadById
   * @description Loads a specific definition by ID
   * @public
   *
   * @return {Promise<undefined>}
   */


		VisDefinitionsAPI.prototype.loadById = function loadById() /* id */{};

		/**
   * @function VisDefinitionsAPI#on
   * @description Register an event handler for the visualization definitions
   * @param {String} eventName Name of the feature event
   * @param {function} handler Event handler to be called when the event occurrs.
   * @param {object} context Context of the event
   * Multiple handlers can be registered with the same <strong>eventName</strong>.
   * Each handlers needs to be registered and unregistered individually.
   */


		VisDefinitionsAPI.prototype.on = function on() {};

		/**
   * @function VisDefinitionsAPI#off
   * @description Unregister an event handler that was registered with {@link VisDefinitionsAPI#on}
   * @param {String} eventName Name of the feature event
   * @param {function} handler Event handler to be called when the event occurrs
   * @param {object} context Context of the event
   */


		VisDefinitionsAPI.prototype.off = function off() {};

		/**
   * @function VisDefinitionsAPI#registerModifier
   * @description Register a modifier object that can be used to extend the vis definitions
   * @param {VisDefinitionModifier} modifier
   */


		VisDefinitionsAPI.prototype.registerModifier = function registerModifier() {};

		/**
   * @function VisDefinitionsAPI#deregisterModifier
   * @description Deregister a previously registered definition modifier
   * @param {VisDefinitionModifier} modifier
   */


		VisDefinitionsAPI.prototype.deregisterModifier = function deregisterModifier() {};

		return VisDefinitionsAPI;
	}();

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