analytics/webcontent/bi/js/gemini/dashboard/data/ThemeDefinitionAPI.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.
 */

define([], function () {

	/**
  * @interface ThemeDefinitionAPI
  * @classdesc API class that defines the user profile info accessible in a dashboard
  */
	var ThemeDefinitionAPI = function () {
		function ThemeDefinitionAPI() {
			_classCallCheck(this, ThemeDefinitionAPI);
		}

		/**
   * Gets the css colors for the specified variable
   * @param {string} variableName - the variable to get the css colors for
   * @return {Object} the css colors for the variableName arg
   */
		ThemeDefinitionAPI.prototype.getCSSColors = function getCSSColors() {};

		/**
   * Gets the default palette name
   * @param {String} paletteType - the type of palette, currently only options are 'ColorPalette', 'HeatPalette' and 'ConditionalPalette'
   * @returns default color palette name ('colorPalette0' for instance)
   */


		ThemeDefinitionAPI.prototype.getDefaultPaletteName = function getDefaultPaletteName() {};

		/**
   * Gets the id of the theme definition
   * @returns {String} - id of ThemeDefinition
   */


		ThemeDefinitionAPI.prototype.getId = function getId() {};

		/**
   * Gets the mapped theme
   * @param {String} id - the id of the mapped themes
   * @returns {String} the group of the mapped theme corresponding to the id ex. axisLineColor, axisGridLineColor
   */


		ThemeDefinitionAPI.prototype.getMappedId = function getMappedId() {};

		/**
   * Get a specific palette
   * @param {String} paletteId - the ID of the palette
   * @param {String} paletteVariableName - the theme variable name for the list of palettes ('ColorPalette', 'HeatPalette', 'ContinuousPalette')
   * @param {Boolean} forProperties - boolean if the response is to be used for the properties.
   * @return {Array} all palettes defined in the theme
   */


		ThemeDefinitionAPI.prototype.getPalette = function getPalette() {};

		/**
   * Get all the palettes defined in the theme
   * @param {String} paletteVariableName - the theme variable name for the list of palettes ('ColorPalette', 'HeatPalette', 'ContinuousPalette')
   * @param {Boolean} forProperties - boolean if the response is to be used for the properties
   * @param {Boolean} includePatternPalettes - Should pattern palettes be included in the list of returned palettes.
   * @return {Array} all palettes defined in the theme
   */


		ThemeDefinitionAPI.prototype.getPalettes = function getPalettes() {};

		/**
   * Get the property value for the UIElement and Property ID specified
   * @param {String} uiElement - UIElement as described in the theme
   * @param {String} propertyId - property within the specified UIElement
   * @returns {Object} - value for the property if it exists, undefined otherwise
   */


		ThemeDefinitionAPI.prototype.getPropertyForUIElement = function getPropertyForUIElement() {};

		/**
   * Gets all the mapped themes
   * @returns {Object} - all the mapped themes.
   */


		ThemeDefinitionAPI.prototype.getThemeMapping = function getThemeMapping() {};

		/**
   * Get the property value for the UIElement and Property ID specified
   * @param {String} uiElement - UIElement as described in the theme
   * @param {String} propertyId - property within the specified UIElement
   * @returns {Object} - value for the property if it exists, undefined otherwise
   */


		ThemeDefinitionAPI.prototype.getValueForPropertyOfUIElement = function getValueForPropertyOfUIElement() {};

		/**
   * Given the variable type (such as 'Color' or 'Font') and the variable ID
   * (such as 'color1' or 'font1') return the value for the corresponding mapping
   * @param {String} variableType - Variable type (such as 'Color' or 'Font')
   * @param {String} variableId - id of a variable found within the specified variableType (such as 'color1')
   * @returns {Object} value if the specified variable exists.
   */


		ThemeDefinitionAPI.prototype.getValueForVariable = function getValueForVariable() {};

		/**
   * Generates an array of id and foreground color pairs
   * @param {String} bgColor - String defining the background color eg. color3¿
   * @param {String} uiElement - UIElement as described in the theme eg. visualization
   * @returns {Array} array of id and foreground color pairs that are type is one of FOREGROUND_PALETTES in given elements
   */


		ThemeDefinitionAPI.prototype.getForegroundColorPropertiesForUIElement = function getForegroundColorPropertiesForUIElement() {};

		/**
   * Generates an array of id and foreground color pairs
   * @param {String} uiElement - UIElement as described in the theme eg. visualization
   * @returns {Array} array of properties for ui elements
   */


		ThemeDefinitionAPI.prototype.getForegroundPropertiesForUIElement = function getForegroundPropertiesForUIElement() {};

		/**
   * Updates the mapping of the themes
   * @param {Object} themeMapping - json description of which properties map to which super property
   * For example:
   * 		{
   * 			"id": "axisLineColor",
   * 			"mapping": [
   * 				"valAxisLineColor",
   * 				"catAxisLineColor"
   * 			]
   *		}
   */


		ThemeDefinitionAPI.prototype.updateThemeMapping = function updateThemeMapping() {};

		/**
   * Sets the themeMapping
   * @param {Object} themeMapping - An object containing all the mapping of the themes
   */


		ThemeDefinitionAPI.prototype.setThemeMapping = function setThemeMapping() {};

		return ThemeDefinitionAPI;
	}();

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