diff --git a/api/classes/BpmnCanvas.html b/api/classes/BpmnCanvas.html index ce55c718bd..c518db0e0d 100644 --- a/api/classes/BpmnCanvas.html +++ b/api/classes/BpmnCanvas.html @@ -9,7 +9,7 @@ 
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 @@ -30,11 +30,11 @@ setStrokeColor stroke translateIconOrigin -

Constructors

constructor

Methods

arcTo

begin

close

curveTo

ellipse

fill

fillAndStroke

lineTo

moveTo

rect

rotateOnIconCenter

roundrect

setFillColor

setIconOriginForIconBottomCentered

  • setIconOriginForIconBottomCentered(bottomMargin?): void
  • Experimental

    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
  • Experimental

    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
  • Experimental

    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

  • setIconOriginForIconBottomCentered(bottomMargin?): void
  • Experimental

    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
  • Experimental

    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
  • Experimental

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

    The values should be given with using the icon original size (as translated values will be scaled as other values passed to method of this class).

    Parameters

    • dx: number

      the horizontal translation

    • dy: number

      the vertical translation

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BpmnElementsRegistry.html b/api/classes/BpmnElementsRegistry.html index 5f0ca54d65..0a47cd3aae 100644 --- a/api/classes/BpmnElementsRegistry.html +++ b/api/classes/BpmnElementsRegistry.html @@ -4,7 +4,7 @@

WARN: subject to change, feedback welcome.

-

Implements

Methods

addCssClasses +

Implements

Methods

addCssClasses addOverlays getElementsByIds getElementsByKinds @@ -38,14 +38,14 @@
  • toggleCssClasses to toggle CSS classes on a BPMN element.
  • StyleRegistry#updateStyle to directly update the style of BPMN elements.
    • -

    addOverlays

    • addOverlays(bpmnElementId, overlays): void
    • Experimental

      Add one/several overlays to a BPMN element.

      +

    addOverlays

    getElementsByIds

    getElementsByIds

    getElementsByKinds

    Returns BpmnElement[]

    getElementsByKinds

    getModelElementsByIds

    Returns BpmnElement[]

    getModelElementsByIds

    getModelElementsByKinds

    getModelElementsByKinds

    removeAllCssClasses

    removeAllCssClasses

    removeAllOverlays

    removeAllOverlays

    removeCssClasses

    removeCssClasses

    resetStyle

    resetStyle

    Since

    0.37.0

    -

    toggleCssClasses

    toggleCssClasses

    • toggleCssClasses(bpmnElementIds, classNames): void
    • Experimental

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

        @@ -135,7 +135,7 @@
      • removeAllCssClasses to remove all CSS classes from a BPMN element.
      • addCssClasses to add CSS classes to a BPMN element.
      -

    updateStyle

    updateStyle

    • updateStyle(bpmnElementIds, styleUpdate): void
    • Experimental

      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',
        },
      });
