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

Constructors

constructor

Properties

bpmnElementsRegistry graph navigation

Methods

getVersion load

Constructors

constructor

Properties

Readonly Experimental bpmnElementsRegistry

bpmnElementsRegistry: BpmnElementsRegistry

Interact with BPMN diagram elements rendered in the page.

WARN: subject to change, feedback welcome.

Readonly Experimental graph

graph: BpmnGraph

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

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

Readonly Experimental navigation

navigation: Navigation

Perform BPMN diagram navigation.

WARN: subject to change, feedback welcome.

Since

0.24.0

Methods

getVersion

load

  • load(xml, options?): void

  • Load and render the BPMN diagram.

    Parameters

    • xml: string

      The BPMN content as xml string

    • Optional options: LoadOptions

      Let decide how to load the model and render the diagram

    Returns void

    Throws

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

Settings

Member Visibility

Theme

On This Page

constructorbpmnElementsRegistrygraphnavigationgetVersionload