ExpandCollapseAPI.js 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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 expandCollapseAPI
  10. * @hideconstructor
  11. */
  12. define([], function () {
  13. return function () {
  14. function ExpandCollapseAPI() {
  15. _classCallCheck(this, ExpandCollapseAPI);
  16. }
  17. /**
  18. * @description adds detail to a hierarchy dataitem model by including passed in child
  19. * @function expandCollapseAPI#expand
  20. * @public
  21. *
  22. * @param {String} dataItemId unique id representing the dataitem
  23. * @param {String} parentUseValue value representing current parent
  24. * @param {String} currentUseValue value representing child
  25. *
  26. * @return {Promise} resolves when model updated
  27. */
  28. ExpandCollapseAPI.prototype.expand = function expand() /* dataItemId, parentUseValue, currentUseValue */{};
  29. /**
  30. * @description removes detail from a hierarchy dataitem model by removing passed in child
  31. * @function expandCollapseAPI#collapse
  32. * @public
  33. *
  34. * @param {String} dataItemId unique id representing the dataitem
  35. * @param {String} parentUseValue value representing current parent
  36. * @param {String} currentUseValue value representing child
  37. *
  38. * @return {Promise} resolves when model updated
  39. */
  40. ExpandCollapseAPI.prototype.collapse = function collapse() /* dataItemId, parentUseValue, currentUseValue */{};
  41. return ExpandCollapseAPI;
  42. }();
  43. });
  44. //# sourceMappingURL=ExpandCollapseAPI.js.map