diff --git a/api/classes/BpmnCanvas.html b/api/classes/BpmnCanvas.html index 7a7943bf20..ba39637964 100644 --- a/api/classes/BpmnCanvas.html +++ b/api/classes/BpmnCanvas.html @@ -7,7 +7,7 @@

Example

With BpmnCanvas

const canvas = new BpmnCanvas(c, 0.26, 0.35);
canvas.moveTo(8, 39);
canvas.lineTo(12, 25);
-

Constructors

constructor +

Constructors

constructor

Methods

arcTo begin close @@ -28,11 +28,11 @@

Example

With BpmnCanvas

setStrokeColor stroke translateIconOrigin -

Constructors

constructor

Methods

arcTo

begin

close

curveTo

ellipse

fill

fillAndStroke

lineTo

moveTo

rect

rotateOnIconCenter

roundrect

setFillColor

setIconOriginForIconBottomCentered

  • setIconOriginForIconBottomCentered(bottomMargin?): void

  • Set the icon origin to ensure that, on the shape, the icon is horizontally centered and vertically aligned to the bottom.

    -

    Parameters

    • bottomMargin: number = StyleDefault.SHAPE_ACTIVITY_BOTTOM_MARGIN

    Returns void

setIconOriginForIconCentered

setIconOriginToShapeTopLeft

  • setIconOriginToShapeTopLeft(topMargin?, leftMargin?): void

  • Set the icon origin to the top left corner of the shape.

    -

    Parameters

    • topMargin: number = StyleDefault.SHAPE_ACTIVITY_TOP_MARGIN
    • leftMargin: number = StyleDefault.SHAPE_ACTIVITY_LEFT_MARGIN

    Returns void

setRoundLineJoin

setStrokeColor

stroke

translateIconOrigin

  • translateIconOrigin(dx, dy): void

  • Translate the icon origin using the scale factor associated to the horizontal and vertical directions.

    +

Constructors

constructor

Methods

arcTo

begin

close

curveTo

ellipse

fill

fillAndStroke

lineTo

moveTo

rect

rotateOnIconCenter

roundrect

setFillColor

setIconOriginForIconBottomCentered

setIconOriginForIconCentered

setIconOriginToShapeTopLeft

setRoundLineJoin

setStrokeColor

stroke

translateIconOrigin

Settings

Member Visibility

Theme

On This Page

constructorarcTobeginclosecurveToellipsefillfillAndStrokelineTomoveTorectrotateOnIconCenterroundrectsetFillColorsetIconOriginForIconBottomCenteredsetIconOriginForIconCenteredsetIconOriginToShapeTopLeftsetRoundLineJoinsetStrokeColorstroketranslateIconOrigin

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorarcTobeginclosecurveToellipsefillfillAndStrokelineTomoveTorectrotateOnIconCenterroundrectsetFillColorsetIconOriginForIconBottomCenteredsetIconOriginForIconCenteredsetIconOriginToShapeTopLeftsetRoundLineJoinsetStrokeColorstroketranslateIconOrigin

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BpmnElementsRegistry.html b/api/classes/BpmnElementsRegistry.html index 9c9081cb3a..85da019551 100644 --- a/api/classes/BpmnElementsRegistry.html +++ b/api/classes/BpmnElementsRegistry.html @@ -3,7 +3,7 @@ 
// 1. Initialize the BpmnVisualization.
const bpmnVisualization = new BpmnVisualization({ container: 'bpmn-container' });
// 2. Get diagram and load it.
const bpmn = 'BPMN diagram string - whether coming from bpmn.xml file or some API call';
bpmnVisualization.load(bpmn);
// 3. Access registry directly from bpmnVisualization.
bpmnVisualization.bpmnElementsRegistry

WARN: subject to change, feedback welcome.

-

Implements

Methods

addCssClasses +

Implements

Methods

addCssClasses addOverlays getElementsByIds getElementsByKinds @@ -36,13 +36,13 @@

See

-

addOverlays

addOverlays

  • addOverlays(bpmnElementId, overlays): void

  • Add one/several overlays to a BPMN element.

    Notice that if you pass an id that is not related to an existing BPMN element, nothing happens on the rendering side.

    Parameters

    • bpmnElementId: string

      The BPMN id of the element where to add the overlays

    • overlays: Overlay | Overlay[]

      The overlays to add to the BPMN element

    Returns void

    Example

    // Add an overlay to BPMN elements with id 'task_1'
    bpmnVisualization.bpmnElementsRegistry.addOverlays('task_1', {
       position: 'top-left',
       label: '40',
       style: {
         font: { color: 'Chartreuse', size: 8 },
         fill: { color: 'Pink', opacity: 50 },
         stroke: { color: 'DarkSeaGreen', width: 2 }
       }
    });

    // Add several overlays to BPMN element with id 'task_3'
    bpmnVisualization.bpmnElementsRegistry.addOverlays('task_3', [
       {
         position: 'bottom-right',
         label: '110',
         style: {
           font: { color: '#663399', size: 8 },
           fill: { color: '#FFDAB9', opacity: 50 },
           stroke: { color: 'DarkSeaGreen', width: 2 }
         }
       },
       {
         position: 'top-left',
         label: '40',
         style: {
           font: { color: 'MidnightBlue', size: 30 },
           fill: { color: 'Aquamarine', opacity: 70 },
           stroke: { color: '#4B0082', width: 1 }
         }
       }
    ]);
    -

getElementsByIds

getElementsByIds

  • getElementsByIds(bpmnElementIds): BpmnElement[]

  • Get all elements by ids. The returned array contains elements in the order of the bpmnElementIds parameter.

    Not found elements are not returned as undefined in the array, so the returned array contains at most as many elements as the bpmnElementIds parameter.

    ...
    // Find all elements by specified id or ids
    const bpmnElements1 = bpmnVisualization.bpmnElementsRegistry.getElementsByIds('userTask_1');
    const bpmnElements2 = bpmnVisualization.bpmnElementsRegistry.getElementsByIds(['startEvent_3', 'userTask_2']);
    // now you can do whatever you want with the elements
    ...
    @@ -50,27 +50,27 @@

    See

      Attempts to retrieve too many elements, especially on large BPMN diagram, may lead to performance issues.

      If you only need to retrieve the BPMN model data, use getModelElementsByIds instead.

    Parameters

    • bpmnElementIds: string | string[]

      The BPMN ID of the element(s) to retrieve.

      -

    Returns BpmnElement[]

getElementsByKinds

  • getElementsByKinds(bpmnKinds): BpmnElement[]

  • Get all elements by kinds.

    +

Returns BpmnElement[]

getElementsByKinds

  • getElementsByKinds(bpmnKinds): BpmnElement[]

  • Get all elements by kinds.

    ...
    // Find all elements by desired type or types
    const bpmnTaskElements = bpmnVisualization.bpmnElementsRegistry.getElementsByKinds(ShapeBpmnElementKind.TASK);
    const bpmnEndEventAndPoolElements = bpmnVisualization.bpmnElementsRegistry.getElementsByKinds([ShapeBpmnElementKind.EVENT_END, ShapeBpmnElementKind.POOL]);
    // now you can do whatever you want with the elements
    ...

    If you only need to retrieve the BPMN model data, use getModelElementsByKinds instead.

    WARNING: this method is not designed to accept a large amount of types. It does DOM lookup to retrieve the HTML elements relative to the BPMN elements. Attempts to retrieve too many elements, especially on large BPMN diagrams, may lead to performance issues.

    Parameters

    Returns BpmnElement[]

getModelElementsByIds

  • getModelElementsByIds(bpmnElementIds): BpmnSemantic[]

  • Get all model elements in the form of BpmnSemantic objects corresponding to the identifiers supplied. The returned array contains elements in the order of the bpmnElementIds parameter.

    +

Returns BpmnElement[]

getModelElementsByIds

getModelElementsByKinds

getModelElementsByKinds

removeAllCssClasses

removeAllCssClasses

removeAllOverlays

removeAllOverlays

removeCssClasses

removeCssClasses

resetStyle

resetStyle

toggleCssClasses

toggleCssClasses

  • toggleCssClasses(bpmnElementIds, classNames): void

  • Toggle one or more CSS classes on one or more BPMN elements.

    Note: If an ID is passed that does not reference an existing BPMN element, its reference is retained in the registry, but no rendering changes are made.

    Parameters

updateStyle

updateStyle

Settings

Member Visibility

Theme

On This Page

addCssClassesaddOverlaysgetElementsByIdsgetElementsByKindsgetModelElementsByIdsgetModelElementsByKindsremoveAllCssClassesremoveAllOverlaysremoveCssClassesresetStyletoggleCssClassesupdateStyle

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

addCssClassesaddOverlaysgetElementsByIdsgetElementsByKindsgetModelElementsByIdsgetModelElementsByKindsremoveAllCssClassesremoveAllOverlaysremoveCssClassesresetStyletoggleCssClassesupdateStyle

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BpmnVisualization.html b/api/classes/BpmnVisualization.html index 880b5e53b1..70d3040e61 100644 --- a/api/classes/BpmnVisualization.html +++ b/api/classes/BpmnVisualization.html @@ -2,24 +2,24 @@ 
const bpmnVisualization = new BpmnVisualization({ container: 'bpmn-container' });

For more options, see GlobalOptions

-

Constructors

constructor +

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.

+

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. +

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.

+

Readonly Experimental navigation

navigation: Navigation

Perform BPMN diagram navigation.

WARN: subject to change, feedback welcome.

Since

0.24.0

-

Methods

getVersion

Methods

getVersion

load

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

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbpmnElementsRegistrygraphnavigationgetVersionload

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/IconPainter.html b/api/classes/IconPainter.html index a9c9721f13..08945b5d17 100644 --- a/api/classes/IconPainter.html +++ b/api/classes/IconPainter.html @@ -1,6 +1,6 @@ IconPainter | bpmn-visualization API Documentation

Class IconPainterExperimental

Default implementation for the icons.

WARN: You may use it to customize the BPMN Theme as suggested in the examples. But be aware that the way the default BPMN theme can be modified is subject to change.

-

Constructors

constructor +

Constructors

constructor

Methods

newBpmnCanvas paintAsteriskIcon paintCircleIcon @@ -26,26 +26,26 @@ paintXCrossIcon

Constructors

constructor

Methods

Protected newBpmnCanvas

paintAsteriskIcon

paintCircleIcon

paintClockIcon

paintDoubleLeftArrowheadsIcon

paintEnvelopeIcon

paintErrorIcon

paintExpandIcon

paintGearIcon

paintHandIcon

paintListIcon

paintLoopIcon

paintParallelMultiInstanceIcon

paintPentagon

paintPersonIcon

paintPlusCrossIcon

paintRightArrowIcon

paintScriptIcon

paintSequentialMultiInstanceIcon

paintTableIcon

paintTriangleIcon

paintUpArrowheadIcon

paintXCrossIcon

Settings

Member Visibility

Theme

On This Page

constructornewBpmnCanvaspaintAsteriskIconpaintCircleIconpaintClockIconpaintDoubleLeftArrowheadsIconpaintEnvelopeIconpaintErrorIconpaintExpandIconpaintGearIconpaintHandIconpaintListIconpaintLoopIconpaintParallelMultiInstanceIconpaintPentagonpaintPersonIconpaintPlusCrossIconpaintRightArrowIconpaintScriptIconpaintSequentialMultiInstanceIconpaintTableIconpaintTriangleIconpaintUpArrowheadIconpaintXCrossIcon

Generated using TypeDoc

\ No newline at end of file +

Returns BpmnCanvas

paintAsteriskIcon

paintCircleIcon

paintClockIcon

paintDoubleLeftArrowheadsIcon

paintEnvelopeIcon

paintErrorIcon

paintExpandIcon

paintGearIcon

paintHandIcon

paintListIcon

paintLoopIcon

paintParallelMultiInstanceIcon

paintPentagon

paintPersonIcon

paintPlusCrossIcon

paintRightArrowIcon

paintScriptIcon

paintSequentialMultiInstanceIcon

paintTableIcon

paintTriangleIcon

paintUpArrowheadIcon

paintXCrossIcon

Settings

Member Visibility

Theme

On This Page

constructornewBpmnCanvaspaintAsteriskIconpaintCircleIconpaintClockIconpaintDoubleLeftArrowheadsIconpaintEnvelopeIconpaintErrorIconpaintExpandIconpaintGearIconpaintHandIconpaintListIconpaintLoopIconpaintParallelMultiInstanceIconpaintPentagonpaintPersonIconpaintPlusCrossIconpaintRightArrowIconpaintScriptIconpaintSequentialMultiInstanceIconpaintTableIconpaintTriangleIconpaintUpArrowheadIconpaintXCrossIcon

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/IconPainterProvider.html b/api/classes/IconPainterProvider.html index 55a0dd5879..d18acc38e6 100644 --- a/api/classes/IconPainterProvider.html +++ b/api/classes/IconPainterProvider.html @@ -1,6 +1,6 @@ IconPainterProvider | bpmn-visualization API Documentation

