analytics/webcontent/bi/js/dashboard-analytics/features/dashboard/vis-fredisred/FredIsRedAPI.js

"use strict";

var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

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. 2019
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

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

		_createClass(FredIsRedFeatureAPI, [{
			key: "initializeFredIsRedFeature",

			/**
    * initializeFredIsRedFeature is function that initializes FredIsRed
    * @param fredIsRedSpec an object that contains FredIsRed spec
    */
			value: function initializeFredIsRedFeature() {}
			/**
    * getColor is the main API to a renderer.
    * it honours an existing sharedPalette but, if the value is not there, augments it.
    * @param paletteInfo an object that includes a color table, a default index and a Class to be returned with the color
    *						(where the color expects an RGB object).
    * @param labelArray -an array of 1 or more labels that make up a tuple (label value) to be coloured  eg: ['Canada'] or ['Canada', '2005']
    * @param {DataItemAPI} dataItem - data item type
    * @returns an instance of the ColorClass.
    */

		}, {
			key: "getColor",
			value: function getColor() {}

			/**
    * setUserColorMap - sets user color map
    * @param colorMap - object representing user color map
    */

		}, {
			key: "setUserColorMap",
			value: function setUserColorMap() {}

			/**
    * getUserColorMap - gets user color map (used for testing primarily)
    */

		}, {
			key: "getUserColorMap",
			value: function getUserColorMap() {}

			/**
    * registerKeyProvider is function that registeres key provider
    * @param keyProvider an object that includes key provider to be registered
    */

		}, {
			key: "registerKeyProvider",
			value: function registerKeyProvider() {}
		}]);

		return FredIsRedFeatureAPI;
	}();

	return FredIsRedFeatureAPI;
});
//# sourceMappingURL=FredIsRedAPI.js.map