CoachMarkAPI.js 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. "use strict";
  2. function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
  3. /**
  4. * Licensed Materials - Property of IBM
  5. * IBM Business Analytics (C) Copyright IBM Corp. 2019
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class CoachMarkAPI
  10. * @hideconstructor
  11. * @classdesc API class to allow assets to implement independent functionality for coachmarks
  12. */
  13. define([], function () {
  14. var CoachMarkAPI = function () {
  15. function CoachMarkAPI() {
  16. _classCallCheck(this, CoachMarkAPI);
  17. }
  18. /**
  19. * Add a coachmark dynamically to the UI.
  20. * @public
  21. * @param options - The options parameter takes the following values to add the coachmark:
  22. * id: the identifier for the element to attach the coachmark to,
  23. * domElement: the element to attach the coachmark to,
  24. * title: the title string for the coachmark,
  25. * content: the content string for the coachmark
  26. * @description shows the contents of the current asset before printing
  27. */
  28. CoachMarkAPI.prototype.addCoachMark = function addCoachMark() {};
  29. return CoachMarkAPI;
  30. }();
  31. return CoachMarkAPI;
  32. });
  33. //# sourceMappingURL=CoachMarkAPI.js.map