Class IconPainterProviderExperimental

Hold the instance of IconPainter used by the BPMN Theme.

WARN: You may use it to customize the BPMN Theme as suggested in the examples. But be aware that the way the default BPMN theme can be modified is subject to change.

-

Constructors

constructor +

Constructors

constructor

Methods

get set -

Constructors

constructor

Methods

Static get

Static set

Settings

Member Visibility

Theme

On This Page

constructorgetset

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

Static get

Static set

Settings

Member Visibility

Theme

On This Page

constructorgetset

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Navigation.html b/api/classes/Navigation.html index 93bb3bf30b..524e30fb97 100644 --- a/api/classes/Navigation.html +++ b/api/classes/Navigation.html @@ -1,7 +1,7 @@ Navigation | bpmn-visualization API Documentation

Class NavigationExperimental

Perform BPMN diagram navigation.

WARN: subject to change, feedback welcome.

Since

0.24.0

-

Constructors

constructor +

Constructors

constructor

Methods

fit zoom -

Constructors

constructor

Methods

fit

zoom

Settings

Member Visibility

Theme

On This Page

constructorfitzoom

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

fit

zoom

Settings

Member Visibility

Theme

On This Page

constructorfitzoom

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ShapeUtil.html b/api/classes/ShapeUtil.html index 16fb966790..debc711c04 100644 --- a/api/classes/ShapeUtil.html +++ b/api/classes/ShapeUtil.html @@ -1,6 +1,6 @@ ShapeUtil | bpmn-visualization API Documentation

Class ShapeUtilExperimental

Utils to simplify the management of ShapeBpmnElementKind.

This class is mainly used for internal purpose. You may use it to customize the BPMN theme as proposed in the examples but be aware it is subject to change.

-

Constructors

constructor +

Constructors

constructor

Methods

activityKinds canHaveNoneEvent eventKinds @@ -20,6 +20,6 @@ isTask isWithDefaultSequenceFlow taskKinds -

Constructors

constructor

Methods

Static activityKinds

Static canHaveNoneEvent

Static eventKinds

Static flowNodeKinds

Static gatewayKinds

Static isActivity

Static isBoundaryEvent

Static isCallActivity

Static isCatchEvent

Static isEvent

Static isGateway

Static isIntermediateCatchEvent

Static isIntermediateThrowEvent

Static isPoolOrLane

Static isStartEvent

Static isSubProcess

Static isTask

Static isWithDefaultSequenceFlow

Static taskKinds

Settings

Member Visibility

Theme

On This Page

constructoractivityKindscanHaveNoneEventeventKindsflowNodeKindsgatewayKindsisActivityisBoundaryEventisCallActivityisCatchEventisEventisGatewayisIntermediateCatchEventisIntermediateThrowEventisPoolOrLaneisStartEventisSubProcessisTaskisWithDefaultSequenceFlowtaskKinds

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

Static activityKinds

Static canHaveNoneEvent

Static eventKinds

Static flowNodeKinds

Static gatewayKinds

Static isActivity

Static isBoundaryEvent

Static isCallActivity

Static isCatchEvent

Static isEvent

Static isGateway

Static isIntermediateCatchEvent

Static isIntermediateThrowEvent

Static isPoolOrLane

Static isStartEvent

Static isSubProcess

Static isTask

Static isWithDefaultSequenceFlow

Static taskKinds

Settings

Member Visibility

Theme

On This Page

constructoractivityKindscanHaveNoneEventeventKindsflowNodeKindsgatewayKindsisActivityisBoundaryEventisCallActivityisCatchEventisEventisGatewayisIntermediateCatchEventisIntermediateThrowEventisPoolOrLaneisStartEventisSubProcessisTaskisWithDefaultSequenceFlowtaskKinds

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/StyleConfigurator.html b/api/classes/StyleConfigurator.html index 3cbb7415fd..47f3a10415 100644 --- a/api/classes/StyleConfigurator.html +++ b/api/classes/StyleConfigurator.html @@ -1,5 +1,5 @@ StyleConfigurator | bpmn-visualization API Documentation

Class StyleConfiguratorExperimental

Configure the styles used for BPMN rendering.

WARN: You may use it to customize the BPMN Theme as suggested in the examples. But be aware that the way the default BPMN theme can be modified is subject to change.

-

Constructors

constructor +

Constructors

constructor

Methods

configureStyles -

Constructors

constructor

Methods

configureStyles

Settings

Member Visibility

Theme

On This Page

constructorconfigureStyles

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

configureStyles

Settings

Member Visibility

Theme

On This Page

constructorconfigureStyles

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/AssociationDirectionKind.html b/api/enums/AssociationDirectionKind.html index d3a4e5b004..71ead3d485 100644 --- a/api/enums/AssociationDirectionKind.html +++ b/api/enums/AssociationDirectionKind.html @@ -1,5 +1,5 @@ AssociationDirectionKind | bpmn-visualization API Documentation

Enumeration AssociationDirectionKind

Enum values are using the real name of the field in the BPMN XSD.

-

Enumeration Members

BOTH +

Enumeration Members

BOTH NONE ONE -

Enumeration Members

BOTH

BOTH: "Both"

NONE

NONE: "None"

ONE

ONE: "One"

Settings

Member Visibility

Theme

On This Page

BOTHNONEONE

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BOTH

BOTH: "Both"

NONE

NONE: "None"

ONE

ONE: "One"

Settings

Member Visibility

Theme

On This Page

BOTHNONEONE

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/FitType.html b/api/enums/FitType.html index d7a9e02b31..b85fd4ab36 100644 --- a/api/enums/FitType.html +++ b/api/enums/FitType.html @@ -1,11 +1,11 @@ -FitType | bpmn-visualization API Documentation

Enumeration FitType

Enumeration Members

Center +FitType | bpmn-visualization API Documentation

Enumeration FitType

Enumeration Members

Center Horizontal HorizontalVertical None Vertical

Enumeration Members

Center

Center: "Center"

Fit and center the BPMN Diagram.

-

Horizontal

Horizontal: "Horizontal"

Fit only horizontally.

-

HorizontalVertical

HorizontalVertical: "HorizontalVertical"

Fit the whole html container available to render the BPMN diagram.

-

None

None: "None"

No fit, use dimensions and coordinates from the BPMN diagram.

-

Vertical

Vertical: "Vertical"

Fit only vertically.

-

Settings

Member Visibility

Theme

On This Page

CenterHorizontalHorizontalVerticalNoneVertical

Generated using TypeDoc

\ No newline at end of file +

Horizontal

Horizontal: "Horizontal"

Fit only horizontally.

+

HorizontalVertical

HorizontalVertical: "HorizontalVertical"

Fit the whole html container available to render the BPMN diagram.

+

None

None: "None"

No fit, use dimensions and coordinates from the BPMN diagram.

+

Vertical

Vertical: "Vertical"

Fit only vertically.

+

Settings

Member Visibility

Theme

On This Page

CenterHorizontalHorizontalVerticalNoneVertical

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/FlowKind.html b/api/enums/FlowKind.html index dda1b730d7..4cc75ced56 100644 --- a/api/enums/FlowKind.html +++ b/api/enums/FlowKind.html @@ -1,5 +1,5 @@ FlowKind | bpmn-visualization API Documentation

Enumeration FlowKind

Enum values are using the real name of the field in the BPMN XSD.

-

Enumeration Members

ASSOCIATION_FLOW +

Enumeration Members

ASSOCIATION_FLOW MESSAGE_FLOW SEQUENCE_FLOW -

Enumeration Members

ASSOCIATION_FLOW

ASSOCIATION_FLOW: "association"

MESSAGE_FLOW

MESSAGE_FLOW: "messageFlow"

SEQUENCE_FLOW

SEQUENCE_FLOW: "sequenceFlow"

Settings

Member Visibility

Theme

On This Page

ASSOCIATION_FLOWMESSAGE_FLOWSEQUENCE_FLOW

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ASSOCIATION_FLOW

ASSOCIATION_FLOW: "association"

MESSAGE_FLOW

MESSAGE_FLOW: "messageFlow"

SEQUENCE_FLOW

SEQUENCE_FLOW: "sequenceFlow"

Settings

Member Visibility

Theme

On This Page

ASSOCIATION_FLOWMESSAGE_FLOWSEQUENCE_FLOW

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/MessageVisibleKind.html b/api/enums/MessageVisibleKind.html index 04ef0c9a86..e75e335694 100644 --- a/api/enums/MessageVisibleKind.html +++ b/api/enums/MessageVisibleKind.html @@ -1,5 +1,5 @@ MessageVisibleKind | bpmn-visualization API Documentation

Enumeration MessageVisibleKind

Enum values are using the real name of the visible message field in the BPMN XSD, except for none that is not present in the specification.

-

Enumeration Members

INITIATING +

Enumeration Members

INITIATING NONE NON_INITIATING -

Enumeration Members

INITIATING

INITIATING: "initiating"

NONE

NONE: "none"

NON_INITIATING

NON_INITIATING: "non_initiating"

Settings

Member Visibility

Theme

On This Page

INITIATINGNONENON_INITIATING

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

INITIATING

INITIATING: "initiating"

NONE

NONE: "none"

NON_INITIATING

NON_INITIATING: "non_initiating"

Settings

Member Visibility

Theme

On This Page

INITIATINGNONENON_INITIATING

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/SequenceFlowKind.html b/api/enums/SequenceFlowKind.html index fa4f05a974..d5f9ee4493 100644 --- a/api/enums/SequenceFlowKind.html +++ b/api/enums/SequenceFlowKind.html @@ -1,6 +1,6 @@ SequenceFlowKind | bpmn-visualization API Documentation

Enumeration SequenceFlowKind

Enum values are used internally to identify sequence the flow markers and to manage their related style.

-

Enumeration Members

CONDITIONAL_FROM_ACTIVITY +

Enumeration Members

CONDITIONAL_FROM_ACTIVITY CONDITIONAL_FROM_GATEWAY DEFAULT NORMAL -

Enumeration Members

CONDITIONAL_FROM_ACTIVITY

CONDITIONAL_FROM_ACTIVITY: "conditional_from_activity"

CONDITIONAL_FROM_GATEWAY

CONDITIONAL_FROM_GATEWAY: "conditional_from_gateway"

DEFAULT

DEFAULT: "default"

NORMAL

NORMAL: "normal"

Settings

Member Visibility

Theme

On This Page

CONDITIONAL_FROM_ACTIVITYCONDITIONAL_FROM_GATEWAYDEFAULTNORMAL

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

CONDITIONAL_FROM_ACTIVITY

CONDITIONAL_FROM_ACTIVITY: "conditional_from_activity"

CONDITIONAL_FROM_GATEWAY

CONDITIONAL_FROM_GATEWAY: "conditional_from_gateway"

DEFAULT

DEFAULT: "default"

NORMAL

NORMAL: "normal"

Settings

Member Visibility

Theme

On This Page

CONDITIONAL_FROM_ACTIVITYCONDITIONAL_FROM_GATEWAYDEFAULTNORMAL

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/ShapeBpmnCallActivityKind.html b/api/enums/ShapeBpmnCallActivityKind.html index e89c0f1be7..a108a6ae60 100644 --- a/api/enums/ShapeBpmnCallActivityKind.html +++ b/api/enums/ShapeBpmnCallActivityKind.html @@ -1,3 +1,3 @@ -ShapeBpmnCallActivityKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnCallActivityKind

Enumeration Members

CALLING_GLOBAL_TASK +ShapeBpmnCallActivityKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnCallActivityKind

Enumeration Members

CALLING_GLOBAL_TASK CALLING_PROCESS -

Enumeration Members

CALLING_GLOBAL_TASK

CALLING_GLOBAL_TASK: "global task"

CALLING_PROCESS

CALLING_PROCESS: "process"

Settings

Member Visibility

Theme

On This Page

CALLING_GLOBAL_TASKCALLING_PROCESS

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

CALLING_GLOBAL_TASK

CALLING_GLOBAL_TASK: "global task"

CALLING_PROCESS

CALLING_PROCESS: "process"

Settings

Member Visibility

Theme

On This Page

