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

/**
 * @private
 * @typedef {Object} DefaultFromSlot
 * @property {String} id  - Slot ID to use for defaults
 */

/**
 * @interface SlotDefinitionAPI
 * @classdesc API class that is used to control slot definitions.
 * @example slot.getDefinition()
 */
define([], function () {
	var SlotDefinitionAPI = function () {
		function SlotDefinitionAPI() {
			_classCallCheck(this, SlotDefinitionAPI);
		}

		/**
   * @function SlotDefinitionAPI#getProperty
   * @description Gets a property value from the slot definition.
   * @private
   * @param {String} id
   * @returns {Object} Property value
   */
		SlotDefinitionAPI.prototype.getProperty = function getProperty() {};

		/**
   * @function SlotDefinitionAPI#getDatasetIdList
   * @description Gets the data set ID list.
   * @private
   *
   * @return {Array} Data set ID string array representation
   */


		SlotDefinitionAPI.prototype.getDatasetIdList = function getDatasetIdList() {};

		/**
   * @function SlotDefinitionAPI#getId
   * @description Gets the slot ID.
   * @public
   *
   * @return {String} Slot ID
   */


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

		/**
   * @function SlotDefinitionAPI#getCaption
   * @description Gets the slot caption.
   * @public
   *
   * @return {String} Slot caption
   */


		SlotDefinitionAPI.prototype.getCaption = function getCaption() {};

		/**
   * @function SlotDefinitionAPI#getIcon
   * @description Gets the slot icon name.
   * @private
   *
   * @return {String} Slot CSS icon name
   */


		SlotDefinitionAPI.prototype.getIcon = function getIcon() {};

		/**
   * @function SlotDefinitionAPI#getType
   * @description Gets the slot type.
   * @public
   *
   * @return {String} Slot type
   */


		SlotDefinitionAPI.prototype.getType = function getType() {};

		/**
   * @function SlotDefinitionAPI#getSubType
   * @description Gets the slot sub type, such as location, latitude, longitude, etc.
   * @private
   *
   * @return {String} Slot sub type
   */


		SlotDefinitionAPI.prototype.getSubType = function getSubType() {};

		/**
   * @function SlotDefinitionAPI#getGroupId
   * @description Gets the slot group ID.
   * @private
   *
   * @return {String} Slot group ID
   */


		SlotDefinitionAPI.prototype.getGroupId = function getGroupId() {};

		/**
   * @function SlotDefinitionAPI#getRole
   * @description Gets the slot role.
   * @private
   *
   * @return {String} Slot role
   */


		SlotDefinitionAPI.prototype.getRole = function getRole() {};

		/**
   * @function SlotDefinitionAPI#isHiden
   * @description Checks whether the slot is hidden or not.
   * @private
   *
   * @return {boolean} Returns true if slot is hidden, otherwise false.
   */


		SlotDefinitionAPI.prototype.isHidden = function isHidden() {};

		/**
   * @function SlotDefinitionAPI#isOptional
   * @description Checks whether the slot is optional or not.
   * @private
   *
   * @return {boolean} Returns true if slot is optional, otherwise false.
   */


		SlotDefinitionAPI.prototype.isOptional = function isOptional() {};

		/**
   * @function SlotDefinitionAPI#getSort
   * @description Gets the slot sort.
   * @private
   *
   * @return {String} Slot sort
   */


		SlotDefinitionAPI.prototype.getSort = function getSort() {};

		/**
   * @function SlotDefinitionAPI#getSortOrder
   * @description Gets the slot sort order.
   * @private
   *
   * @return {Number} Slot sort order represented by number
   */


		SlotDefinitionAPI.prototype.getSortOrder = function getSortOrder() {};

		/**
   * @function SlotDefinitionAPI#getAggregatedSortInfo
   * @description Gets aggregated and sort info used when sort on aggregated fact values.
   * @private
   *
   * @return {Object} clientSideAggregatedAndSortInfo object in slot definition
   * @example
   * {
   *    clientSideAggregatedAndSortInfo:{
   *        mappedSlotCondition:[
   *            'series'
   *        ],
   *        groupOnColumnId :'categories'
   *    }
   * }
   */


		SlotDefinitionAPI.prototype.getAggregatedSortInfo = function getAggregatedSortInfo() {};

		/**
   * @function SlotDefinitionAPI#isSortable
   * @description Checks whether the slot is sortable or not.
   * @private
   *
   * @return {boolean} Returns true if slot is sortable, otherwise false.
   */


		SlotDefinitionAPI.prototype.isSortable = function isSortable() {};

		/**
   * @function SlotDefinitionAPI#isStackItems
   * @description Checks whether the slot can be have stacked items.
   * @private
   *
   * @return {boolean} Returns true if slot can have stacked items, otherwise false.
   */


		SlotDefinitionAPI.prototype.isStackItems = function isStackItems() {};

		/**
   * @function SlotDefinitionAPI#getMaxItems
   * @description Gets the maximum number of items allowed on a slot.
   * @private
   *
   * @return {Number} Maximum number of items allowed on slot
   */


		SlotDefinitionAPI.prototype.getMaxItems = function getMaxItems() {};

		/**
   * @function SlotDefinitionAPI#isMultiMeasureSupported
   * @description Checks whether the slot can have multiple measures.
   * @private
   *
   * @return {boolean} Returns true if the slot supports multiple measures, otherwise false.
   */


		SlotDefinitionAPI.prototype.isMultiMeasureSupported = function isMultiMeasureSupported() {};

		/**
   * @function SlotDefinitionAPI#isShapable
   * @description Check whether the slot can support graphical shapes.
   * @private
   *
   * @return {boolean} Returns true if the slot supports shapes, otherwise false.
   */


		SlotDefinitionAPI.prototype.isShapable = function isShapable() {};

		/**
   * @function SlotDefinitionAPI#getCoachMark
   * @description Gets the coach mark object for the slot.
   * @private
   *
   * @return {Object} Coach mark object
   * @example
   * {
   * 		titleResource: 'coachMarkTitleSpiralTarget',
   * 		contentResource: 'coachMarkContentSpiralTarget',
   * 		mappedOnly: true,	// show only when the slot is mapped
   * 		showPopover: true	// show popover with the coach mark
   * }
   */


		SlotDefinitionAPI.prototype.getCoachMark = function getCoachMark() {};

		/**
   * @function SlotDefinitionAPI#getFormat
   * @description Gets the slot format.
   * @private
   *
   * @return {Object} Slot formatting
   */


		SlotDefinitionAPI.prototype.getFormat = function getFormat() {};

		/**
   * @function SlotDefinitionAPI#getTags
   * @description Gets the slot tags.
   * Tags identify special uses for slots in a visualization and include:
   * 'badge' - this slot can be marked with a badge (and badge information must be requested for its items)
   * 'ca.dashboard.repeatHere' - This slot is the default where multiMeasure series are assigned (eg: color for a barchart).
   * @private
   *
   * @return {String[]} Slot tags
   */


		SlotDefinitionAPI.prototype.getTags = function getTags() {};

		/**
   * @function SlotDefinitionAPI#getDefaultFromSlot
   * @description Gets the slot information that should be used to default this slot.
   * @private
   * @return {DefaultFromSlot}
   */


		SlotDefinitionAPI.prototype.getDefaultFromSlot = function getDefaultFromSlot() {};

		/**
   * @function SlotDefinitionAPI#getShowRequiredMarker
   * @description Should the required marker be shown in the UI
   * @private
   * @returns {Boolean}
   */


		SlotDefinitionAPI.prototype.getShowRequiredMarker = function getShowRequiredMarker() {};

		return SlotDefinitionAPI;
	}();

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