<participant1><directionalarrow><participant2>:<message>
Usage: | participant'<displaylabel>' [as<somealias>] [#<colorname|hexcode>] [<<[(<letter>,<color>)][stereotypename]>>] [order<number>] |
---|
'RequestHandler'
)participant
keyword because PlantUML will automatically display a sender whenever it encounters one in the source.But using the keyword gives you the ability to set the following options:Options: |
| |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example: | You can show a message coming from or going to a participant not in the scope of the current diagram by using ] or [
|
Skinparams: | Participant ParticipantBorderThickness |
---|
actor
is a stereotype (synonym) for participant that displays a person stick figure instead of the standard box. All of the same options as participant can be used.Skinparams: | ActorBorderThickness Actor { } – note that the last Actor skinparams read will be the ones that are applied! |
---|
boundary
is a stereotype (synonym) for participant that displays a boundary image instead of the standard box. All of the same options as participant can be used.entity
is a stereotype (synonym) for participant that displays an entity image instead of the standard box. All of the same options as participant can be used.control
is a stereotype (synonym) for participant that displays a control image instead of the standard box. All of the same options as participant can be used.database
is asynonym for participant that displays a database image instead of the standard box. All of the same options as participant can be used.create
puts the first occurrence of the diagram for the participant within the diagram where this word appears instead of at the top of the page.Helps to show that an object is actually created at that point in time.Usage: | create <name> order <order number> |
---|
In the example above,create'AuthSystem'
is used to show exactly when the wrappedRequest is created
Skinparams: | Special note about arrows and skin params: the last one is the one used. ( an include and reference to .?) ArrowThickness Ex: skinparamSequenceArrowThickness4 Ex: skinparamSequence{ArrowThickness4} MessageAlignment MessageTextAlignment |
---|
>>
creates an unfilled arrow pointing to the right (This is an asynchronous message.)<<
creates an unfilled arrow pointing to the left (This is an asynchronous message.)>
creates a filled (solid) arrow head pointing to the right (This is a synchronous message.)<
creates a filled (solid) arrow head pointing to the left (This is a synchronous message.)
creates the top half (only) of an unfilled arrow pointing to the right//
creates the bottom half (only) of an unfilled arrow pointing to the right
creates the top half (only) of a filled arrow pointing to the right/
creates the bottom half (only) of a filled arrow pointing to the right?
means the arrow line is short; it is only as long as the label for it.?
is at the end, the arrow line is connected to the start (origin) and stops when the label for it stops.?
is at the end, then the arrow is connected to the end (target), and the arrow line is only as long as the arrow label.o
puts a final “o” at arrow head, denoting a lost messagex
puts an *X* at the end, denoting a destruction message.<->
-
creates a solid line--
(two dashes instead of just one) creates dotted line..
for an arrow line, PlantUML will think you are working with a Use Case diagram instead of a Sequence diagramand will change how it draws (renders) it.-[#magenta]>>
will create a magenta colored unfilled arrow with a solid line--[#939393]>
will create a gray colored filled arrow with a dashed lineUsage: | autonumber[start|resume][increment][format]
|
---|
activate
and deactivate
keywords are used to denote participant activation and deactivation on its lifeline.The UML 2.5 specification refers to this as an ExecutionSpecification: exactly what messages are called, and in what order, are specified in this particular section of the diagram.destroy
the lifeline of a participant, showing exactly when something is destroyed.Skinparams: | LifeLineBackgroundColor LifeLineBorderColor LifeLineBorderThickness |
---|
Usage: | activate<participant>[color] |
---|
Usage: | deactivate<participant> |
---|
Usage: | destroy<participant> |
---|
end
to signal where the frame endsSkinparam: | Even though these skinparams start with Group they apply to all frames.
|
---|
Usage: | alt'<text>' <..whatevergoeswithinthebox..> end InteractionOperator alt is used to show one or more alternative sequences that can happen. A dashed lineis used between the possible alternative sequences. alt is the frame name in the pentagon in the upper left hand corner. text is displayed in square brackets ( [] ) at the top of the frame; it describes or labels frame as a whole. |
---|
Usage: | else'<text>' <..whatevergoeswithinthebox..> end In the UML specification, else is the default sequence in a list of alternative sequences.The else InteractionOperator is used to show the sequence that will be used if the none of conditions forthe alt alternatives can be met. else is the frame name in the pentagon in the upper left hand corner. But in PlantUML_ this is how you label different alternatives. You can use the groupkeyword to specifically display the word “else” and use it per the UML Specification. text is displayed in square brackets ( [] ) at the top of the frame; it describes or labels this alternative. |
---|---|
Example: |
Usage: | opt'<text>' <..whatevergoeswithinthebox..> end An optional sequence. It either happens or not. opt is the frame name in the pentagon in the upper left hand corner. text is displayed in square brackets ( [] ) at the top of the frame; it describes or labels frame as a whole. |
---|
Usage: | loop'<text>' <..whatevergoeswithinthebox..> end Shows a sequence that loops. loop is the frame name in the pentagon in the upper left hand corner. text is displayed in square brackets ( [] ) at the top of the frame; it describes or labels frame as a whole. |
---|
Usage: | par'<text>' <..whatevergoeswithinthebox..> end Shows a parallel sequence. par is the frame name in the pentagon in the upper left hand corner. text is displayed in square brackets ( [] ) at the top of the frame; it describes or labels frame as a whole. |
---|
Usage: | break<text> <..whatevergoeswithinthebox..> end shows that a sequence breaks. It stops (does not perform) any of the remaining sequence does this instead. break is the frame name in the pentagon in the upper left hand corner. text is displayed in square brackets ( [] ) at the top of the frame; it describes or labels frame as a whole. |
---|
Usage: | critical'<text>' <..whatevergoeswithinthebox..> end A fragment of a sequence that cannot be “interleaved” by other fragments (e.g. parallel fragments, etc.). critical is the frame name in the pentagon in the upper left hand corner. How do i find my default gateway. text is displayed in square brackets ( [] ) at the top of the frame; it describes or labels frame as a whole. |
---|
Usage: | group'<framename>' <..whatevergoeswithinthebox..> end
|
---|
Usage: | ref'<framename>' A reference to some other interaction or diagram.ref is the frame name in the pentagon in the upper left hand corner. |
---|
Skinparam: | ReferenceAlignmentReferenceBackgroundColorReferenceBorderColorReferenceBorderThicknessReferenceFontColorReferenceFontNameReferenceFontSizeReferenceFontStyleReferenceHeaderBackgroundColor |
---|
Usage: | ..[<text>..] Indicates a delay in the diagram. You can optionally add text to describe the delay. |
---|
Skinparam: | DelayFontColorDelayFontNameDelayFontSizeDelayFontStyle |
---|
Skinparam: | DividerBackgroundColorDividerBorderColorDividerBorderThicknessDividerFontColorDividerFontNameDividerFontSizeDividerFontStyle |
---|