CALLING_GLOBAL_TASKCALLING_PROCESS

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/ShapeBpmnElementKind.html b/api/enums/ShapeBpmnElementKind.html index 652d144d62..8790989c85 100644 --- a/api/enums/ShapeBpmnElementKind.html +++ b/api/enums/ShapeBpmnElementKind.html @@ -1,5 +1,5 @@ ShapeBpmnElementKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnElementKind

The real name of the field in the BPMN XSD.

-

Enumeration Members

CALL_ACTIVITY +

Enumeration Members

CALL_ACTIVITY EVENT_BOUNDARY EVENT_END EVENT_INTERMEDIATE_CATCH @@ -28,4 +28,4 @@ TASK_SERVICE TASK_USER TEXT_ANNOTATION -

Enumeration Members

CALL_ACTIVITY

CALL_ACTIVITY: "callActivity"

EVENT_BOUNDARY

EVENT_BOUNDARY: "boundaryEvent"

EVENT_END

EVENT_END: "endEvent"

EVENT_INTERMEDIATE_CATCH

EVENT_INTERMEDIATE_CATCH: "intermediateCatchEvent"

EVENT_INTERMEDIATE_THROW

EVENT_INTERMEDIATE_THROW: "intermediateThrowEvent"

EVENT_START

EVENT_START: "startEvent"

GATEWAY_COMPLEX

GATEWAY_COMPLEX: "complexGateway"

GATEWAY_EVENT_BASED

GATEWAY_EVENT_BASED: "eventBasedGateway"

GATEWAY_EXCLUSIVE

GATEWAY_EXCLUSIVE: "exclusiveGateway"

GATEWAY_INCLUSIVE

GATEWAY_INCLUSIVE: "inclusiveGateway"

GATEWAY_PARALLEL

GATEWAY_PARALLEL: "parallelGateway"

GLOBAL_TASK

GLOBAL_TASK: "globalTask"

GLOBAL_TASK_BUSINESS_RULE

GLOBAL_TASK_BUSINESS_RULE: "globalBusinessRuleTask"

GLOBAL_TASK_MANUAL

GLOBAL_TASK_MANUAL: "globalManualTask"

GLOBAL_TASK_SCRIPT

GLOBAL_TASK_SCRIPT: "globalScriptTask"

GLOBAL_TASK_USER

GLOBAL_TASK_USER: "globalUserTask"

GROUP

GROUP: "group"

LANE

LANE: "lane"

POOL

POOL: "pool"

SUB_PROCESS

SUB_PROCESS: "subProcess"

TASK

TASK: "task"

TASK_BUSINESS_RULE

TASK_BUSINESS_RULE: "businessRuleTask"

TASK_MANUAL

TASK_MANUAL: "manualTask"

TASK_RECEIVE

TASK_RECEIVE: "receiveTask"

TASK_SCRIPT

TASK_SCRIPT: "scriptTask"

TASK_SEND

TASK_SEND: "sendTask"

TASK_SERVICE

TASK_SERVICE: "serviceTask"

TASK_USER

TASK_USER: "userTask"

TEXT_ANNOTATION

TEXT_ANNOTATION: "textAnnotation"

Settings

Member Visibility

Theme

On This Page

CALL_ACTIVITYEVENT_BOUNDARYEVENT_ENDEVENT_INTERMEDIATE_CATCHEVENT_INTERMEDIATE_THROWEVENT_STARTGATEWAY_COMPLEXGATEWAY_EVENT_BASEDGATEWAY_EXCLUSIVEGATEWAY_INCLUSIVEGATEWAY_PARALLELGLOBAL_TASKGLOBAL_TASK_BUSINESS_RULEGLOBAL_TASK_MANUALGLOBAL_TASK_SCRIPTGLOBAL_TASK_USERGROUPLANEPOOLSUB_PROCESSTASKTASK_BUSINESS_RULETASK_MANUALTASK_RECEIVETASK_SCRIPTTASK_SENDTASK_SERVICETASK_USERTEXT_ANNOTATION

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

CALL_ACTIVITY

CALL_ACTIVITY: "callActivity"

EVENT_BOUNDARY

EVENT_BOUNDARY: "boundaryEvent"

EVENT_END

EVENT_END: "endEvent"

EVENT_INTERMEDIATE_CATCH

EVENT_INTERMEDIATE_CATCH: "intermediateCatchEvent"

EVENT_INTERMEDIATE_THROW

EVENT_INTERMEDIATE_THROW: "intermediateThrowEvent"

EVENT_START

EVENT_START: "startEvent"

GATEWAY_COMPLEX

GATEWAY_COMPLEX: "complexGateway"

GATEWAY_EVENT_BASED

GATEWAY_EVENT_BASED: "eventBasedGateway"

GATEWAY_EXCLUSIVE

GATEWAY_EXCLUSIVE: "exclusiveGateway"

GATEWAY_INCLUSIVE

GATEWAY_INCLUSIVE: "inclusiveGateway"

GATEWAY_PARALLEL

GATEWAY_PARALLEL: "parallelGateway"

GLOBAL_TASK

GLOBAL_TASK: "globalTask"

GLOBAL_TASK_BUSINESS_RULE

GLOBAL_TASK_BUSINESS_RULE: "globalBusinessRuleTask"

GLOBAL_TASK_MANUAL

GLOBAL_TASK_MANUAL: "globalManualTask"

GLOBAL_TASK_SCRIPT

GLOBAL_TASK_SCRIPT: "globalScriptTask"

GLOBAL_TASK_USER

GLOBAL_TASK_USER: "globalUserTask"

GROUP

GROUP: "group"

LANE

LANE: "lane"

POOL

POOL: "pool"

SUB_PROCESS

SUB_PROCESS: "subProcess"

TASK

TASK: "task"

TASK_BUSINESS_RULE

TASK_BUSINESS_RULE: "businessRuleTask"

TASK_MANUAL

TASK_MANUAL: "manualTask"

TASK_RECEIVE

TASK_RECEIVE: "receiveTask"

TASK_SCRIPT

TASK_SCRIPT: "scriptTask"

TASK_SEND

TASK_SEND: "sendTask"

TASK_SERVICE

TASK_SERVICE: "serviceTask"

TASK_USER

TASK_USER: "userTask"

TEXT_ANNOTATION

TEXT_ANNOTATION: "textAnnotation"

Settings

Member Visibility

Theme

On This Page

CALL_ACTIVITYEVENT_BOUNDARYEVENT_ENDEVENT_INTERMEDIATE_CATCHEVENT_INTERMEDIATE_THROWEVENT_STARTGATEWAY_COMPLEXGATEWAY_EVENT_BASEDGATEWAY_EXCLUSIVEGATEWAY_INCLUSIVEGATEWAY_PARALLELGLOBAL_TASKGLOBAL_TASK_BUSINESS_RULEGLOBAL_TASK_MANUALGLOBAL_TASK_SCRIPTGLOBAL_TASK_USERGROUPLANEPOOLSUB_PROCESSTASKTASK_BUSINESS_RULETASK_MANUALTASK_RECEIVETASK_SCRIPTTASK_SENDTASK_SERVICETASK_USERTEXT_ANNOTATION

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/ShapeBpmnEventBasedGatewayKind.html b/api/enums/ShapeBpmnEventBasedGatewayKind.html index c4343c5210..674aaf286e 100644 --- a/api/enums/ShapeBpmnEventBasedGatewayKind.html +++ b/api/enums/ShapeBpmnEventBasedGatewayKind.html @@ -1,6 +1,6 @@ ShapeBpmnEventBasedGatewayKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnEventBasedGatewayKind

Values available for the eventGatewayType property in the BPMN specification.

-

Enumeration Members

Exclusive +

Enumeration Members

Exclusive None Parallel -

Enumeration Members

Exclusive

Exclusive: "Exclusive"

None

None: "None"

When no type is provided in the BPMN source.

-

Parallel

Parallel: "Parallel"

Settings

Member Visibility

Theme

On This Page

ExclusiveNoneParallel

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Exclusive

Exclusive: "Exclusive"

None

None: "None"

When no type is provided in the BPMN source.

+

Parallel

Parallel: "Parallel"

Settings

Member Visibility

Theme

On This Page

ExclusiveNoneParallel

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/ShapeBpmnEventDefinitionKind.html b/api/enums/ShapeBpmnEventDefinitionKind.html index e2bb37e798..8852f1a8cf 100644 --- a/api/enums/ShapeBpmnEventDefinitionKind.html +++ b/api/enums/ShapeBpmnEventDefinitionKind.html @@ -1,6 +1,6 @@ ShapeBpmnEventDefinitionKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnEventDefinitionKind

Base name of the EventDefinition fields in the BPMN XSD for event kinds. In the xsd, the value is EventDefinition.

For instance, TERMINATE --> terminateEventDefinition

-

Enumeration Members

CANCEL +

Enumeration Members

CANCEL COMPENSATION CONDITIONAL ERROR @@ -11,4 +11,4 @@ SIGNAL TERMINATE TIMER -

Enumeration Members

CANCEL

CANCEL: "cancel"

COMPENSATION

COMPENSATION: "compensate"

CONDITIONAL

CONDITIONAL: "conditional"

ERROR

ERROR: "error"

ESCALATION

ESCALATION: "escalation"

LINK

LINK: "link"

MESSAGE

MESSAGE: "message"

NONE

NONE: "none"

SIGNAL

SIGNAL: "signal"

TERMINATE

TERMINATE: "terminate"

TIMER

TIMER: "timer"

Settings

Member Visibility

Theme

On This Page

CANCELCOMPENSATIONCONDITIONALERRORESCALATIONLINKMESSAGENONESIGNALTERMINATETIMER

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

CANCEL

CANCEL: "cancel"

COMPENSATION

COMPENSATION: "compensate"

CONDITIONAL

CONDITIONAL: "conditional"

ERROR

ERROR: "error"

ESCALATION

ESCALATION: "escalation"

LINK

LINK: "link"

MESSAGE

MESSAGE: "message"

NONE

NONE: "none"

SIGNAL

SIGNAL: "signal"

TERMINATE

TERMINATE: "terminate"

TIMER

TIMER: "timer"

Settings

Member Visibility

Theme

On This Page

CANCELCOMPENSATIONCONDITIONALERRORESCALATIONLINKMESSAGENONESIGNALTERMINATETIMER

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/ShapeBpmnMarkerKind.html b/api/enums/ShapeBpmnMarkerKind.html index 7643db5c11..a3efae2a54 100644 --- a/api/enums/ShapeBpmnMarkerKind.html +++ b/api/enums/ShapeBpmnMarkerKind.html @@ -1,7 +1,7 @@ -ShapeBpmnMarkerKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnMarkerKind

Enumeration Members

ADHOC +ShapeBpmnMarkerKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnMarkerKind

Enumeration Members

ADHOC COMPENSATION EXPAND LOOP MULTI_INSTANCE_PARALLEL MULTI_INSTANCE_SEQUENTIAL -

Enumeration Members

ADHOC

ADHOC: "adhoc"

COMPENSATION

COMPENSATION: "compensation"

EXPAND

EXPAND: "expand"

LOOP

LOOP: "loop"

MULTI_INSTANCE_PARALLEL

MULTI_INSTANCE_PARALLEL: "parallel multi instance"

MULTI_INSTANCE_SEQUENTIAL

MULTI_INSTANCE_SEQUENTIAL: "sequential multi instance"

Settings

Member Visibility

Theme

On This Page

ADHOCCOMPENSATIONEXPANDLOOPMULTI_INSTANCE_PARALLELMULTI_INSTANCE_SEQUENTIAL

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ADHOC

ADHOC: "adhoc"

COMPENSATION

COMPENSATION: "compensation"

EXPAND

EXPAND: "expand"

LOOP

LOOP: "loop"

MULTI_INSTANCE_PARALLEL

MULTI_INSTANCE_PARALLEL: "parallel multi instance"

MULTI_INSTANCE_SEQUENTIAL

MULTI_INSTANCE_SEQUENTIAL: "sequential multi instance"

Settings

Member Visibility

Theme

On This Page

ADHOCCOMPENSATIONEXPANDLOOPMULTI_INSTANCE_PARALLELMULTI_INSTANCE_SEQUENTIAL

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/ShapeBpmnSubProcessKind.html b/api/enums/ShapeBpmnSubProcessKind.html index 439b2e2f90..1a34d60bb1 100644 --- a/api/enums/ShapeBpmnSubProcessKind.html +++ b/api/enums/ShapeBpmnSubProcessKind.html @@ -1,5 +1,5 @@ -ShapeBpmnSubProcessKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnSubProcessKind

Enumeration Members

AD_HOC +ShapeBpmnSubProcessKind | bpmn-visualization API Documentation

