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

/**
 * @class TimelineAPI
 * @hideconstructor
 * @classdesc API class that is used to control the behaviour of a storytelling timeline instance
 */
define([], function () {
	var TimelineAPI = function () {
		function TimelineAPI() {
			_classCallCheck(this, TimelineAPI);
		}

		/**
   * @function TimelineAPI#addHighlight
   * @param widgetId
   * @param timer
   */
		TimelineAPI.prototype.addHighlight = function addHighlight(widgetId, timer) {
			void widgetId;
			void timer;
		};

		/**
   * @function TimelineAPI#deleteHighlight
   * @param widgetId
   * @param actId
   */


		TimelineAPI.prototype.deleteHighlight = function deleteHighlight(widgetId, actId) {
			void widgetId;
			void actId;
		};

		/**
   * @function TimelineAPI#getEpisode
   * @param id
   */


		TimelineAPI.prototype.getEpisode = function getEpisode(id) {
			void id;
		};

		/**
   * @function TimelineAPI#getEpisodeIDs
   */


		TimelineAPI.prototype.getEpisodeIDs = function getEpisodeIDs() {};

		/**
   * @function TimelineAPI#isHighlightSupported
   * @param widgetId
   */


		TimelineAPI.prototype.isHighlightSupported = function isHighlightSupported(widgetId) {
			void widgetId;
		};

		/**
   * @function TimelineAPI#moveEpisode
   * @param id
   * @param beforeId
   * @param options
   */


		TimelineAPI.prototype.moveEpisode = function moveEpisode(id, beforeId, options) {
			void id;
			void beforeId;
			void options;
		};

		/**
   * @function TimelineAPI#updateEpisodeDuration
   * @param id
   * @param start
   * @param end
   * @param options
   */


		TimelineAPI.prototype.updateEpisodeDuration = function updateEpisodeDuration(id, start, end, options) {
			void id;
			void start;
			void end;
			void options;
		};

		/**
   * @function TimelineAPI#updateHighlight
   * @param widgetId
   * @param actId
   * @param attributes
   */


		TimelineAPI.prototype.updateHighlight = function updateHighlight(widgetId, actId, attributes) {
			void widgetId;
			void actId;
			void attributes;
		};

		return TimelineAPI;
	}();

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