DataBehindTheVisAPI.js 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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. 2020
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class DataBehindTheVisAPI
  10. * @hideconstructor
  11. * @classdesc
  12. */
  13. define([], function () {
  14. var DataBehindTheVisAPI = function () {
  15. function DataBehindTheVisAPI() {
  16. _classCallCheck(this, DataBehindTheVisAPI);
  17. }
  18. /**
  19. * @public
  20. * @function DataBehindTheVisAPI#getData
  21. * @description Get the data behind the vis
  22. * @param {Boolean} doAggregate boolean value to indicate whether export data is aggregated or disaggregated, Default = true
  23. * @return {Object} dataBehindTheVis data object
  24. */
  25. DataBehindTheVisAPI.prototype.getData = function getData() /*doAggregate*/{};
  26. /**
  27. * @public
  28. * @function DataBehindTheVisAPI#export
  29. * @description Exports the vis data to CSV format
  30. * @param {Boolean} doAggregate boolean value to indicate whether export data is aggregated or disaggregated, Default = true
  31. * @return {Object} dataBehindTheVis data object
  32. * @example
  33. */
  34. DataBehindTheVisAPI.prototype.export = function _export() /*doAggregate*/{};
  35. return DataBehindTheVisAPI;
  36. }();
  37. return DataBehindTheVisAPI;
  38. });
  39. //# sourceMappingURL=DataBehindTheVisAPI.js.map