Enumeration ShapeBpmnSubProcessKind

Enumeration Members

AD_HOC EMBEDDED EVENT TRANSACTION -

Enumeration Members

AD_HOC

AD_HOC: "adhoc"

EMBEDDED

EMBEDDED: "embedded"

EVENT

EVENT: "event"

TRANSACTION

TRANSACTION: "transaction"

Settings

Member Visibility

Theme

On This Page

AD_HOCEMBEDDEDEVENTTRANSACTION

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

AD_HOC

AD_HOC: "adhoc"

EMBEDDED

EMBEDDED: "embedded"

EVENT

EVENT: "event"

TRANSACTION

TRANSACTION: "transaction"

Settings

Member Visibility

Theme

On This Page

AD_HOCEMBEDDEDEVENTTRANSACTION

Generated using TypeDoc

\ No newline at end of file diff --git a/api/enums/ZoomType.html b/api/enums/ZoomType.html index 21b528e380..4c7411bbaa 100644 --- a/api/enums/ZoomType.html +++ b/api/enums/ZoomType.html @@ -1,4 +1,4 @@ ZoomType | bpmn-visualization API Documentation

Enumeration ZoomType

Since

0.24.0

-

Enumeration Members

In +

Enumeration Members

In Out -

Enumeration Members

In

In: "in"

Out

Out: "out"

Settings

Member Visibility

Theme

On This Page

InOut

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

In

In: "in"

Out

Out: "out"

Settings

Member Visibility

Theme

On This Page

InOut

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/getVersion.html b/api/functions/getVersion.html index 69208309f4..b9f456bd5b 100644 --- a/api/functions/getVersion.html +++ b/api/functions/getVersion.html @@ -1,3 +1,3 @@ getVersion | bpmn-visualization API Documentation

Function getVersion

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/BaseBpmnSemantic.html b/api/interfaces/BaseBpmnSemantic.html index 575ad10d43..5dcab60a14 100644 --- a/api/interfaces/BaseBpmnSemantic.html +++ b/api/interfaces/BaseBpmnSemantic.html @@ -1,6 +1,6 @@ -BaseBpmnSemantic | bpmn-visualization API Documentation

Interface BaseBpmnSemantic

interface BaseBpmnSemantic {
    id: string;
    isShape: boolean;
    kind: BpmnElementKind;
    name: string;
}

Hierarchy (view full)

Properties

id +BaseBpmnSemantic | bpmn-visualization API Documentation

Interface BaseBpmnSemantic

interface BaseBpmnSemantic {
    id: string;
    isShape: boolean;
    kind: BpmnElementKind;
    name: string;
}

Hierarchy (view full)

Properties

id isShape kind name -

Properties

id

id: string

isShape

isShape: boolean

true when relates to a BPMN Shape, false when relates to a BPMN Edge.

-

kind

kind: BpmnElementKind

name

name: string

Settings

Member Visibility

Theme

On This Page

idisShapekindname

Generated using TypeDoc

\ No newline at end of file +

Properties

id

id: string

isShape

isShape: boolean

true when relates to a BPMN Shape, false when relates to a BPMN Edge.

+

kind

kind: BpmnElementKind

name

name: string

Settings

Member Visibility

Theme

On This Page

idisShapekindname

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/BpmnCanvasConfiguration.html b/api/interfaces/BpmnCanvasConfiguration.html index 4d9beafdcf..26b4377230 100644 --- a/api/interfaces/BpmnCanvasConfiguration.html +++ b/api/interfaces/BpmnCanvasConfiguration.html @@ -1,5 +1,5 @@ BpmnCanvasConfiguration | bpmn-visualization API Documentation

Interface BpmnCanvasConfigurationExperimental

WARN: You may use it to customize the BPMN Theme as suggested in the examples. But be aware that the way the default BPMN theme can be modified is subject to change.

-
interface BpmnCanvasConfiguration {
    canvas: mxAbstractCanvas2D;
    iconConfig: IconConfiguration;
    shapeConfig: ShapeConfiguration;
}

Properties

canvas +
interface BpmnCanvasConfiguration {
    canvas: mxAbstractCanvas2D;
    iconConfig: IconConfiguration;
    shapeConfig: ShapeConfiguration;
}

Properties

canvas iconConfig shapeConfig -

Properties

canvas

canvas: mxAbstractCanvas2D

iconConfig

iconConfig: IconConfiguration

shapeConfig

shapeConfig: ShapeConfiguration

Settings

Member Visibility

Theme

On This Page

canvasiconConfigshapeConfig

Generated using TypeDoc

\ No newline at end of file +

Properties

canvas

canvas: mxAbstractCanvas2D

iconConfig

iconConfig: IconConfiguration

shapeConfig

shapeConfig: ShapeConfiguration

Settings

Member Visibility

Theme

On This Page

canvasiconConfigshapeConfig

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/BpmnElement.html b/api/interfaces/BpmnElement.html index e6ac695e52..406189b1ef 100644 --- a/api/interfaces/BpmnElement.html +++ b/api/interfaces/BpmnElement.html @@ -1,3 +1,3 @@ -BpmnElement | bpmn-visualization API Documentation

Interface BpmnElement

interface BpmnElement {
    bpmnSemantic: BpmnSemantic;
    htmlElement: HTMLElement;
}

Properties

bpmnSemantic +BpmnElement | bpmn-visualization API Documentation

Interface BpmnElement

interface BpmnElement {
    bpmnSemantic: BpmnSemantic;
    htmlElement: HTMLElement;
}

Properties

bpmnSemantic htmlElement -

Properties

bpmnSemantic

bpmnSemantic: BpmnSemantic

htmlElement

htmlElement: HTMLElement

Settings

Member Visibility

Theme

On This Page

bpmnSemantichtmlElement

Generated using TypeDoc

\ No newline at end of file +

Properties

bpmnSemantic

bpmnSemantic: BpmnSemantic

htmlElement

htmlElement: HTMLElement

Settings

Member Visibility

Theme

On This Page

bpmnSemantichtmlElement

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/CssClassesRegistry.html b/api/interfaces/CssClassesRegistry.html index 7b64643c64..7ea221349e 100644 --- a/api/interfaces/CssClassesRegistry.html +++ b/api/interfaces/CssClassesRegistry.html @@ -1,4 +1,4 @@ -CssClassesRegistry | bpmn-visualization API Documentation

Interface CssClassesRegistry

interface CssClassesRegistry {
    addCssClasses(bpmnElementIds, classNames): void;
    removeAllCssClasses(bpmnElementIds?): void;
    removeCssClasses(bpmnElementIds, classNames): void;
    toggleCssClasses(bpmnElementIds, classNames): void;
}

Implemented by

Methods

addCssClasses +CssClassesRegistry | bpmn-visualization API Documentation

Interface CssClassesRegistry

interface CssClassesRegistry {
    addCssClasses(bpmnElementIds, classNames): void;
    removeAllCssClasses(bpmnElementIds?): void;
    removeCssClasses(bpmnElementIds, classNames): void;
    toggleCssClasses(bpmnElementIds, classNames): void;
}

Implemented by

Methods

addCssClasses removeAllCssClasses removeCssClasses toggleCssClasses @@ -23,7 +23,7 @@

See

-

removeAllCssClasses

removeAllCssClasses

  • removeAllCssClasses(bpmnElementIds?): void

  • Remove any CSS classes that were previously added to one or more BPMN elements using the addCssClasses or the toggleCssClasses methods.

    Note: If you pass IDs that are not related to existing BPMN elements, they will be ignored and no changes will be made to the rendering.

    Parameters

    • Optional bpmnElementIds: string | string[]

      The BPMN ID of the element(s) from which to remove all CSS classes. When passing a nullish parameter, all CSS classes associated with all BPMN elements will be removed. Passing an empty array has no effect.

      @@ -31,14 +31,14 @@

      See

        See

        removeCssClasses to remove specific classes from a BPMN element.

        Since

        0.34.0

        -

removeCssClasses

removeCssClasses

  • removeCssClasses(bpmnElementIds, classNames): void

  • Remove one or more CSS classes that were previously added to one or more BPMN elements using the addCssClasses or the toggleCssClasses methods.

    Note: If you pass IDs that are not related to existing BPMN elements, they will be ignored and no changes will be made to the rendering.

    Parameters

    • bpmnElementIds: string | string[]

      The BPMN ID of the element(s) from which to remove the CSS classes. Passing a nullish parameter or an empty array has no effect.

    • classNames: string | string[]

      The name of the class(es) to remove from the BPMN element(s).

    Returns void

    Example

    // Remove 'highlight' from BPMN elements with ID: activity_1 and activity_2
    bpmnVisualization.bpmnElementsRegistry.removeCssClasses(['activity_1', 'activity_2'], 'highlight');

    // Remove 'running' and 'additional-info' from BPMN element with ID: task_3
    bpmnVisualization.bpmnElementsRegistry.removeCssClasses('task_3', ['running', 'additional-info']);

    See

    removeAllCssClasses to remove all CSS classes from a BPMN element.

    -

toggleCssClasses

  • toggleCssClasses(bpmnElementIds, classNames): void

  • Toggle one or more CSS classes on one or more BPMN elements.

    +

toggleCssClasses

  • toggleCssClasses(bpmnElementIds, classNames): void

  • Toggle one or more CSS classes on one or more BPMN elements.

    Note: If an ID is passed that does not reference an existing BPMN element, its reference is retained in the registry, but no rendering changes are made.

    Parameters

    • bpmnElementIds: string | string[]

      The BPMN ID of the element(s) on which to toggle the CSS classes. Passing a nullish parameter or an empty array has no effect.

    • classNames: string | string[]

      The name of the class(es) to toggle on the BPMN element(s).

      @@ -49,4 +49,4 @@

      See

      -

Settings

Member Visibility

Theme

On This Page

addCssClassesremoveAllCssClassesremoveCssClassestoggleCssClasses

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

addCssClassesremoveAllCssClassesremoveCssClassestoggleCssClasses

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/EdgeBpmnSemantic.html b/api/interfaces/EdgeBpmnSemantic.html index 037d642390..c0a46ad8c8 100644 --- a/api/interfaces/EdgeBpmnSemantic.html +++ b/api/interfaces/EdgeBpmnSemantic.html @@ -1,9 +1,9 @@ EdgeBpmnSemantic | bpmn-visualization API Documentation

Interface EdgeBpmnSemantic

Extended properties available when BaseBpmnSemantic.isShape is false.

-
interface EdgeBpmnSemantic {
    id: string;
    isShape: boolean;
    kind: BpmnElementKind;
    name: string;
    sourceRefId: string;
    targetRefId: string;
}

Hierarchy (view full)

Properties

id +
interface EdgeBpmnSemantic {
    id: string;
    isShape: boolean;
    kind: BpmnElementKind;
    name: string;
    sourceRefId: string;
    targetRefId: string;
}

Hierarchy (view full)

Properties

id isShape kind name sourceRefId targetRefId -

Properties

id

id: string

isShape

isShape: boolean

true when relates to a BPMN Shape, false when relates to a BPMN Edge.

-

kind

kind: BpmnElementKind

name

name: string

sourceRefId

sourceRefId: string

targetRefId

targetRefId: string

Settings

Member Visibility

Theme

On This Page

idisShapekindnamesourceRefIdtargetRefId

Generated using TypeDoc

\ No newline at end of file +

Properties

id

id: string

isShape

isShape: boolean

true when relates to a BPMN Shape, false when relates to a BPMN Edge.

+

kind

kind: BpmnElementKind

name

name: string

sourceRefId

sourceRefId: string

targetRefId

targetRefId: string

Settings

Member Visibility

Theme

On This Page

idisShapekindnamesourceRefIdtargetRefId

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ElementsRegistry.html b/api/interfaces/ElementsRegistry.html index 362c390786..a9c0344f66 100644 --- a/api/interfaces/ElementsRegistry.html +++ b/api/interfaces/ElementsRegistry.html @@ -1,4 +1,4 @@ -ElementsRegistry | bpmn-visualization API Documentation

Interface ElementsRegistry

interface ElementsRegistry {
    getElementsByIds(bpmnElementIds): BpmnElement[];
    getElementsByKinds(bpmnKinds): BpmnElement[];
    getModelElementsByIds(bpmnElementIds): BpmnSemantic[];
    getModelElementsByKinds(bpmnKinds): BpmnSemantic[];
}

Implemented by

Methods

getElementsByIds +ElementsRegistry | bpmn-visualization API Documentation

Interface ElementsRegistry

