Viewer.d.ts 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. /**
  2. * A viewer for BPMN 2.0 diagrams.
  3. *
  4. * Have a look at {@link NavigatedViewer} or {@link Modeler} for bundles that include
  5. * additional features.
  6. *
  7. *
  8. * ## Extending the Viewer
  9. *
  10. * In order to extend the viewer pass extension modules to bootstrap via the
  11. * `additionalModules` option. An extension module is an object that exposes
  12. * named services.
  13. *
  14. * The following example depicts the integration of a simple
  15. * logging component that integrates with interaction events:
  16. *
  17. *
  18. * ```javascript
  19. *
  20. * // logging component
  21. * function InteractionLogger(eventBus) {
  22. * eventBus.on('element.hover', function(event) {
  23. * console.log()
  24. * })
  25. * }
  26. *
  27. * InteractionLogger.$inject = [ 'eventBus' ]; // minification save
  28. *
  29. * // extension module
  30. * var extensionModule = {
  31. * __init__: [ 'interactionLogger' ],
  32. * interactionLogger: [ 'type', InteractionLogger ]
  33. * };
  34. *
  35. * // extend the viewer
  36. * var bpmnViewer = new Viewer({ additionalModules: [ extensionModule ] });
  37. * bpmnViewer.importXML(...);
  38. * ```
  39. *
  40. */
  41. export default class Viewer extends BaseViewer {}
  42. type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
  43. import BaseViewer from './BaseViewer';