@@ -157,4 +157,4 @@
 
    • CssClassesRegistry#toggleCssClasses to toggle CSS classes on a BPMN element.
      •

    Since

    0.33.0

    -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/api/classes/BpmnVisualization.html b/api/classes/BpmnVisualization.html index 805ea599a2..0193ff0cbd 100644 --- a/api/classes/BpmnVisualization.html +++ b/api/classes/BpmnVisualization.html @@ -3,21 +3,21 @@

    For more options, see GlobalOptions

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    bpmnElementsRegistry graph navigation

    Methods

    load -

    Constructors

    constructor

    Properties

    Readonly ExperimentalbpmnElementsRegistry

    bpmnElementsRegistry: BpmnElementsRegistry

    Interact with BPMN diagram elements rendered in the page.

    +

    Constructors

    constructor

    Properties

    Readonly ExperimentalbpmnElementsRegistry

    bpmnElementsRegistry: BpmnElementsRegistry

    Interact with BPMN diagram elements rendered in the page.

    WARN: subject to change, feedback welcome.

    -

    Readonly Experimentalgraph

    graph: BpmnGraph

    Direct access to the mxGraph instance that powers bpmn-visualization. +

    Readonly Experimentalgraph

    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 Experimentalnavigation

    navigation: Navigation

    Perform BPMN diagram navigation.

    +

    Readonly Experimentalnavigation

    navigation: Navigation

    Perform BPMN diagram navigation.

    WARN: subject to change, feedback welcome.

    Since

    0.24.0

    -

    Methods

    load

    Methods

    load

    • load(xml, options?): void

    • Load and render the BPMN diagram.

      Parameters

      • xml: string

        The BPMN content as xml string

      • Optionaloptions: LoadOptions

        Let decide how to load the model and render the diagram

      Returns void

      Throws

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/api/classes/IconPainter.html b/api/classes/IconPainter.html index 4ee86b2f2a..5a3dd2c7de 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

    ProtectednewBpmnCanvas

    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

    On This Page

    Constructors
    Methods
    +

    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

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/IconPainterProvider.html b/api/classes/IconPainterProvider.html index 79129859af..b182e6708d 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

    Staticget

    Staticset

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    Staticget

    Staticset

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/Navigation.html b/api/classes/Navigation.html index 8643fbba86..a884e83f54 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

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    fit

    zoom

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/ShapeUtil.html b/api/classes/ShapeUtil.html index 4f68455bfb..f9df63042a 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

    StaticactivityKinds

    StaticcanHaveNoneEvent

    StaticeventKinds

    StaticflowNodeKinds

    StaticgatewayKinds

    StaticisActivity

    StaticisBoundaryEvent

    StaticisCallActivity

    StaticisCatchEvent

    StaticisEvent

    StaticisGateway

    StaticisIntermediateCatchEvent

    StaticisIntermediateThrowEvent

    StaticisPoolOrLane

    StaticisStartEvent

    StaticisSubProcess

    StaticisTask

    StaticisWithDefaultSequenceFlow

    StatictaskKinds

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    StaticactivityKinds

    StaticcanHaveNoneEvent

    StaticeventKinds

    StaticflowNodeKinds

    StaticgatewayKinds

    StaticisActivity

    StaticisBoundaryEvent

    StaticisCallActivity

    StaticisCatchEvent

    StaticisEvent

    StaticisGateway

    StaticisIntermediateCatchEvent

    StaticisIntermediateThrowEvent

    StaticisPoolOrLane

    StaticisStartEvent

    StaticisSubProcess

    StaticisTask

    StaticisWithDefaultSequenceFlow

    StatictaskKinds

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/StyleConfigurator.html b/api/classes/StyleConfigurator.html index 97a86df696..f87a208331 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

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    configureStyles

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/enums/AssociationDirectionKind.html b/api/enums/AssociationDirectionKind.html index aa7005a2cd..00ff592599 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

    NONE

    NONE

    ONE

    ONE

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BOTH

    BOTH

    NONE

    NONE

    ONE

    ONE

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/FitType.html b/api/enums/FitType.html index f54a09b072..7511fc9cf8 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

    Fit and center the BPMN Diagram.

    -

    Horizontal

    Horizontal

    Fit only horizontally.

    -

    HorizontalVertical

    HorizontalVertical

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

    -

    None

    None

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

    -

    Vertical

    Vertical

    Fit only vertically.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Horizontal

    Horizontal

    Fit only horizontally.

    +

    HorizontalVertical

    HorizontalVertical

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

    +

    None

    None

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

    +

    Vertical

    Vertical

    Fit only vertically.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/FlowKind.html b/api/enums/FlowKind.html index 18b6f71d01..ec1f080b87 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

    MESSAGE_FLOW

    MESSAGE_FLOW

    SEQUENCE_FLOW

    SEQUENCE_FLOW

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ASSOCIATION_FLOW

    ASSOCIATION_FLOW

    MESSAGE_FLOW

    MESSAGE_FLOW

    SEQUENCE_FLOW

    SEQUENCE_FLOW

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/MessageVisibleKind.html b/api/enums/MessageVisibleKind.html index 0d6c078040..ab9664efd7 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 NON_INITIATING NONE -

    Enumeration Members

    INITIATING

    INITIATING

    NON_INITIATING

    NON_INITIATING

    NONE

    NONE

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    INITIATING

    INITIATING

    NON_INITIATING

    NON_INITIATING

    NONE

    NONE

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/SequenceFlowKind.html b/api/enums/SequenceFlowKind.html index f4fce70971..b722d1e132 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_GATEWAY

    CONDITIONAL_FROM_GATEWAY

    DEFAULT

    DEFAULT

    NORMAL

    NORMAL

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CONDITIONAL_FROM_ACTIVITY

    CONDITIONAL_FROM_ACTIVITY

    CONDITIONAL_FROM_GATEWAY

    CONDITIONAL_FROM_GATEWAY

    DEFAULT

    DEFAULT

    NORMAL

    NORMAL

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/ShapeBpmnCallActivityKind.html b/api/enums/ShapeBpmnCallActivityKind.html index c30034ed51..939bb135ee 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

    CALLING_PROCESS

    CALLING_PROCESS

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CALLING_GLOBAL_TASK

    CALLING_GLOBAL_TASK

    CALLING_PROCESS

    CALLING_PROCESS

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/ShapeBpmnElementKind.html b/api/enums/ShapeBpmnElementKind.html index 24aa1e9331..05be07b08d 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

    EVENT_BOUNDARY

    EVENT_BOUNDARY

    EVENT_END

    EVENT_END

    EVENT_INTERMEDIATE_CATCH

    EVENT_INTERMEDIATE_CATCH

    EVENT_INTERMEDIATE_THROW

    EVENT_INTERMEDIATE_THROW

    EVENT_START

    EVENT_START

    GATEWAY_COMPLEX

    GATEWAY_COMPLEX

    GATEWAY_EVENT_BASED

    GATEWAY_EVENT_BASED

    GATEWAY_EXCLUSIVE

    GATEWAY_EXCLUSIVE

    GATEWAY_INCLUSIVE

    GATEWAY_INCLUSIVE

    GATEWAY_PARALLEL

    GATEWAY_PARALLEL

    GLOBAL_TASK

    GLOBAL_TASK

    GLOBAL_TASK_BUSINESS_RULE

    GLOBAL_TASK_BUSINESS_RULE

    GLOBAL_TASK_MANUAL

    GLOBAL_TASK_MANUAL

    GLOBAL_TASK_SCRIPT

    GLOBAL_TASK_SCRIPT

    GLOBAL_TASK_USER

    GLOBAL_TASK_USER

    GROUP

    GROUP

    LANE

    LANE

    POOL

    POOL

    SUB_PROCESS

    SUB_PROCESS

    TASK

    TASK

    TASK_BUSINESS_RULE

    TASK_BUSINESS_RULE

    TASK_MANUAL

    TASK_MANUAL

    TASK_RECEIVE

    TASK_RECEIVE

    TASK_SCRIPT

    TASK_SCRIPT

    TASK_SEND

    TASK_SEND

    TASK_SERVICE

    TASK_SERVICE

    TASK_USER

    TASK_USER

    TEXT_ANNOTATION

    TEXT_ANNOTATION

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CALL_ACTIVITY

    CALL_ACTIVITY

    EVENT_BOUNDARY

    EVENT_BOUNDARY

    EVENT_END

    EVENT_END

    EVENT_INTERMEDIATE_CATCH

    EVENT_INTERMEDIATE_CATCH

    EVENT_INTERMEDIATE_THROW

    EVENT_INTERMEDIATE_THROW

    EVENT_START

    EVENT_START

    GATEWAY_COMPLEX

    GATEWAY_COMPLEX

    GATEWAY_EVENT_BASED

    GATEWAY_EVENT_BASED

    GATEWAY_EXCLUSIVE

    GATEWAY_EXCLUSIVE

    GATEWAY_INCLUSIVE

    GATEWAY_INCLUSIVE

    GATEWAY_PARALLEL

    GATEWAY_PARALLEL

    GLOBAL_TASK

    GLOBAL_TASK

    GLOBAL_TASK_BUSINESS_RULE

    GLOBAL_TASK_BUSINESS_RULE

    GLOBAL_TASK_MANUAL

    GLOBAL_TASK_MANUAL

    GLOBAL_TASK_SCRIPT

    GLOBAL_TASK_SCRIPT

    GLOBAL_TASK_USER

    GLOBAL_TASK_USER

    GROUP

    GROUP

    LANE

    LANE

    POOL

    POOL

    SUB_PROCESS

    SUB_PROCESS

    TASK

    TASK

    TASK_BUSINESS_RULE

    TASK_BUSINESS_RULE

    TASK_MANUAL

    TASK_MANUAL

    TASK_RECEIVE

    TASK_RECEIVE

    TASK_SCRIPT

    TASK_SCRIPT

    TASK_SEND

    TASK_SEND

    TASK_SERVICE

    TASK_SERVICE

    TASK_USER

    TASK_USER

    TEXT_ANNOTATION

    TEXT_ANNOTATION

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/ShapeBpmnEventBasedGatewayKind.html b/api/enums/ShapeBpmnEventBasedGatewayKind.html index 0921776758..4e41d305b9 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

    None

    None

    When no type is provided in the BPMN source.

    -

    Parallel

    Parallel

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Exclusive

    Exclusive

    None

    None

    When no type is provided in the BPMN source.

    +

    Parallel

    Parallel

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/ShapeBpmnEventDefinitionKind.html b/api/enums/ShapeBpmnEventDefinitionKind.html index 3a2b1451ed..f698fdc829 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 <enum_value>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

    COMPENSATION

    COMPENSATION

    CONDITIONAL

    CONDITIONAL

    ERROR

    ERROR

    ESCALATION

    ESCALATION

    LINK

    LINK

    MESSAGE

    MESSAGE

    NONE

    NONE

    SIGNAL

    SIGNAL

    TERMINATE

    TERMINATE

    TIMER

    TIMER

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CANCEL

    CANCEL

    COMPENSATION

    COMPENSATION

    CONDITIONAL

    CONDITIONAL

    ERROR

    ERROR

    ESCALATION

    ESCALATION

    LINK

    LINK

    MESSAGE

    MESSAGE

    NONE

    NONE

    SIGNAL

    SIGNAL

    TERMINATE

    TERMINATE

    TIMER

    TIMER

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/ShapeBpmnMarkerKind.html b/api/enums/ShapeBpmnMarkerKind.html index b50adf18cc..dce960a453 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

    COMPENSATION

    COMPENSATION

    EXPAND

    EXPAND

    LOOP

    LOOP

    MULTI_INSTANCE_PARALLEL

    MULTI_INSTANCE_PARALLEL

    MULTI_INSTANCE_SEQUENTIAL

    MULTI_INSTANCE_SEQUENTIAL

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ADHOC

    ADHOC

    COMPENSATION

    COMPENSATION

    EXPAND

    EXPAND

    LOOP

    LOOP

    MULTI_INSTANCE_PARALLEL

    MULTI_INSTANCE_PARALLEL

    MULTI_INSTANCE_SEQUENTIAL

    MULTI_INSTANCE_SEQUENTIAL

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/ShapeBpmnSubProcessKind.html b/api/enums/ShapeBpmnSubProcessKind.html index aecee71bc8..45bdad1905 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

    EMBEDDED

    EMBEDDED

    EVENT

    EVENT

    TRANSACTION

    TRANSACTION

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    AD_HOC

    AD_HOC

    EMBEDDED

    EMBEDDED

    EVENT

    EVENT

    TRANSACTION

    TRANSACTION

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/enums/ZoomType.html b/api/enums/ZoomType.html index e1c9d49bd6..aa69fba1a0 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

    Out

    Out

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    In

    In

    Out

    Out

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/functions/getVersion.html b/api/functions/getVersion.html index 9303fdc07c..efcfa16928 100644 --- a/api/functions/getVersion.html +++ b/api/functions/getVersion.html @@ -1,3 +1,3 @@ getVersion | bpmn-visualization API Documentation

    Function getVersion

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

    Since

    0.43.0

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/interfaces/BaseBpmnSemantic.html b/api/interfaces/BaseBpmnSemantic.html index c45e43184a..1e8b9561e1 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

    On This Page

    Properties
    +

    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

    On This Page

    Properties
    diff --git a/api/interfaces/BpmnCanvasConfiguration.html b/api/interfaces/BpmnCanvasConfiguration.html index fe6876c5ef..0941a0af25 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

    Experimentalcanvas

    canvas: mxAbstractCanvas2D

    ExperimentaliconConfig

    iconConfig: IconConfiguration

    ExperimentalshapeConfig

    shapeConfig: ShapeConfiguration

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Experimentalcanvas

    canvas: mxAbstractCanvas2D

    ExperimentaliconConfig

    iconConfig: IconConfiguration

    ExperimentalshapeConfig

    shapeConfig: ShapeConfiguration

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/BpmnElement.html b/api/interfaces/BpmnElement.html index be29822ae3..55638cb692 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

    On This Page

    Properties
    +

    Properties

    bpmnSemantic

    bpmnSemantic: BpmnSemantic

    htmlElement

    htmlElement: HTMLElement

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/CssClassesRegistry.html b/api/interfaces/CssClassesRegistry.html index f5dd013d2c..045fa6431b 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: string | string[], classNames: string | string[]): void;
        removeAllCssClasses(bpmnElementIds?: string | string[]): void;
        removeCssClasses(bpmnElementIds: string | string[], classNames: string | string[]): void;
        toggleCssClasses(bpmnElementIds: string | string[], classNames: string | string[]): void;
    }

    Implemented by

    Methods

    addCssClasses +CssClassesRegistry | bpmn-visualization API Documentation

    Interface CssClassesRegistry

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

    Implemented by

    Methods

    addCssClasses removeAllCssClasses removeCssClasses toggleCssClasses @@ -24,7 +24,7 @@
  • toggleCssClasses to toggle CSS classes on a BPMN element.
  • StyleRegistry#updateStyle to directly update the style of BPMN elements.
    • -

    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.

      +

    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

      • OptionalbpmnElementIds: 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.

        @@ -33,7 +33,7 @@

        See

        removeCssClasses to remove specific classes from a BPMN element.

        Since

        0.34.0

        -

    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.

      +

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

        @@ -41,7 +41,7 @@

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

        @@ -53,4 +53,4 @@
      • removeAllCssClasses to remove all CSS classes from a BPMN element.
      • addCssClasses to add CSS classes to a BPMN element.
      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/api/interfaces/EdgeBpmnSemantic.html b/api/interfaces/EdgeBpmnSemantic.html index fe54502f7e..0e6361f8da 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

    On This Page

    Properties
    +

    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

    On This Page

    Properties
    diff --git a/api/interfaces/ElementsRegistry.html b/api/interfaces/ElementsRegistry.html index e795f65f92..bcfd8d631d 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: string | string[]): BpmnElement[];
        getElementsByKinds(bpmnKinds: BpmnElementKind | BpmnElementKind[]): BpmnElement[];
        getModelElementsByIds(bpmnElementIds: string | string[]): BpmnSemantic[];
        getModelElementsByKinds(bpmnKinds: BpmnElementKind | BpmnElementKind[]): BpmnSemantic[];
    }

    Implemented by

    Methods

    getElementsByIds +ElementsRegistry | bpmn-visualization API Documentation

    Interface ElementsRegistry

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

    Implemented by

    Methods

    getElementsByIds getElementsByKinds getModelElementsByIds getModelElementsByKinds @@ -11,7 +11,7 @@ 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
      ...
      @@ -19,7 +19,7 @@

      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
      ...
      @@ -27,11 +27,11 @@

      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(bpmnKinds): BpmnSemantic[]

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

      +

    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

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/api/interfaces/FitOptions.html b/api/interfaces/FitOptions.html index c9e5e69104..f2fa663f07 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

    Optionalmargin

    margin?: number

    Negative values fallback to default.

    Default

    0
    -

    Optionaltype

    type?: FitType

    Default

    FitType.None

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionaltype

    type?: FitType

    Default

    FitType.None

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/GlobalOptions.html b/api/interfaces/GlobalOptions.html index 065e949227..de7bccfa97 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.

    -

    Optionalnavigation

    navigation?: NavigationConfiguration

    Configure the BPMN diagram navigation (panning and zoom).

    -

    Optionalparser

    parser?: ParserOptions

    Configure the BPMN parser.

    -

    Optionalrenderer

    renderer?: RendererOptions

    Configure how the BPMN diagram and its elements are rendered.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalnavigation

    navigation?: NavigationConfiguration

    Configure the BPMN diagram navigation (panning and zoom).

    +

    Optionalparser

    parser?: ParserOptions

    Configure the BPMN parser.

    +

    Optionalrenderer

    renderer?: RendererOptions

    Configure how the BPMN diagram and its elements are rendered.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/IconConfiguration.html b/api/interfaces/IconConfiguration.html index 59dc812dc6..ec22c64ae4 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: BpmnCanvas) => void);
        styleConfig: IconStyleConfiguration;
    }

    Properties

    originalSize +IconConfiguration | bpmn-visualization API Documentation

    Interface IconConfiguration

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

    Properties

    originalSize ratioFromParent? setIconOriginFunct styleConfig -

    Properties

    originalSize

    originalSize: Size

    OptionalratioFromParent

    ratioFromParent?: number

    If undefined, no scaling will be done in BpmnCanvas.

    -

    setIconOriginFunct

    setIconOriginFunct: ((canvas: BpmnCanvas) => void)

    styleConfig

    styleConfig: IconStyleConfiguration

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    originalSize

    originalSize: Size

    OptionalratioFromParent

    ratioFromParent?: number

    If undefined, no scaling will be done in BpmnCanvas.

    +

    setIconOriginFunct

    setIconOriginFunct: ((canvas: BpmnCanvas) => void)

    styleConfig

    styleConfig: IconStyleConfiguration

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/IconStyleConfiguration.html b/api/interfaces/IconStyleConfiguration.html index 62fb9ed0fc..5c8386c46e 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

    On This Page

    Properties
    +

    Properties

    fillColor

    fillColor: string

    isFilled

    isFilled: boolean

    margin

    margin: number

    strokeColor

    strokeColor: string

    strokeWidth

    strokeWidth: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/LoadOptions.html b/api/interfaces/LoadOptions.html index e0592328da..e570d3c8a0 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

    Optionalfit

    fit?: FitOptions

    OptionalmodelFilter

    modelFilter?: ModelFilter

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalfit

    fit?: FitOptions

    OptionalmodelFilter

    modelFilter?: ModelFilter

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ModelFilter.html b/api/interfaces/ModelFilter.html index f673943a25..7d884ed0da 100644 --- a/api/interfaces/ModelFilter.html +++ b/api/interfaces/ModelFilter.html @@ -3,5 +3,5 @@ 
    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

    Optionalpools

    pools?: PoolFilter | PoolFilter[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface ModelFilter {
        pools?: PoolFilter | PoolFilter[];
    }

    Properties

    pools? +

    Properties

    Optionalpools

    pools?: PoolFilter | PoolFilter[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/NavigationConfiguration.html b/api/interfaces/NavigationConfiguration.html index 257b58b1f1..63555efce2 100644 --- a/api/interfaces/NavigationConfiguration.html +++ b/api/interfaces/NavigationConfiguration.html @@ -1,10 +1,10 @@ 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
    -

    Optionalzoom

    zoom?: ZoomConfiguration

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalzoom

    zoom?: ZoomConfiguration

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

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/OverlaysRegistry.html b/api/interfaces/OverlaysRegistry.html index a10de73bfb..eec4af2618 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: string, overlays: Overlay | Overlay[]): void;
        removeAllOverlays(bpmnElementId: string): void;
    }

    Implemented by

    Methods

    addOverlays +OverlaysRegistry | bpmn-visualization API Documentation

    Interface OverlaysRegistry

    interface OverlaysRegistry {
        addOverlays(bpmnElementId: string, overlays: Overlay | Overlay[]): void;
        removeAllOverlays(bpmnElementId: string): 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.

      @@ -7,11 +7,11 @@

    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(bpmnElementId): void

    • Remove all overlays of a BPMN element.

      +

    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

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/api/interfaces/PaintParameter.html b/api/interfaces/PaintParameter.html index 82543384a3..39e6693f39 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: BpmnCanvas) => void);
        shapeConfig: ShapeConfiguration;
    }

    Properties

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

    Properties

    canvas iconStyleConfig ratioFromParent? setIconOriginFunct shapeConfig

    Properties

    Experimentalcanvas

    canvas: mxAbstractCanvas2D

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

    -

    ExperimentaliconStyleConfig

    iconStyleConfig: IconStyleConfiguration

    The style configuration of the icon.

    -

    Optional ExperimentalratioFromParent

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

    ExperimentaliconStyleConfig

    iconStyleConfig: IconStyleConfiguration

    The style configuration of the icon.

    +

    Optional ExperimentalratioFromParent

    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: BpmnCanvas) => void)

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

    -

    ExperimentalshapeConfig

    shapeConfig: ShapeConfiguration

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    setIconOriginFunct

    setIconOriginFunct: ((canvas: BpmnCanvas) => void)

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

    +

    ExperimentalshapeConfig

    shapeConfig: ShapeConfiguration

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

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/PoolFilter.html b/api/interfaces/PoolFilter.html index 45b1448b3a..934d025890 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

    Optionalid

    id?: string

    id of the Participant related to the Pool to display

    -

    Optionalname

    name?: string

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

    Optionalname

    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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ShapeBpmnSemantic.html b/api/interfaces/ShapeBpmnSemantic.html index 864df0de5c..8151d9e83c 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

    OptionalcallActivityGlobalTaskKind

    callActivityGlobalTaskKind?: GlobalTaskKind

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

    -

    OptionalcallActivityKind

    callActivityKind?: ShapeBpmnCallActivityKind

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

    -

    OptionaleventDefinitionKind

    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

    OptionallinkEventSourceIds

    linkEventSourceIds?: string[]

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

    -

    OptionallinkEventTargetId

    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:

    +

    OptionalcallActivityKind

    callActivityKind?: ShapeBpmnCallActivityKind

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

    +

    OptionaleventDefinitionKind

    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

    OptionallinkEventSourceIds

    linkEventSourceIds?: string[]

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

    +

    OptionallinkEventTargetId

    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.

    -

    OptionalsubProcessKind

    subProcessKind?: ShapeBpmnSubProcessKind

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalsubProcessKind

    subProcessKind?: ShapeBpmnSubProcessKind

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

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ShapeConfiguration.html b/api/interfaces/ShapeConfiguration.html index 7fd35bea64..5fe8f7c8aa 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

    OptionalstrokeWidth

    strokeWidth?: number

    width

    width: number

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    height

    height: number

    OptionalstrokeWidth

    strokeWidth?: number

    width

    width: number

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/Size.html b/api/interfaces/Size.html index 18545e61e6..ffeb28d610 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

    On This Page

    Properties
    +

    Properties

    height

    height: number

    width

    width: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/StyleRegistry.html b/api/interfaces/StyleRegistry.html index bb31c6a6e7..aaab4fc834 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?: string | string[]): void;
        updateStyle(bpmnElementIds: string | string[], styleUpdate: StyleUpdate): void;
    }

    Implemented by

    Methods

    resetStyle +StyleRegistry | bpmn-visualization API Documentation

    Interface StyleRegistry

    interface StyleRegistry {
        resetStyle(bpmnElementIds?: string | string[]): void;
        updateStyle(bpmnElementIds: string | string[], styleUpdate: 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

      • OptionalbpmnElementIds: string | string[]

        The BPMN ID of the element(s) whose style must be reset. @@ -22,7 +22,7 @@

      • CssClassesRegistry#toggleCssClasses to toggle CSS classes on a BPMN element.

      Since

      0.37.0

      -

    updateStyle

    • updateStyle(bpmnElementIds, styleUpdate): void

    • Update the style of one or several BPMN elements.

      +

    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',
        },
      });
@@ -44,4 +44,4 @@
 
    • CssClassesRegistry#toggleCssClasses to toggle CSS classes on a BPMN element.
      •

    Since

    0.33.0

    -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/api/interfaces/Version.html b/api/interfaces/Version.html index 07df5c4ccf..10ae37711e 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

    On This Page

    Properties
    +

    lib

    lib: string

    The bpmn-visualization version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ZoomConfiguration.html b/api/interfaces/ZoomConfiguration.html index b0c2388a30..e778b3ea2f 100644 --- a/api/interfaces/ZoomConfiguration.html +++ b/api/interfaces/ZoomConfiguration.html @@ -1,15 +1,15 @@ 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

    OptionaldebounceDelay

    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
    -

    OptionalthrottleDelay

    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 +

    OptionalthrottleDelay

    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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/types/BpmnElementKind.html b/api/types/BpmnElementKind.html index 6b2d1955c4..23d4dfacbd 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
    +BpmnElementKind | bpmn-visualization API Documentation

    Type Alias BpmnElementKind

    BpmnElementKind: FlowKind | ShapeBpmnElementKind

    Settings

    Member Visibility
    diff --git a/api/types/BpmnEventKind.html b/api/types/BpmnEventKind.html index 7ec4134362..5511b265a9 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
    +

    Settings

    Member Visibility
    diff --git a/api/types/BpmnSemantic.html b/api/types/BpmnSemantic.html index 2c9b83c7ea..53a281ee72 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
    +BpmnSemantic | bpmn-visualization API Documentation

    Type Alias BpmnSemantic

    BpmnSemantic: EdgeBpmnSemantic | ShapeBpmnSemantic

    Settings

    Member Visibility
    diff --git a/api/types/EdgeStyleUpdate.html b/api/types/EdgeStyleUpdate.html index 1582cc8004..3f412fa087 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.
    • -
  • Optionalstroke?: Stroke

    • Settings

    Member Visibility
    +
  • Optionalstroke?: Stroke

    • Settings

    Member Visibility
    diff --git a/api/types/Fill.html b/api/types/Fill.html index e8bb59aed6..d52752baea 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
    +

    Settings

    Member Visibility
    diff --git a/api/types/FillColorGradient.html b/api/types/FillColorGradient.html index 628b9d538e..c4fde8b1cd 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
    +

    Settings

    Member Visibility
    diff --git a/api/types/Font.html b/api/types/Font.html index 087c059309..b0e3b54e3b 100644 --- a/api/types/Font.html +++ b/api/types/Font.html @@ -25,4 +25,4 @@
  • Optionalsize?: number

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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/GlobalTaskKind.html b/api/types/GlobalTaskKind.html index 1630258fc8..11c4763d65 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
    +

    Settings

    Member Visibility
    diff --git a/api/types/GradientDirection.html b/api/types/GradientDirection.html index 461d40786f..c7b5077f93 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
    +GradientDirection | bpmn-visualization API Documentation

    Type Alias GradientDirection

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

    Settings

    Member Visibility
    diff --git a/api/types/Opacity.html b/api/types/Opacity.html index 027f360e67..6109584349 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
    +Opacity | bpmn-visualization API Documentation

    Type Alias Opacity

    Opacity: "default" | number

    Settings

    Member Visibility
    diff --git a/api/types/Overlay.html b/api/types/Overlay.html index ba6821b394..0c8401f165 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;
    }

    Settings

    Member Visibility
    +Overlay | bpmn-visualization API Documentation

    Type Alias Overlay

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

    Settings

    Member Visibility
    diff --git a/api/types/OverlayEdgePosition.html b/api/types/OverlayEdgePosition.html index 850028029c..fb8694f078 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
    +OverlayEdgePosition | bpmn-visualization API Documentation

    Type Alias OverlayEdgePosition

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

    Settings

    Member Visibility
    diff --git a/api/types/OverlayFill.html b/api/types/OverlayFill.html index d88b7841b7..511b25fd9c 100644 --- a/api/types/OverlayFill.html +++ b/api/types/OverlayFill.html @@ -3,4 +3,4 @@

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

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

    Default

    StyleDefault.DEFAULT_OVERLAY_FILL_OPACITY

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/OverlayFont.html b/api/types/OverlayFont.html index c56f9d6f0c..1d530285f7 100644 --- a/api/types/OverlayFont.html +++ b/api/types/OverlayFont.html @@ -1,4 +1,4 @@ OverlayFont | bpmn-visualization API Documentation

    Type Alias OverlayFont

    OverlayFont: {
        color?: string;
        size?: number;
    }

    The font family is StyleDefault.DEFAULT_FONT_FAMILY.

    Type declaration

    • Optionalcolor?: string

      Default

      StyleDefault.DEFAULT_OVERLAY_FONT_COLOR

    • Optionalsize?: number

      Default

      StyleDefault.DEFAULT_OVERLAY_FONT_SIZE

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/OverlayPosition.html b/api/types/OverlayPosition.html index 2d086ad0ab..831945400c 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
    +OverlayPosition | bpmn-visualization API Documentation

    Type Alias OverlayPosition

    OverlayPosition: OverlayShapePosition | OverlayEdgePosition

    Settings

    Member Visibility
    diff --git a/api/types/OverlayShapePosition.html b/api/types/OverlayShapePosition.html index ed07df59c7..1d68179d1b 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
    +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
    diff --git a/api/types/OverlayStroke.html b/api/types/OverlayStroke.html index 30566e17bd..24b3ba97b6 100644 --- a/api/types/OverlayStroke.html +++ b/api/types/OverlayStroke.html @@ -6,4 +6,4 @@

    Default

    StyleDefault.DEFAULT_OVERLAY_STROKE_COLOR

  • Optionalwidth?: 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

    StyleDefault.DEFAULT_OVERLAY_STROKE_WIDTH

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/OverlayStyle.html b/api/types/OverlayStyle.html index 2c9aa87a5c..1fbe4c332f 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;
    }

    Settings

    Member Visibility
    +OverlayStyle | bpmn-visualization API Documentation

    Type Alias OverlayStyle

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

    Settings

    Member Visibility
    diff --git a/api/types/ParserOptions.html b/api/types/ParserOptions.html index 69cf67dbe0..6ed0f80d5b 100644 --- a/api/types/ParserOptions.html +++ b/api/types/ParserOptions.html @@ -9,4 +9,4 @@

    Default

    false
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/RendererOptions.html b/api/types/RendererOptions.html index 7620c985cd..cbd67c1fc3 100644 --- a/api/types/RendererOptions.html +++ b/api/types/RendererOptions.html @@ -6,4 +6,4 @@

    Since

    0.35.0

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/ShapeStyleUpdate.html b/api/types/ShapeStyleUpdate.html index c62ce27883..51624c0240 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;
    }

    Settings

    Member Visibility
    +ShapeStyleUpdate | bpmn-visualization API Documentation

    Type Alias ShapeStyleUpdate

    ShapeStyleUpdate: EdgeStyleUpdate & {
        fill?: Fill;
    }

    Settings

    Member Visibility
    diff --git a/api/types/Stroke.html b/api/types/Stroke.html index e51a35c785..eaf67fa3d6 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
    +

    Settings

    Member Visibility
    diff --git a/api/types/StyleUpdate.html b/api/types/StyleUpdate.html index 34bd8d5bf5..fd5577c2d1 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
    +StyleUpdate | bpmn-visualization API Documentation

    Type Alias StyleUpdate

    StyleUpdate: EdgeStyleUpdate | ShapeStyleUpdate

    Settings

    Member Visibility
    diff --git a/api/types/StyleWithOpacity.html b/api/types/StyleWithOpacity.html index 9d292d4480..e677fca190 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
    +

    Settings

    Member Visibility
    diff --git a/api/variables/BpmnStyleIdentifier.html b/api/variables/BpmnStyleIdentifier.html index fee5739d99..44e0adc583 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/MarkerIdentifier.html b/api/variables/MarkerIdentifier.html index 1f0aee5f6c..7c4c9e4d6c 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/StyleDefault.html b/api/variables/StyleDefault.html index 93967f1d00..83af84665b 100644 --- a/api/variables/StyleDefault.html +++ b/api/variables/StyleDefault.html @@ -5,4 +5,4 @@
  • ExperimentalSHAPE_ACTIVITY_MARKER_ICON_MARGIN: number

    Spacing between 2 markers.

  • ExperimentalSHAPE_ACTIVITY_MARKER_ICON_SIZE: number

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

  • ExperimentalSHAPE_ACTIVITY_TOP_MARGIN: number

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

    -
  • ExperimentalSHAPE_ARC_SIZE: number
  • ExperimentalSTROKE_WIDTH_THICK: number
  • ExperimentalSTROKE_WIDTH_THIN: number
  • ExperimentalSUB_PROCESS_TRANSACTION_INNER_RECT_ARC_SIZE: number
  • ExperimentalSUB_PROCESS_TRANSACTION_INNER_RECT_OFFSET: number
  • ExperimentalTEXT_ANNOTATION_BORDER_LENGTH: number
  • ExperimentalTEXT_ANNOTATION_FILL_COLOR: string

    • Settings

    Member Visibility
    +
  • ExperimentalSHAPE_ARC_SIZE: number
  • ExperimentalSTROKE_WIDTH_THICK: number
  • ExperimentalSTROKE_WIDTH_THIN: number
  • ExperimentalSUB_PROCESS_TRANSACTION_INNER_RECT_ARC_SIZE: number
  • ExperimentalSUB_PROCESS_TRANSACTION_INNER_RECT_OFFSET: number
  • ExperimentalTEXT_ANNOTATION_BORDER_LENGTH: number
  • ExperimentalTEXT_ANNOTATION_FILL_COLOR: string

    • Settings

    Member Visibility
    diff --git a/api/variables/mxgraph.html b/api/variables/mxgraph.html index bc1116b134..1b4a4d2e85 100644 --- a/api/variables/mxgraph.html +++ b/api/variables/mxgraph.html @@ -5,4 +5,4 @@

    Since

    0.30.0

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/index.html b/index.html index a14af11f52..f17546a528 100644 --- a/index.html +++ b/index.html @@ -2011,7 +2011,7 @@