parent
7a54267536
commit
800f0a3a5a
|
@ -58,11 +58,42 @@ function ensureUnit(val) {
|
||||||
/**
|
/**
|
||||||
* A viewer for BPMN 2.0 diagrams.
|
* A viewer for BPMN 2.0 diagrams.
|
||||||
*
|
*
|
||||||
* Includes the basic viewing functionality.
|
|
||||||
*
|
|
||||||
* Have a look at {@link NavigatedViewer} or {@link Modeler} for bundles that include
|
* Have a look at {@link NavigatedViewer} or {@link Modeler} for bundles that include
|
||||||
* additional features.
|
* additional features.
|
||||||
*
|
*
|
||||||
|
*
|
||||||
|
* ## Extending the Viewer
|
||||||
|
*
|
||||||
|
* In order to extend the viewer pass extension modules to bootstrap via the
|
||||||
|
* `additionalModules` option. An extension module is an object that exposes
|
||||||
|
* named services.
|
||||||
|
*
|
||||||
|
* The following example depicts the integration of a simple
|
||||||
|
* logging component that integrates with interaction events:
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* ```javascript
|
||||||
|
*
|
||||||
|
* // logging component
|
||||||
|
* function InteractionLogger(eventBus) {
|
||||||
|
* eventBus.on('element.hover', function(event) {
|
||||||
|
* console.log()
|
||||||
|
* })
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* InteractionLogger.$inject = [ 'eventBus' ]; // minification save
|
||||||
|
*
|
||||||
|
* // extension module
|
||||||
|
* var extensionModule = {
|
||||||
|
* __init__: [ 'interactionLogger' ],
|
||||||
|
* interactionLogger: [ 'type', InteractionLogger ]
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* // extend the viewer
|
||||||
|
* var bpmnViewer = new Viewer({ additionalModules: [ extensionModule ] });
|
||||||
|
* bpmnViewer.importXML(...);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
* @param {Object} [options] configuration options to pass to the viewer
|
* @param {Object} [options] configuration options to pass to the viewer
|
||||||
* @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
|
* @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
|
||||||
* @param {String|Number} [options.width] the width of the viewer
|
* @param {String|Number} [options.width] the width of the viewer
|
||||||
|
|
Loading…
Reference in New Issue