analytics/webcontent/bi/js/dashboard-analytics/extensions/smarts-recommender/content-features/api/VisualizationSmartsRecommenderAPI.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 SmartRecommenderAPI
 * @hideconstructor
 *
 * @classdesc
 */
define([], function () {
	var VisualizationSmartsRecommenderAPI = function () {
		function VisualizationSmartsRecommenderAPI() {
			_classCallCheck(this, VisualizationSmartsRecommenderAPI);
		}

		/**
   * @function VisualizationSmartsRecommenderAPI#setType
   * @description Set the visualization type and recommend a new slot binding
   * @public
   *
   * @param {String} type visualization type to switch to
   * @param {Object} transactionToken
   *
   */
		VisualizationSmartsRecommenderAPI.prototype.setType = function setType() {};

		/**
   * @function VisualizationSmartsRecommenderAPI#addColumns
   * @description Add columns to the visualization. Recommend the best binding and assign them. If the visualiztion is not locked to a given type then the type might change
   * @public
   *
   * @param {String[]} array of column ids
   * @param {Object} transactionToken
   *
   */


		VisualizationSmartsRecommenderAPI.prototype.addDataItems = function addDataItems() {};

		/**
   * @function VisualizationSmartsRecommenderAPI#recommendBestVisualization
   * @description Change the type to the recommended type
   * @public
   *
   * @param {Object} transactionToken
   *
   */


		VisualizationSmartsRecommenderAPI.prototype.recommendBestVisualization = function recommendBestVisualization() {};

		/**
   * @function VisualizationSmartsRecommenderAPI#getRecommendedVisualizations
   * @description Get the list of recommended visualization definition APIs for the current visualization.
   * 
   *
   * @param {VisDefinitionAPI[]} vizDefinitions
   *
   */


		VisualizationSmartsRecommenderAPI.prototype.getRecommendedVisualizations = function getRecommendedVisualizations() {};

		return VisualizationSmartsRecommenderAPI;
	}();

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