interface ElementsRegistry {
    getElementsByIds(bpmnElementIds): BpmnElement[];
    getElementsByKinds(bpmnKinds): BpmnElement[];
    getModelElementsByIds(bpmnElementIds): BpmnSemantic[];
    getModelElementsByKinds(bpmnKinds): BpmnSemantic[];
}

Implemented by

Methods

getElementsByIds getElementsByKinds getModelElementsByIds getModelElementsByKinds @@ -10,24 +10,24 @@ Attempts to retrieve too many elements, especially on large BPMN diagram, may lead to performance issues.

If you only need to retrieve the BPMN model data, use getModelElementsByIds instead.

Parameters

  • bpmnElementIds: string | string[]

    The BPMN ID of the element(s) to retrieve.

    -

Returns BpmnElement[]

getElementsByKinds

  • getElementsByKinds(bpmnKinds): BpmnElement[]

  • Get all elements by kinds.

    +

Returns BpmnElement[]

getElementsByKinds

  • getElementsByKinds(bpmnKinds): BpmnElement[]

  • Get all elements by kinds.

    ...
    // Find all elements by desired type or types
    const bpmnTaskElements = bpmnVisualization.bpmnElementsRegistry.getElementsByKinds(ShapeBpmnElementKind.TASK);
    const bpmnEndEventAndPoolElements = bpmnVisualization.bpmnElementsRegistry.getElementsByKinds([ShapeBpmnElementKind.EVENT_END, ShapeBpmnElementKind.POOL]);
    // now you can do whatever you want with the elements
    ...

    If you only need to retrieve the BPMN model data, use getModelElementsByKinds instead.

    WARNING: this method is not designed to accept a large amount of types. It does DOM lookup to retrieve the HTML elements relative to the BPMN elements. Attempts to retrieve too many elements, especially on large BPMN diagrams, may lead to performance issues.

    Parameters

    Returns BpmnElement[]

getModelElementsByIds

  • getModelElementsByIds(bpmnElementIds): BpmnSemantic[]

  • Get all model elements in the form of BpmnSemantic objects corresponding to the identifiers supplied. The returned array contains elements in the order of the bpmnElementIds parameter.

    +

Returns BpmnElement[]

getModelElementsByIds

  • getModelElementsByIds(bpmnElementIds): BpmnSemantic[]

  • Get all model elements in the form of BpmnSemantic objects corresponding to the identifiers supplied. The returned array contains elements in the order of the bpmnElementIds parameter.

    Not found elements are not returned as undefined in the array, so the returned array contains at most as many elements as the bpmnElementIds parameter.

    ...
    // Find all elements by specified id or ids
    const bpmnElements1 = bpmnVisualization.bpmnElementsRegistry.getModelElementsByIds('userTask_1');
    const bpmnElements2 = bpmnVisualization.bpmnElementsRegistry.getModelElementsByIds(['startEvent_3', 'userTask_2']);
    // now you can do whatever you want with the elements
    ...

    If you also need to retrieve the related DOM elements and more information, use getElementsByIds instead.

    Parameters

    • bpmnElementIds: string | string[]

      The BPMN ID of the element(s) to retrieve.

    Returns BpmnSemantic[]

    Since

    0.39.0

    -

getModelElementsByKinds

getModelElementsByKinds

  • getModelElementsByKinds(bpmnKinds): BpmnSemantic[]

  • Get all model elements in the form of BpmnSemantic objects corresponding to the BPMN kinds supplied

    ...
    // Find all elements by desired kind or kinds
    const bpmnElements1 = bpmnVisualization.bpmnElementsRegistry.getModelElementsByKinds(ShapeBpmnElementKind.TASK);
    const bpmnElements2 = bpmnVisualization.bpmnElementsRegistry.getModelElementsByKinds([ShapeBpmnElementKind.EVENT_END, ShapeBpmnElementKind.POOL]);
    // now you can do whatever you want with the elements
    ...

    If you also need to retrieve the related DOM elements and more information, use getElementsByKinds instead.

    Parameters

    Returns BpmnSemantic[]

    Since

    0.39.0

    -

Settings

Member Visibility

Theme

On This Page

getElementsByIdsgetElementsByKindsgetModelElementsByIdsgetModelElementsByKinds

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

getElementsByIdsgetElementsByKindsgetModelElementsByIdsgetModelElementsByKinds

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/FitOptions.html b/api/interfaces/FitOptions.html index 4c0613094b..e9ac999b34 100644 --- a/api/interfaces/FitOptions.html +++ b/api/interfaces/FitOptions.html @@ -1,8 +1,8 @@ -FitOptions | bpmn-visualization API Documentation

Interface FitOptions

interface FitOptions {
    margin?: number;
    type?: FitType;
}

Properties

margin? +FitOptions | bpmn-visualization API Documentation

Interface FitOptions

interface FitOptions {
    margin?: number;
    type?: FitType;
}

Properties

margin? type?

Properties

Optional margin

margin?: number

Negative values fallback to default.

Default

0
-

Optional type

type?: FitType

Default

{@link FitType.None}
+

Optional type

type?: FitType

Default

{@link FitType.None}
-

Settings

Member Visibility

Theme

On This Page

margintype

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

margintype

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/GlobalOptions.html b/api/interfaces/GlobalOptions.html index 81a0bf47bf..f4260c3c24 100644 --- a/api/interfaces/GlobalOptions.html +++ b/api/interfaces/GlobalOptions.html @@ -1,10 +1,10 @@ GlobalOptions | bpmn-visualization API Documentation

Interface GlobalOptions

Options to configure the bpmn-visualization initialization.

-
interface GlobalOptions {
    container: string | HTMLElement;
    navigation?: NavigationConfiguration;
    parser?: ParserOptions;
    renderer?: RendererOptions;
}

Properties

container +
interface GlobalOptions {
    container: string | HTMLElement;
    navigation?: NavigationConfiguration;
    parser?: ParserOptions;
    renderer?: RendererOptions;
}

Properties

container navigation? parser? renderer?

Properties

container

container: string | HTMLElement

The id of a DOM element or an HTML node where the BPMN diagram is rendered.

-

Optional navigation

navigation?: NavigationConfiguration

Configure the BPMN diagram navigation (panning and zoom).

-

Optional parser

parser?: ParserOptions

Configure the BPMN parser.

-

Optional renderer

renderer?: RendererOptions

Configure how the BPMN diagram and its elements are rendered.

-

Settings

Member Visibility

Theme

On This Page

containernavigationparserrenderer

Generated using TypeDoc

\ No newline at end of file +

Optional navigation

navigation?: NavigationConfiguration

Configure the BPMN diagram navigation (panning and zoom).

+

Optional parser

parser?: ParserOptions

Configure the BPMN parser.

+

Optional renderer

renderer?: RendererOptions

Configure how the BPMN diagram and its elements are rendered.

+

Settings

Member Visibility

Theme

On This Page

containernavigationparserrenderer

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IconConfiguration.html b/api/interfaces/IconConfiguration.html index e79cf129fe..ac333fcf3a 100644 --- a/api/interfaces/IconConfiguration.html +++ b/api/interfaces/IconConfiguration.html @@ -1,6 +1,6 @@ -IconConfiguration | bpmn-visualization API Documentation

Interface IconConfiguration

interface IconConfiguration {
    originalSize: Size;
    ratioFromParent?: number;
    setIconOriginFunct: ((canvas) => void);
    styleConfig: IconStyleConfiguration;
}

Properties

originalSize +IconConfiguration | bpmn-visualization API Documentation

Interface IconConfiguration

interface IconConfiguration {
    originalSize: Size;
    ratioFromParent?: number;
    setIconOriginFunct: ((canvas) => void);
    styleConfig: IconStyleConfiguration;
}

Properties

originalSize ratioFromParent? setIconOriginFunct styleConfig -

Properties

originalSize

originalSize: Size

Optional ratioFromParent

ratioFromParent?: number

If undefined, no scaling will be done in BpmnCanvas.

-

setIconOriginFunct

setIconOriginFunct: ((canvas) => void)

Type declaration

    • (canvas): void

    • Parameters

      Returns void

styleConfig

styleConfig: IconStyleConfiguration

Settings

Member Visibility

Theme

On This Page

originalSizeratioFromParentsetIconOriginFunctstyleConfig

Generated using TypeDoc

\ No newline at end of file +

Properties

originalSize

originalSize: Size

Optional ratioFromParent

ratioFromParent?: number

If undefined, no scaling will be done in BpmnCanvas.

+

setIconOriginFunct

setIconOriginFunct: ((canvas) => void)

Type declaration

    • (canvas): void

    • Parameters

      Returns void

styleConfig

styleConfig: IconStyleConfiguration

Settings

Member Visibility

Theme

On This Page

originalSizeratioFromParentsetIconOriginFunctstyleConfig

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IconStyleConfiguration.html b/api/interfaces/IconStyleConfiguration.html index a2d38ca71a..2a795fac54 100644 --- a/api/interfaces/IconStyleConfiguration.html +++ b/api/interfaces/IconStyleConfiguration.html @@ -1,6 +1,6 @@ -IconStyleConfiguration | bpmn-visualization API Documentation

Interface IconStyleConfiguration

interface IconStyleConfiguration {
    fillColor: string;
    isFilled: boolean;
    margin: number;
    strokeColor: string;
    strokeWidth: number;
}

Properties

fillColor +IconStyleConfiguration | bpmn-visualization API Documentation

Interface IconStyleConfiguration

interface IconStyleConfiguration {
    fillColor: string;
    isFilled: boolean;
    margin: number;
    strokeColor: string;
    strokeWidth: number;
}

Properties

fillColor isFilled margin strokeColor strokeWidth -

Properties

fillColor

fillColor: string

isFilled

isFilled: boolean

margin

margin: number

strokeColor

strokeColor: string

strokeWidth

strokeWidth: number

Settings

Member Visibility

Theme

On This Page

fillColorisFilledmarginstrokeColorstrokeWidth

Generated using TypeDoc

\ No newline at end of file +

Properties

fillColor

fillColor: string

isFilled

isFilled: boolean

margin

margin: number

strokeColor

strokeColor: string

strokeWidth

strokeWidth: number

Settings

Member Visibility

Theme

On This Page

fillColorisFilledmarginstrokeColorstrokeWidth

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/LoadOptions.html b/api/interfaces/LoadOptions.html index aee08762f3..002f12a5f4 100644 --- a/api/interfaces/LoadOptions.html +++ b/api/interfaces/LoadOptions.html @@ -1,4 +1,4 @@ LoadOptions | bpmn-visualization API Documentation

Interface LoadOptions

Options when loading a BPMN Diagram.

-
interface LoadOptions {
    fit?: FitOptions;
    modelFilter?: ModelFilter;
}

Properties

fit? +
interface LoadOptions {
    fit?: FitOptions;
    modelFilter?: ModelFilter;
}

Properties

fit? modelFilter? -

Properties

Optional fit

fit?: FitOptions

Optional modelFilter

modelFilter?: ModelFilter

Settings

Member Visibility

Theme

On This Page

fitmodelFilter

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional fit

fit?: FitOptions

Optional modelFilter

modelFilter?: ModelFilter

Settings

Member Visibility

Theme

On This Page

fitmodelFilter

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ModelFilter.html b/api/interfaces/ModelFilter.html index d04e9f1862..f5b3c46cf3 100644 --- a/api/interfaces/ModelFilter.html +++ b/api/interfaces/ModelFilter.html @@ -2,5 +2,5 @@

Here is an example of how to perform model filtering when loading a BPMN diagram:

bpmnVisualization.load(diagram, {
  modelFilter: {
    pools: [
      {
        // id of the Participant related to the Pool to display
        id: 'id1'
      },
      {
        // Name of the Participant, or name of the Process referenced by the Participant
        // when the Participant doesn't have a name.
        // This is how `bpmn-visualization` builds the name into its internal model.
        name: 'name2'
      },
      {
      id: 'id3',
      // in this case, we only use the id, and ignore the name
      name: 'name3'
      }
    ]},
});
-
interface ModelFilter {
    pools?: PoolFilter | PoolFilter[];
}

Properties

pools? -

Properties

Optional pools

pools?: PoolFilter | PoolFilter[]

Settings

Member Visibility

Theme

On This Page

pools

Generated using TypeDoc

\ No newline at end of file +
interface ModelFilter {
    pools?: PoolFilter | PoolFilter[];
}

Properties

pools? +

Properties

Optional pools

pools?: PoolFilter | PoolFilter[]

Settings

Member Visibility

Theme

On This Page

pools

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/NavigationConfiguration.html b/api/interfaces/NavigationConfiguration.html index 2ac3d8165e..b9800a6364 100644 --- a/api/interfaces/NavigationConfiguration.html +++ b/api/interfaces/NavigationConfiguration.html @@ -1,9 +1,9 @@ NavigationConfiguration | bpmn-visualization API Documentation

