PropertiesPaneDOMAPI.js 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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, 2020
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class DashboardServiceabilityAPI
  10. * @hideconstructor
  11. * @classdesc Internal API class that is used to manage the serviceability view.
  12. */
  13. define([], function () {
  14. var PropertiesPaneDOMAPI = function () {
  15. function PropertiesPaneDOMAPI() {
  16. _classCallCheck(this, PropertiesPaneDOMAPI);
  17. }
  18. /**
  19. * @function PropertiesPaneDOMAPI#render
  20. * @description returns the view to be rendered
  21. */
  22. PropertiesPaneDOMAPI.prototype.render = function render() {};
  23. /**
  24. * @function PropertiesPaneDOMAPI#getPropertiesView
  25. * @description creates the property element to render and returns it
  26. * @param {boolean} options.isChild determines whether to render a child element or parent element
  27. * @param {boolean} options.refreshChild determines whether to refresh a child element or create a new child element
  28. * @param {Object} options.data.contentIds an array containing the content id's to get the property element for
  29. * @return {boolean} returns the dom node containing the property for the provided content
  30. */
  31. PropertiesPaneDOMAPI.prototype.getPropertiesView = function getPropertiesView() {};
  32. /**
  33. * @function PropertiesPaneDOMAPI#getProviderId
  34. * @description Returns the provider id for the feature
  35. * @return {String} DOM feature provider id
  36. */
  37. PropertiesPaneDOMAPI.prototype.getProviderId = function getProviderId() {};
  38. /**
  39. * @function PropertiesPaneDOMAPI#getNode
  40. * @description Returns the parent node of the properties pane
  41. * @return {Node} a DOM node which represents the parent node of the properties pane
  42. */
  43. PropertiesPaneDOMAPI.prototype.getRenderNode = function getRenderNode() {};
  44. /**
  45. * @function PropertiesPaneDOMAPI#close
  46. * @description clean up the DOM node which represents this properties pane
  47. */
  48. PropertiesPaneDOMAPI.prototype.close = function close() {};
  49. return PropertiesPaneDOMAPI;
  50. }();
  51. return PropertiesPaneDOMAPI;
  52. });
  53. //# sourceMappingURL=PropertiesPaneDOMAPI.js.map