AssetPrintAPI.js 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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 AssetPrintAPI
  10. * @hideconstructor
  11. * @classdesc API class to allow assets to implement independent functionality for printing
  12. */
  13. define([], function () {
  14. var AssetPrintAPI = function () {
  15. function AssetPrintAPI() {
  16. _classCallCheck(this, AssetPrintAPI);
  17. }
  18. /**
  19. * @public
  20. * @function AssetPrintAPI#showContentsForPrint
  21. * @param content.context the printing context
  22. * @param {array} content.modelIds id's of the different page contents of the asset
  23. * @param {string} content.layoutType type of the layout
  24. * @param {object} content.printPageSize the size of the pdf paper that the user chose
  25. * @param {object} content.pageElement node referring to the root page element of the current view
  26. * @description shows the contents of the current asset before printing
  27. */
  28. AssetPrintAPI.prototype.showContentsForPrint = function showContentsForPrint() {};
  29. /**
  30. * @public
  31. * @function AssetPrintAPI#hideContentsAfterPrint
  32. * @param {array} modelIds id's of the different page contents of the asset
  33. * @param {object} pageElement node referring to the root page element of the current view
  34. * @description hides the contents of the current asset after printing
  35. */
  36. AssetPrintAPI.prototype.hideContentsAfterPrint = function hideContentsAfterPrint() {};
  37. /**
  38. * @function AssetPrintAPI#getOffScreenPageSize
  39. * @description returns the off screen page size of the board
  40. * @param {object} tab scene/tabs of the current asset
  41. */
  42. AssetPrintAPI.prototype.getOffScreenPageSize = function getOffScreenPageSize() {};
  43. return AssetPrintAPI;
  44. }();
  45. return AssetPrintAPI;
  46. });
  47. //# sourceMappingURL=AssetPrintAPI.js.map