Interface NavigationConfiguration

Configure the BPMN diagram navigation (panning and zoom).

-
interface NavigationConfiguration {
    enabled: boolean;
    zoom?: ZoomConfiguration;
}

Properties

enabled +
interface NavigationConfiguration {
    enabled: boolean;
    zoom?: ZoomConfiguration;
}

Properties

enabled zoom?

Properties

enabled

enabled: boolean

Enable the navigation with the mouse wheel or with gesture/pinch on touch devices.

IMPORTANT: the navigation API is not affected by this value. Navigation actions performed with the API always have an effect.

Default

false
-

Optional zoom

zoom?: ZoomConfiguration

Tune how the zoom behaves when using the mouse wheel or with gesture/pinch on touch devices.

-

Settings

Member Visibility

Theme

On This Page

enabledzoom

Generated using TypeDoc

\ No newline at end of file +

Optional zoom

zoom?: ZoomConfiguration

Tune how the zoom behaves when using the mouse wheel or with gesture/pinch on touch devices.

+

Settings

Member Visibility

Theme

On This Page

enabledzoom

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/OverlaysRegistry.html b/api/interfaces/OverlaysRegistry.html index 65eb39d37a..99289cbdca 100644 --- a/api/interfaces/OverlaysRegistry.html +++ b/api/interfaces/OverlaysRegistry.html @@ -1,4 +1,4 @@ -OverlaysRegistry | bpmn-visualization API Documentation

Interface OverlaysRegistry

interface OverlaysRegistry {
    addOverlays(bpmnElementId, overlays): void;
    removeAllOverlays(bpmnElementId): void;
}

Implemented by

Methods

addOverlays +OverlaysRegistry | bpmn-visualization API Documentation

Interface OverlaysRegistry

interface OverlaysRegistry {
    addOverlays(bpmnElementId, overlays): void;
    removeAllOverlays(bpmnElementId): void;
}

Implemented by

Methods

addOverlays removeAllOverlays

Methods

addOverlays

  • addOverlays(bpmnElementId, overlays): void

  • Add one/several overlays to a BPMN element.

    Notice that if you pass an id that is not related to an existing BPMN element, nothing happens on the rendering side.

    @@ -6,10 +6,10 @@
  • overlays: Overlay | Overlay[]

    The overlays to add to the BPMN element

Returns void

Example

// Add an overlay to BPMN elements with id 'task_1'
bpmnVisualization.bpmnElementsRegistry.addOverlays('task_1', {
   position: 'top-left',
   label: '40',
   style: {
     font: { color: 'Chartreuse', size: 8 },
     fill: { color: 'Pink', opacity: 50 },
     stroke: { color: 'DarkSeaGreen', width: 2 }
   }
});

// Add several overlays to BPMN element with id 'task_3'
bpmnVisualization.bpmnElementsRegistry.addOverlays('task_3', [
   {
     position: 'bottom-right',
     label: '110',
     style: {
       font: { color: '#663399', size: 8 },
       fill: { color: '#FFDAB9', opacity: 50 },
       stroke: { color: 'DarkSeaGreen', width: 2 }
     }
   },
   {
     position: 'top-left',
     label: '40',
     style: {
       font: { color: 'MidnightBlue', size: 30 },
       fill: { color: 'Aquamarine', opacity: 70 },
       stroke: { color: '#4B0082', width: 1 }
     }
   }
]);
-

removeAllOverlays

removeAllOverlays

  • removeAllOverlays(bpmnElementId): void

  • Remove all overlays of a BPMN element.

    Notice that if you pass an id that is not related to an existing BPMN element, nothing happens on the rendering side.

    WARNING: could be renamed when adding support for removal of one or several specific overlays.

    Parameters

    • bpmnElementId: string

      The BPMN id of the element where to remove the overlays

    Returns void

    Example

    //  all overlays of the BPMN element with id: activity_1
    bpmnVisualization.bpmnElementsRegistry.removeAllOverlays('activity_1');
    -

Settings

Member Visibility

Theme

On This Page

addOverlaysremoveAllOverlays

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

addOverlaysremoveAllOverlays

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/PaintParameter.html b/api/interfaces/PaintParameter.html index 68340e5d28..80ea79db9b 100644 --- a/api/interfaces/PaintParameter.html +++ b/api/interfaces/PaintParameter.html @@ -1,13 +1,13 @@ PaintParameter | bpmn-visualization API Documentation

Interface PaintParameterExperimental

WARN: You may use it to customize the BPMN Theme as suggested in the examples. But be aware that the way the default BPMN theme can be modified is subject to change.

-
interface PaintParameter {
    canvas: mxAbstractCanvas2D;
    iconStyleConfig: IconStyleConfiguration;
    ratioFromParent?: number;
    setIconOriginFunct: ((canvas) => void);
    shapeConfig: ShapeConfiguration;
}

Properties

canvas +
interface PaintParameter {
    canvas: mxAbstractCanvas2D;
    iconStyleConfig: IconStyleConfiguration;
    ratioFromParent?: number;
    setIconOriginFunct: ((canvas) => void);
    shapeConfig: ShapeConfiguration;
}

Properties

canvas iconStyleConfig ratioFromParent? setIconOriginFunct shapeConfig

Properties

canvas

canvas: mxAbstractCanvas2D

Underlying 'Canvas' in charge of performing the paint operations.

-

iconStyleConfig

iconStyleConfig: IconStyleConfiguration

The style configuration of the icon.

-

Optional ratioFromParent

ratioFromParent?: number

The actual size of the icon will be computed from the shape dimensions using this ratio. The ratio between the original dimensions of the icon are kept. +

iconStyleConfig

iconStyleConfig: IconStyleConfiguration

The style configuration of the icon.

+

Optional ratioFromParent

ratioFromParent?: number

The actual size of the icon will be computed from the shape dimensions using this ratio. The ratio between the original dimensions of the icon are kept. If not set, use the dimensions defined in the icon implementation.

-

setIconOriginFunct

setIconOriginFunct: ((canvas) => void)

The called function to set the origin of the icon. Generally, it calls a method of BpmnCanvas.

-

Type declaration

    • (canvas): void

    • Parameters

      Returns void

shapeConfig

shapeConfig: ShapeConfiguration

The dimension and the style of the shape where the icon is painted.

-

Settings

Member Visibility

Theme

On This Page

canvasiconStyleConfigratioFromParentsetIconOriginFunctshapeConfig

Generated using TypeDoc

\ No newline at end of file +

setIconOriginFunct

setIconOriginFunct: ((canvas) => void)

The called function to set the origin of the icon. Generally, it calls a method of BpmnCanvas.

+

Type declaration

    • (canvas): void

    • Parameters

      Returns void

shapeConfig

shapeConfig: ShapeConfiguration

The dimension and the style of the shape where the icon is painted.

+

Settings

Member Visibility

Theme

On This Page

canvasiconStyleConfigratioFromParentsetIconOriginFunctshapeConfig

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/PoolFilter.html b/api/interfaces/PoolFilter.html index d2d1a3e64b..af5d909612 100644 --- a/api/interfaces/PoolFilter.html +++ b/api/interfaces/PoolFilter.html @@ -1,9 +1,9 @@ PoolFilter | bpmn-visualization API Documentation

Interface PoolFilter

Pool filtering configuration.

A Pool is the graphical representation of a Participant in a Collaboration.

-
interface PoolFilter {
    id?: string;
    name?: string;
}

Properties

id? +
interface PoolFilter {
    id?: string;
    name?: string;
}

Properties

id? name?

Properties

Optional id

id?: string

id of the Participant related to the Pool to display

-

Optional name

name?: string

Name of the Participant, or name of the Process referenced by the Participant when the Participant doesn't have a name. +

Optional name

name?: string

Name of the Participant, or name of the Process referenced by the Participant when the Participant doesn't have a name. This is how bpmn-visualization builds the name into its internal model. If id is set, this property is ignored.

-

Settings

Member Visibility

Theme

On This Page

idname

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

idname

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ShapeBpmnSemantic.html b/api/interfaces/ShapeBpmnSemantic.html index d263c0839e..e9aca06b0d 100644 --- a/api/interfaces/ShapeBpmnSemantic.html +++ b/api/interfaces/ShapeBpmnSemantic.html @@ -1,5 +1,5 @@ ShapeBpmnSemantic | bpmn-visualization API Documentation

Interface ShapeBpmnSemantic

Extended properties available when BaseBpmnSemantic.isShape is true.

-
interface ShapeBpmnSemantic {
    callActivityGlobalTaskKind?: GlobalTaskKind;
    callActivityKind?: ShapeBpmnCallActivityKind;
    eventDefinitionKind?: ShapeBpmnEventDefinitionKind;
    id: string;
    incomingIds: string[];
    isShape: boolean;
    kind: BpmnElementKind;
    linkEventSourceIds?: string[];
    linkEventTargetId?: string;
    name: string;
    outgoingIds: string[];
    parentId: string;
    subProcessKind?: ShapeBpmnSubProcessKind;
}

Hierarchy (view full)

Properties

callActivityGlobalTaskKind? +
interface ShapeBpmnSemantic {
    callActivityGlobalTaskKind?: GlobalTaskKind;
    callActivityKind?: ShapeBpmnCallActivityKind;
    eventDefinitionKind?: ShapeBpmnEventDefinitionKind;
    id: string;
    incomingIds: string[];
    isShape: boolean;
    kind: BpmnElementKind;
    linkEventSourceIds?: string[];
    linkEventTargetId?: string;
    name: string;
    outgoingIds: string[];
    parentId: string;
    subProcessKind?: ShapeBpmnSubProcessKind;
}

Hierarchy (view full)

Properties

callActivityGlobalTaskKind? callActivityKind? eventDefinitionKind? id @@ -13,14 +13,14 @@ parentId subProcessKind?

Properties

Optional callActivityGlobalTaskKind

callActivityGlobalTaskKind?: GlobalTaskKind

Set when the BaseBpmnSemantic.kind relates to a BPMN Call Activity calling a global task.

-

Optional callActivityKind

callActivityKind?: ShapeBpmnCallActivityKind

Set when the BaseBpmnSemantic.kind relates to a BPMN Call Activity.

-

Optional eventDefinitionKind

eventDefinitionKind?: ShapeBpmnEventDefinitionKind

Set when the BaseBpmnSemantic.kind relates to a BPMN event.

-

id

id: string

incomingIds

incomingIds: string[]

IDs of the incoming flows/edges.

-

isShape

isShape: boolean

true when relates to a BPMN Shape, false when relates to a BPMN Edge.

-

kind

kind: BpmnElementKind

Optional linkEventSourceIds

linkEventSourceIds?: string[]

Set when the BaseBpmnSemantic.kind relates to a BPMN intermediate catch event with ShapeBpmnSemantic.eventDefinitionKind set to ShapeBpmnEventDefinitionKind.LINK.

-

Optional linkEventTargetId

linkEventTargetId?: string

Set when the BaseBpmnSemantic.kind relates to a BPMN intermediate throw event with ShapeBpmnSemantic.eventDefinitionKind set to ShapeBpmnEventDefinitionKind.LINK.

-

name

name: string

outgoingIds

outgoingIds: string[]

IDs of the outgoing flows/edges.

-

parentId

parentId: string

This is the ID of the direct parent of the current element, which can be a:

+

Optional callActivityKind

callActivityKind?: ShapeBpmnCallActivityKind

Set when the BaseBpmnSemantic.kind relates to a BPMN Call Activity.

+

Optional eventDefinitionKind

eventDefinitionKind?: ShapeBpmnEventDefinitionKind

Set when the BaseBpmnSemantic.kind relates to a BPMN event.

+

id

id: string

incomingIds

incomingIds: string[]

IDs of the incoming flows/edges.

+

isShape

isShape: boolean

true when relates to a BPMN Shape, false when relates to a BPMN Edge.

+

kind

kind: BpmnElementKind

Optional linkEventSourceIds

linkEventSourceIds?: string[]

Set when the BaseBpmnSemantic.kind relates to a BPMN intermediate catch event with ShapeBpmnSemantic.eventDefinitionKind set to ShapeBpmnEventDefinitionKind.LINK.

+

Optional linkEventTargetId

linkEventTargetId?: string

Set when the BaseBpmnSemantic.kind relates to a BPMN intermediate throw event with ShapeBpmnSemantic.eventDefinitionKind set to ShapeBpmnEventDefinitionKind.LINK.

+

name

name: string

outgoingIds

outgoingIds: string[]

IDs of the outgoing flows/edges.

