bpmn-visualization API Documentation
    Preparing search index...

    Class BpmnVisualization

    Let initialize bpmn-visualization. It requires at minimum to pass the HTMLElement in the page where the BPMN diagram is rendered.

    const bpmnVisualization = new BpmnVisualization({ container: 'bpmn-container' });

    For more options, see GlobalOptions

    Implements

    • Disposable
    Index

    Constructors

    constructor

    Properties

    bpmnElementsRegistry graph navigation

    Methods

    dispose load

    Constructors

    Properties

    bpmnElementsRegistry: BpmnElementsRegistry

    Interact with BPMN diagram elements rendered in the page.

    WARN: subject to change, feedback welcome.

    graph: BpmnGraph

    Direct access to the Graph instance that powers bpmn-visualization. It is for advanced users, so please use the lib API first and access to the Graph instance only when there is no alternative.

    WARN: subject to change, could be removed or made available in another way.

    navigation: Navigation

    Perform BPMN diagram navigation.

    WARN: subject to change, feedback welcome.

    0.24.0

    Methods

    • Dispose the BpmnVisualization instance and release all its resources.

      This is particularly useful when you want to remove the BPMN diagram from the page and free the memory or, to clean up or unmount a component that uses a BpmnVisualization instance.

      Returns void

      0.48.0

    • Load and render the BPMN diagram.

      Parameters

      • xml: string

        The BPMN content as xml string

      • Optionaloptions: LoadOptions

        Let decide how to load the model and render the diagram

      Returns void

      Error when loading fails. This is generally due to a parsing error caused by a malformed BPMN content

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods