BpmnSubEvent API in JavaScript Diagram API control

Defines the behavior of the bpmn sub event

Properties

annotations

ShapeAnnotationModel[]

Defines the collection of textual annotations of the sub events

Defaults to undefined

event

string

Sets the type of the BPMN Event

• Start - Sets the type of the Bpmn Event as Start
• Intermediate - Sets the type of the Bpmn Event as Intermediate
• End - Sets the type of the Bpmn Event as End
• NonInterruptingStart - Sets the type of the Bpmn Event as NonInterruptingStart
• NonInterruptingIntermediate - Sets the type of the Bpmn Event as NonInterruptingIntermediate
• ThrowingIntermediate - Sets the type of the Bpmn Event as ThrowingIntermediate

Defaults to ‘Start’

height

number

Sets the height of the node

Defaults to undefined

horizontalAlignment

string

Sets how to horizontally align a node with respect to its immediate parent

• Stretch - Stretches the diagram element throughout its immediate parent
• Left - Aligns the diagram element at the left of its immediate parent
• Right - Aligns the diagram element at the right of its immediate parent
• Center - Aligns the diagram element at the center of its immediate parent
• Auto - Aligns the diagram element based on the characteristics of its immediate parent

Defaults to ‘Center’

id

string

Sets the id of the BPMN sub event

Defaults to ”

margin

MarginModel

Defines the space to be left between the node and its immediate parent

Defaults to 0

offset

PointModel

Defines the position of the sub event

Defaults to new Point(0.5,0.5)

ports

PointPortModel[]

Defines the collection of connection points of the sub events

Defaults to undefined

trigger

string

Defines the type of the trigger

• None - Sets the type of the trigger as None
• Message - Sets the type of the trigger as Message
• Escalation - Sets the type of the trigger as Escalation
• Link - Sets the type of the trigger as Link
• Error - Sets the type of the trigger as Error
• Compensation - Sets the type of the trigger as Compensation
• Signal - Sets the type of the trigger as Signal
• Multiple - Sets the type of the trigger as Multiple
• Parallel - Sets the type of the trigger as Parallel
• Cancel - Sets the type of the trigger as Cancel
• Conditional - Sets the type of the trigger as Conditional
• Terminate - Sets the type of the trigger as Terminate

Defaults to ‘None’

verticalAlignment

string

Sets how to vertically align a node with respect to its immediate parent

• Stretch - Stretches the diagram element throughout its immediate parent
• Top - Aligns the diagram element at the top of its immediate parent
• Bottom - Aligns the diagram element at the bottom of its immediate parent
• Center - Aligns the diagram element at the center of its immediate parent
• Auto - Aligns the diagram element based on the characteristics of its immediate parent

Defaults to ‘Center’

visible

boolean

Sets the visibility of the sub event

Defaults to true

width

number

Sets the width of the node

Defaults to undefined