+

parentId

parentId: string

This is the ID of the direct parent of the current element, which can be a:

  • process/participant
  • lane
    • @@ -29,5 +29,5 @@

For the Boundary events, it is the activity to which the item belongs.

Special case: it can be undefined when there is a single process without Participant/Pool. In this case, the direct children of the process have no parent.

-

Optional subProcessKind

subProcessKind?: ShapeBpmnSubProcessKind

Set when the BaseBpmnSemantic.kind relates to a BPMN sub-process.

-

Settings

Member Visibility

Theme

On This Page

callActivityGlobalTaskKindcallActivityKindeventDefinitionKindidincomingIdsisShapekindlinkEventSourceIdslinkEventTargetIdnameoutgoingIdsparentIdsubProcessKind

Generated using TypeDoc

\ No newline at end of file +

Optional subProcessKind

subProcessKind?: ShapeBpmnSubProcessKind

Set when the BaseBpmnSemantic.kind relates to a BPMN sub-process.

+

Settings

Member Visibility

Theme

On This Page

callActivityGlobalTaskKindcallActivityKindeventDefinitionKindidincomingIdsisShapekindlinkEventSourceIdslinkEventTargetIdnameoutgoingIdsparentIdsubProcessKind

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ShapeConfiguration.html b/api/interfaces/ShapeConfiguration.html index 3f95871b51..63b5cbe08c 100644 --- a/api/interfaces/ShapeConfiguration.html +++ b/api/interfaces/ShapeConfiguration.html @@ -1,6 +1,6 @@ -ShapeConfiguration | bpmn-visualization API Documentation

Interface ShapeConfiguration

interface ShapeConfiguration {
    height: number;
    strokeWidth?: number;
    width: number;
    x: number;
    y: number;
}

Hierarchy (view full)

  • Size
    • ShapeConfiguration

Properties

height +ShapeConfiguration | bpmn-visualization API Documentation

Interface ShapeConfiguration

interface ShapeConfiguration {
    height: number;
    strokeWidth?: number;
    width: number;
    x: number;
    y: number;
}

Hierarchy (view full)

  • Size
    • ShapeConfiguration

Properties

height strokeWidth? width x y -

Properties

height

height: number

Optional strokeWidth

strokeWidth?: number

width

width: number

x

x: number

y

y: number

Settings

Member Visibility

Theme

On This Page

heightstrokeWidthwidthxy

Generated using TypeDoc

\ No newline at end of file +

Properties

height

height: number

Optional strokeWidth

strokeWidth?: number

width

width: number

x

x: number

y

y: number

Settings

Member Visibility

Theme

On This Page

heightstrokeWidthwidthxy

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/Size.html b/api/interfaces/Size.html index b4efedce98..9058cb3048 100644 --- a/api/interfaces/Size.html +++ b/api/interfaces/Size.html @@ -1,3 +1,3 @@ -Size | bpmn-visualization API Documentation

Interface Size

interface Size {
    height: number;
    width: number;
}

Hierarchy (view full)

Properties

height +Size | bpmn-visualization API Documentation

Interface Size

interface Size {
    height: number;
    width: number;
}

Hierarchy (view full)

Properties

height width -

Properties

height

height: number

width

width: number

Settings

Member Visibility

Theme

On This Page

heightwidth

Generated using TypeDoc

\ No newline at end of file +

Properties

height

height: number

width

width: number

Settings

Member Visibility

Theme

On This Page

heightwidth

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/StyleRegistry.html b/api/interfaces/StyleRegistry.html index d84803cc92..2d926aefd7 100644 --- a/api/interfaces/StyleRegistry.html +++ b/api/interfaces/StyleRegistry.html @@ -1,4 +1,4 @@ -StyleRegistry | bpmn-visualization API Documentation

Interface StyleRegistry

interface StyleRegistry {
    resetStyle(bpmnElementIds?): void;
    updateStyle(bpmnElementIds, styleUpdate): void;
}

Implemented by

Methods

resetStyle +StyleRegistry | bpmn-visualization API Documentation

Interface StyleRegistry

interface StyleRegistry {
    resetStyle(bpmnElementIds?): void;
    updateStyle(bpmnElementIds, styleUpdate): void;
}

Implemented by

Methods

resetStyle updateStyle

Methods

resetStyle

  • resetStyle(bpmnElementIds?): void

  • Reset the style that were previously updated to one or more BPMN elements using the updateStyle method.

    Parameters

updateStyle

updateStyle

  • updateStyle(bpmnElementIds, styleUpdate): void

  • Update the style of one or several BPMN elements.

    Parameters

    • bpmnElementIds: string | string[]

      The BPMN ID of the element(s) whose style must be updated.

    • styleUpdate: StyleUpdate

      The style properties to update.

    Returns void

    Example

    bpmnVisualization.bpmnElementsRegistry.updateStyle('activity_1', {
      stroke: {
        color: 'red',
      },
    });
@@ -42,4 +42,4 @@ 
    See
    
 
    Since
    0.33.0
    
-

Settings

Member Visibility

Theme

On This Page

resetStyleupdateStyle

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

resetStyleupdateStyle

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/Version.html b/api/interfaces/Version.html index 906484cf94..65de75e8b4 100644 --- a/api/interfaces/Version.html +++ b/api/interfaces/Version.html @@ -1,6 +1,6 @@ Version | bpmn-visualization API Documentation

Interface Version

The version of bpmn-visualization and the version of its dependencies.

-
interface Version {
    dependencies: Map<string, string>;
    lib: string;
}

Properties

dependencies +
interface Version {
    dependencies: Map<string, string>;
    lib: string;
}

Properties

dependencies lib

Properties

dependencies

dependencies: Map<string, string>

The version of the bpmn-visualization dependencies. This may not list all dependencies.

-

lib

lib: string

The bpmn-visualization version.

-

Settings

Member Visibility

Theme

On This Page

dependencieslib

Generated using TypeDoc

\ No newline at end of file +

lib

lib: string

The bpmn-visualization version.

+

Settings

Member Visibility

Theme

On This Page

dependencieslib

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ZoomConfiguration.html b/api/interfaces/ZoomConfiguration.html index d3b4a45e3a..6239a4e294 100644 --- a/api/interfaces/ZoomConfiguration.html +++ b/api/interfaces/ZoomConfiguration.html @@ -1,13 +1,13 @@ ZoomConfiguration | bpmn-visualization API Documentation

Interface ZoomConfiguration

Zoom specific options.

-
interface ZoomConfiguration {
    debounceDelay?: number;
    throttleDelay?: number;
}

Properties

debounceDelay? +
interface ZoomConfiguration {
    debounceDelay?: number;
    throttleDelay?: number;
}

Properties

debounceDelay? throttleDelay?

Properties

Optional debounceDelay

debounceDelay?: number

Value in milliseconds responsible for debouncing the zoom function - the actual scaling. A bigger value results in bigger gain in zoom factor before actual scaling takes place. Values must be in the [0, 100] interval, values outside this interval are set to the interval bounds.

Default

50
-

Optional throttleDelay

throttleDelay?: number

Value in milliseconds responsible for throttling the mouse scroll event (not every event is firing the function handler, only limited number can lunch handler). A smaller value +

Optional throttleDelay

throttleDelay?: number

Value in milliseconds responsible for throttling the mouse scroll event (not every event is firing the function handler, only limited number can lunch handler). A smaller value results in more events fired, bigger gain in zoom factor. Values must be in the [0, 100] interval, values outside this interval are set to the interval bounds.

Default

50
-

Settings

Member Visibility

Theme

On This Page

debounceDelaythrottleDelay

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

debounceDelaythrottleDelay

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/BpmnElementKind.html b/api/types/BpmnElementKind.html index 9598348fa2..c293dc5340 100644 --- a/api/types/BpmnElementKind.html +++ b/api/types/BpmnElementKind.html @@ -1 +1 @@ -BpmnElementKind | bpmn-visualization API Documentation

Type alias BpmnElementKind

BpmnElementKind: FlowKind | ShapeBpmnElementKind

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +BpmnElementKind | bpmn-visualization API Documentation

Type alias BpmnElementKind

BpmnElementKind: FlowKind | ShapeBpmnElementKind

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/BpmnEventKind.html b/api/types/BpmnEventKind.html index bd88937c4d..2ea065bd77 100644 --- a/api/types/BpmnEventKind.html +++ b/api/types/BpmnEventKind.html @@ -1,2 +1,2 @@ BpmnEventKind | bpmn-visualization API Documentation

Type alias BpmnEventKind

BpmnEventKind: EVENT_BOUNDARY | EVENT_START | EVENT_END | EVENT_INTERMEDIATE_THROW | EVENT_INTERMEDIATE_CATCH

ShapeBpmnElementKind related to BPMN Events.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/BpmnSemantic.html b/api/types/BpmnSemantic.html index 1f2c55a76e..49dfe2e935 100644 --- a/api/types/BpmnSemantic.html +++ b/api/types/BpmnSemantic.html @@ -1 +1 @@ -BpmnSemantic | bpmn-visualization API Documentation

Type alias BpmnSemantic

BpmnSemantic: EdgeBpmnSemantic | ShapeBpmnSemantic

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +BpmnSemantic | bpmn-visualization API Documentation

Type alias BpmnSemantic

BpmnSemantic: EdgeBpmnSemantic | ShapeBpmnSemantic

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/EdgeStyleUpdate.html b/api/types/EdgeStyleUpdate.html index c93373bb60..2e5de9c06f 100644 --- a/api/types/EdgeStyleUpdate.html +++ b/api/types/EdgeStyleUpdate.html @@ -9,4 +9,4 @@
  • It is used to apply the opacity defined in the default style of the BPMN element.
  • It can be used when the style is first updated and then needs to be reset to its initial value.
    • -
  • Optional stroke?: Stroke

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional stroke?: Stroke

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/Fill.html b/api/types/Fill.html index 0b558c5cea..5311947543 100644 --- a/api/types/Fill.html +++ b/api/types/Fill.html @@ -11,4 +11,4 @@
  • It doesn't use the color set in the BPMN source when the "BPMN in Color" support is enabled. It uses the color defined in the BPMN element default style.
  • If a gradient was set, it will be completely reverted.
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/FillColorGradient.html b/api/types/FillColorGradient.html index 47cdec3090..d4f5d8f55d 100644 --- a/api/types/FillColorGradient.html +++ b/api/types/FillColorGradient.html @@ -18,4 +18,4 @@
  • none for no color.
  • swimlane to apply the fill color of the nearest parent element with the type ShapeBpmnElementKind.LANE or ShapeBpmnElementKind.POOL.
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/Font.html b/api/types/Font.html index 49fb00ed89..68e383201f 100644 --- a/api/types/Font.html +++ b/api/types/Font.html @@ -21,4 +21,4 @@
  • Optional isUnderline?: boolean

    Default

    false
  • Optional size?: number

    The type of the value is int (in px).

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/GlobalTaskKind.html b/api/types/GlobalTaskKind.html index 840d4a8530..25d41ebbb7 100644 --- a/api/types/GlobalTaskKind.html +++ b/api/types/GlobalTaskKind.html @@ -1,2 +1,2 @@ GlobalTaskKind | bpmn-visualization API Documentation

    Type alias GlobalTaskKind

    GlobalTaskKind: GLOBAL_TASK | GLOBAL_TASK_MANUAL | GLOBAL_TASK_SCRIPT | GLOBAL_TASK_USER | GLOBAL_TASK_BUSINESS_RULE

    ShapeBpmnElementKind related to BPMN Global Tasks.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/GradientDirection.html b/api/types/GradientDirection.html index a45f5de88d..cd906100e6 100644 --- a/api/types/GradientDirection.html +++ b/api/types/GradientDirection.html @@ -1 +1 @@ -GradientDirection | bpmn-visualization API Documentation

    Type alias GradientDirection

    GradientDirection: "left-to-right" | "right-to-left" | "bottom-to-top" | "top-to-bottom"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GradientDirection | bpmn-visualization API Documentation

    Type alias GradientDirection

    GradientDirection: "left-to-right" | "right-to-left" | "bottom-to-top" | "top-to-bottom"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/Opacity.html b/api/types/Opacity.html index affade163b..713292f6e8 100644 --- a/api/types/Opacity.html +++ b/api/types/Opacity.html @@ -1 +1 @@ -Opacity | bpmn-visualization API Documentation

    Type alias Opacity

    Opacity: "default" | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Opacity | bpmn-visualization API Documentation

    Type alias Opacity

    Opacity: "default" | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/Overlay.html b/api/types/Overlay.html index 6e3efc9372..2c98d535ea 100644 --- a/api/types/Overlay.html +++ b/api/types/Overlay.html @@ -1 +1 @@ -Overlay | bpmn-visualization API Documentation

    Type alias Overlay

    Overlay: {
        label?: string;
        position: OverlayPosition;
        style?: OverlayStyle;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Overlay | bpmn-visualization API Documentation

    Type alias Overlay

    Overlay: {
        label?: string;
        position: OverlayPosition;
        style?: OverlayStyle;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/OverlayEdgePosition.html b/api/types/OverlayEdgePosition.html index 1588310066..e3b93fdb1d 100644 --- a/api/types/OverlayEdgePosition.html +++ b/api/types/OverlayEdgePosition.html @@ -1 +1 @@ -OverlayEdgePosition | bpmn-visualization API Documentation

    Type alias OverlayEdgePosition

    OverlayEdgePosition: "start" | "middle" | "end"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +OverlayEdgePosition | bpmn-visualization API Documentation

    Type alias OverlayEdgePosition

    OverlayEdgePosition: "start" | "middle" | "end"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/OverlayFill.html b/api/types/OverlayFill.html index 6c8feced13..ba777298ef 100644 --- a/api/types/OverlayFill.html +++ b/api/types/OverlayFill.html @@ -5,4 +5,4 @@

    To solve this problem, define a color that contains opacity information. For example: color: rgba(0, 0, 255, 0.8)`.

    Default

    {@link StyleDefault.DEFAULT_OVERLAY_FILL_OPACITY}
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/OverlayFont.html b/api/types/OverlayFont.html index 4550743c7a..be7959eb15 100644 --- a/api/types/OverlayFont.html +++ b/api/types/OverlayFont.html @@ -3,4 +3,4 @@
  • Optional size?: number

    Default

    {@link StyleDefault.DEFAULT_OVERLAY_FONT_SIZE}
    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/OverlayPosition.html b/api/types/OverlayPosition.html index a77efd7f35..9a7cb1047e 100644 --- a/api/types/OverlayPosition.html +++ b/api/types/OverlayPosition.html @@ -1 +1 @@ -OverlayPosition | bpmn-visualization API Documentation

    Type alias OverlayPosition

    OverlayPosition: OverlayShapePosition | OverlayEdgePosition

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +OverlayPosition | bpmn-visualization API Documentation

    Type alias OverlayPosition

    OverlayPosition: OverlayShapePosition | OverlayEdgePosition

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/OverlayShapePosition.html b/api/types/OverlayShapePosition.html index 869a0d1c8b..5151f7272b 100644 --- a/api/types/OverlayShapePosition.html +++ b/api/types/OverlayShapePosition.html @@ -1 +1 @@ -OverlayShapePosition | bpmn-visualization API Documentation

    Type alias OverlayShapePosition

    OverlayShapePosition: "top-left" | "top-right" | "top-center" | "bottom-left" | "bottom-right" | "bottom-center" | "middle-left" | "middle-right"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +OverlayShapePosition | bpmn-visualization API Documentation

    Type alias OverlayShapePosition

    OverlayShapePosition: "top-left" | "top-right" | "top-center" | "bottom-left" | "bottom-right" | "bottom-center" | "middle-left" | "middle-right"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/OverlayStroke.html b/api/types/OverlayStroke.html index df0ce8c138..9240eb2aac 100644 --- a/api/types/OverlayStroke.html +++ b/api/types/OverlayStroke.html @@ -8,4 +8,4 @@
  • Optional width?: number

    IMPORTANT: this property is currently not taken into account by the default Overlay. See https://github.com/process-analytics/bpmn-visualization-js/issues/1234

    Default

    {@link StyleDefault.DEFAULT_OVERLAY_STROKE_WIDTH}
    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/OverlayStyle.html b/api/types/OverlayStyle.html index 8846a23a1d..a82b8a8d16 100644 --- a/api/types/OverlayStyle.html +++ b/api/types/OverlayStyle.html @@ -1 +1 @@ -OverlayStyle | bpmn-visualization API Documentation

    Type alias OverlayStyle

    OverlayStyle: {
        fill?: OverlayFill;
        font?: OverlayFont;
        stroke?: OverlayStroke;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +OverlayStyle | bpmn-visualization API Documentation

    Type alias OverlayStyle

    OverlayStyle: {
        fill?: OverlayFill;
        font?: OverlayFont;
        stroke?: OverlayStroke;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/ParserOptions.html b/api/types/ParserOptions.html index 874cef565b..e62fea211a 100644 --- a/api/types/ParserOptions.html +++ b/api/types/ParserOptions.html @@ -7,4 +7,4 @@
      • (value): string

      • Parameters

        • value: string

        Returns string

  • Optional disableConsoleLog?: boolean

    If true, disable the console logs produced by the parser.

    Default

    false
    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/RendererOptions.html b/api/types/RendererOptions.html index cbff039ded..02644dd2df 100644 --- a/api/types/RendererOptions.html +++ b/api/types/RendererOptions.html @@ -5,4 +5,4 @@

    Default

    true

    Since

    0.35.0

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/ShapeStyleUpdate.html b/api/types/ShapeStyleUpdate.html index 7df4115be5..d80573d8c5 100644 --- a/api/types/ShapeStyleUpdate.html +++ b/api/types/ShapeStyleUpdate.html @@ -1 +1 @@ -ShapeStyleUpdate | bpmn-visualization API Documentation

    Type alias ShapeStyleUpdate

    ShapeStyleUpdate: EdgeStyleUpdate & {
        fill?: Fill;
    }

    Type declaration

    • Optional fill?: Fill

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ShapeStyleUpdate | bpmn-visualization API Documentation

    Type alias ShapeStyleUpdate

    ShapeStyleUpdate: EdgeStyleUpdate & {
        fill?: Fill;
    }

    Type declaration

    • Optional fill?: Fill

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/Stroke.html b/api/types/Stroke.html index 8f10641128..1ea12ab45e 100644 --- a/api/types/Stroke.html +++ b/api/types/Stroke.html @@ -18,4 +18,4 @@

    The default value resets the width to the value defined in the default style of the BPMN element. It can be used when the style is first updated and then needs to be reset to its initial value.

    WARNING: Changing the stroke width of Activities may be misleading as the default stroke widths have a meaning according to the BPMN Specification. For example, updating the stroke width of a task using the same value as the default stroke width of a Call Activity can be confusing. In this case, you should also change another property such as the stroke color to allow the user to differentiate between them.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/StyleUpdate.html b/api/types/StyleUpdate.html index be3ac86d84..d16f61e406 100644 --- a/api/types/StyleUpdate.html +++ b/api/types/StyleUpdate.html @@ -1 +1 @@ -StyleUpdate | bpmn-visualization API Documentation

    Type alias StyleUpdate

    StyleUpdate: EdgeStyleUpdate | ShapeStyleUpdate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StyleUpdate | bpmn-visualization API Documentation

    Type alias StyleUpdate

    StyleUpdate: EdgeStyleUpdate | ShapeStyleUpdate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/types/StyleWithOpacity.html b/api/types/StyleWithOpacity.html index bda6c2f8cb..3f891ad92e 100644 --- a/api/types/StyleWithOpacity.html +++ b/api/types/StyleWithOpacity.html @@ -8,4 +8,4 @@
  • It is used to apply the opacity defined in the default style of the BPMN element.
  • It can be used when the style is first updated and then needs to be reset to its initial value.
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/BpmnStyleIdentifier.html b/api/variables/BpmnStyleIdentifier.html index 8d2a4d03c9..7eba1fdb20 100644 --- a/api/variables/BpmnStyleIdentifier.html +++ b/api/variables/BpmnStyleIdentifier.html @@ -1,3 +1,3 @@ BpmnStyleIdentifier | bpmn-visualization API Documentation

    Variable BpmnStyleIdentifierConst Experimental

    BpmnStyleIdentifier: {
        EDGE: string;
        EDGE_END_FILL_COLOR: string;
        EDGE_START_FILL_COLOR: string;
        EVENT_BASED_GATEWAY_KIND: string;
        EVENT_DEFINITION_KIND: string;
        EXTRA_CSS_CLASSES: string;
        GLOBAL_TASK_KIND: string;
        IS_INITIATING: string;
        IS_INSTANTIATING: string;
        IS_INTERRUPTING: string;
        MARKERS: string;
        MESSAGE_FLOW_ICON: string;
        SUB_PROCESS_KIND: string;
    } = ...

    Define BPMN specific keys used in mxGraph styles. Use constants defined in this class instead of hard coded string values.

    WARN: You may use it to customize the BPMN Theme as suggested in the examples. But be aware that the way the default BPMN theme can be modified is subject to change.

    -

    Type declaration

    • EDGE: string
    • EDGE_END_FILL_COLOR: string
    • EDGE_START_FILL_COLOR: string
    • EVENT_BASED_GATEWAY_KIND: string
    • EVENT_DEFINITION_KIND: string
    • EXTRA_CSS_CLASSES: string
    • GLOBAL_TASK_KIND: string
    • IS_INITIATING: string
    • IS_INSTANTIATING: string
    • IS_INTERRUPTING: string
    • MARKERS: string
    • MESSAGE_FLOW_ICON: string
    • SUB_PROCESS_KIND: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • EDGE: string
    • EDGE_END_FILL_COLOR: string
    • EDGE_START_FILL_COLOR: string
    • EVENT_BASED_GATEWAY_KIND: string
    • EVENT_DEFINITION_KIND: string
    • EXTRA_CSS_CLASSES: string
    • GLOBAL_TASK_KIND: string
    • IS_INITIATING: string
    • IS_INSTANTIATING: string
    • IS_INTERRUPTING: string
    • MARKERS: string
    • MESSAGE_FLOW_ICON: string
    • SUB_PROCESS_KIND: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/MarkerIdentifier.html b/api/variables/MarkerIdentifier.html index 67ffd21e20..97382329e5 100644 --- a/api/variables/MarkerIdentifier.html +++ b/api/variables/MarkerIdentifier.html @@ -1,2 +1,2 @@ MarkerIdentifier | bpmn-visualization API Documentation

    Variable MarkerIdentifierConst Experimental

    MarkerIdentifier: {
        ARROW_DASH: string;
    } = ...

    WARN: You may use it to customize the BPMN Theme as suggested in the examples. But be aware that the way the default BPMN theme can be modified is subject to change.

    -

    Type declaration

    • ARROW_DASH: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • ARROW_DASH: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/StyleDefault.html b/api/variables/StyleDefault.html index 6460a176ac..9af9d8cef0 100644 --- a/api/variables/StyleDefault.html +++ b/api/variables/StyleDefault.html @@ -5,4 +5,4 @@
  • SHAPE_ACTIVITY_MARKER_ICON_MARGIN: number

    Spacing between 2 markers.

  • SHAPE_ACTIVITY_MARKER_ICON_SIZE: number

    Theoretical width of a marker. Used to position the markers when there are several markers.

  • SHAPE_ACTIVITY_TOP_MARGIN: number

    Margin between the top of icon and the top of the activity.

    -
  • SHAPE_ARC_SIZE: number
  • STROKE_WIDTH_THICK: number
  • STROKE_WIDTH_THIN: number
  • SUB_PROCESS_TRANSACTION_INNER_RECT_ARC_SIZE: number
  • SUB_PROCESS_TRANSACTION_INNER_RECT_OFFSET: number
  • TEXT_ANNOTATION_BORDER_LENGTH: number
  • TEXT_ANNOTATION_FILL_COLOR: string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • SHAPE_ARC_SIZE: number
  • STROKE_WIDTH_THICK: number
  • STROKE_WIDTH_THIN: number
  • SUB_PROCESS_TRANSACTION_INNER_RECT_ARC_SIZE: number
  • SUB_PROCESS_TRANSACTION_INNER_RECT_OFFSET: number
  • TEXT_ANNOTATION_BORDER_LENGTH: number
  • TEXT_ANNOTATION_FILL_COLOR: string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/mxgraph.html b/api/variables/mxgraph.html index 3f22b229ad..2f40c7b128 100644 --- a/api/variables/mxgraph.html +++ b/api/variables/mxgraph.html @@ -4,4 +4,4 @@ 
    // Get the mxGraph version
    const mxGraphVersion = mxgraph.mxClient.VERSION;
    // Call mxUtils in custom BPMN Shapes
    c.setFillColor(mxgraph.mxUtils.getValue(this.style, BpmnStyleIdentifier.EDGE_START_FILL_COLOR, this.stroke));

    Since

    0.30.0

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index 873f55b24b..7084174d1d 100644 --- a/index.html +++ b/index.html @@ -2006,7 +2006,7 @@