PlantUML Language specification State Diagram

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Diagramme d'état

• Langage basé sur le texte: Définir et visualiser rapidement les états et les transitions sans les inconvénients du dessin manuel.
• Efficacité et cohérence: Assurez une création de diagramme rationalisée et un contrôle de version facile.
• Polyvalence: S'intègre à diverses plates-formes de documentation et prend en charge plusieurs formats de sortie.
• Open-Source & Community Support: Soutenu par une communauté solide qui contribue continuellement à ses améliorations et offre des ressources inestimables.

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Exemple simple

@startuml [*] --> State1 State1 --> [*] State1 : this is a string State1 : this is another string State1 -> State2 State2 --> [*] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Autre rendu

@startuml hide empty description [*] --> State1 State1 --> [*] State1 : this is a string State1 : this is another string State1 -> State2 State2 --> [*] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

État composite

Sous-état interne

@startuml scale 350 width [*] --> NotShooting state NotShooting { [*] --> Idle Idle --> Configuring : EvConfig Configuring --> Idle : EvConfig } state Configuring { [*] --> NewValueSelection NewValueSelection --> NewValuePreview : EvNewValue NewValuePreview --> NewValueSelection : EvNewValueRejected NewValuePreview --> NewValueSelection : EvNewValueSaved state NewValuePreview { State1 -> State2 } } @enduml

Lien entre sous-états

@startuml state A { state X { } state Y { } } state B { state Z { } } X --> Z Z --> Y @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Nom long

@startuml scale 600 width [*] -> State1 State1 --> State2 : Succeeded State1 --> [*] : Aborted State2 --> State3 : Succeeded State2 --> [*] : Aborted state State3 { state "Accumulate Enough Data\nLong State Name" as long1 long1 : Just a test [*] --> long1 long1 --> long1 : New Data long1 --> ProcessData : Enough Data } State3 --> State3 : Failed State3 --> [*] : Succeeded / Save Result State3 --> [*] : Aborted @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Historique de sous-état [[H], [H*]]

@startuml [*] -> State1 State1 --> State2 : Succeeded State1 --> [*] : Aborted State2 --> State3 : Succeeded State2 --> [*] : Aborted state State3 { state "Accumulate Enough Data" as long1 long1 : Just a test [*] --> long1 long1 --> long1 : New Data long1 --> ProcessData : Enough Data State2 --> [H]: Resume } State3 --> State2 : Pause State2 --> State3[H*]: DeepResume State3 --> State3 : Failed State3 --> [*] : Succeeded / Save Result State3 --> [*] : Aborted @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

États parallèles [fork, join]

@startuml state fork_state <<fork>> [*] --> fork_state fork_state --> State2 fork_state --> State3 state join_state <<join>> State2 --> join_state State3 --> join_state join_state --> State4 State4 --> [*] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

États concurrents [--, ||]

Séparateur horizontal --

@startuml [*] --> Active state Active { [*] -> NumLockOff NumLockOff --> NumLockOn : EvNumLockPressed NumLockOn --> NumLockOff : EvNumLockPressed -- [*] -> CapsLockOff CapsLockOff --> CapsLockOn : EvCapsLockPressed CapsLockOn --> CapsLockOff : EvCapsLockPressed -- [*] -> ScrollLockOff ScrollLockOff --> ScrollLockOn : EvCapsLockPressed ScrollLockOn --> ScrollLockOff : EvCapsLockPressed } @enduml

Séparateur vertical ||

@startuml [*] --> Active state Active { [*] -> NumLockOff NumLockOff --> NumLockOn : EvNumLockPressed NumLockOn --> NumLockOff : EvNumLockPressed || [*] -> CapsLockOff CapsLockOff --> CapsLockOn : EvCapsLockPressed CapsLockOn --> CapsLockOff : EvCapsLockPressed || [*] -> ScrollLockOff ScrollLockOff --> ScrollLockOn : EvCapsLockPressed ScrollLockOn --> ScrollLockOff : EvCapsLockPressed } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Conditionnel [choice]

@startuml state "Req(Id)" as ReqId <<sdlreceive>> state "Minor(Id)" as MinorId state "Major(Id)" as MajorId state c <<choice>> Idle --> ReqId ReqId --> c c --> MinorId : [Id <= 10] c --> MajorId : [Id > 10] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Exemple avec tous les stéréotypes [choice, fork, join, end]

@startuml state choice1 <<choice>> state fork1 <<fork>> state join2 <<join>> state end3 <<end>> [*] --> choice1 : de ""start""\nà ""choice"" choice1 --> fork1 : de ""choice""\nà ""fork"" choice1 --> join2 : de ""choice""\nà ""join"" choice1 --> end3 : de ""choice""\nà ""end"" fork1 ---> State1 : de ""fork""\nà ""state"" fork1 --> State2 : de ""fork""\nà ""state"" State2 --> join2 : de ""state""\nà ""join"" State1 --> [*] : de ""state""\nà ""end"" join2 --> [*] : de ""join""\nà ""end"" @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Petits cercles [entryPoint, exitPoint]

@startuml state Somp { state entry1 <<entryPoint>> state entry2 <<entryPoint>> state sin entry1 --> sin entry2 -> sin sin -> sin2 sin2 --> exitA <<exitPoint>> } [*] --> entry1 exitA --> Foo Foo1 -> entry2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Petits carrés [inputPin, outputPin]

@startuml state Somp { state entry1 <<inputPin>> state entry2 <<inputPin>> state sin entry1 --> sin entry2 -> sin sin -> sin2 sin2 --> exitA <<outputPin>> } [*] --> entry1 exitA --> Foo Foo1 -> entry2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Multiples petits carrés [expansionInput, expansionOutput]

@startuml state Somp { state entry1 <<expansionInput>> state entry2 <<expansionInput>> state sin entry1 --> sin entry2 -> sin sin -> sin2 sin2 --> exitA <<expansionOutput>> } [*] --> entry1 exitA --> Foo Foo1 -> entry2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Direction des flèches

• -down-> (flèche par défaut)
• -right-> or ->
• -left->
• -up->

@startuml [*] -up-> First First -right-> Second Second --> Third Third -left-> Last @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Changer la couleur ou le style des flèches

@startuml State S1 State S2 S1 -[#DD00AA]-> S2 S1 -left[#yellow]-> S3 S1 -up[#red,dashed]-> S4 S1 -right[dotted,#blue]-> S5 X1 -[dashed]-> X2 Z1 -[dotted]-> Z2 Y1 -[#blue,bold]-> Y2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Change head or tail of arrow line

@startuml state a a -> b : -> c x-> d : x-> e ->o f : <U+0020>->o g x->o h : x->o @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Note

@startuml [*] --> Active Active --> Inactive note left of Active : this is a short\nnote note right of Inactive A note can also be defined on several lines end note @enduml

@startuml state foo note "This is a floating note" as N1 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Note sur un lien

@startuml [*] -> State1 State1 --> State2 note on link this is a state-transition note end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Plus de notes

@startuml [*] --> NotShooting state "Not Shooting State" as NotShooting { state "Idle mode" as Idle state "Configuring mode" as Configuring [*] --> Idle Idle --> Configuring : EvConfig Configuring --> Idle : EvConfig } note right of NotShooting : This is a note on a composite state @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Changer les couleurs localement [Inline color]

@startuml state CurrentSite #pink { state HardwareSetup #lightblue { state Site #brown Site -[hidden]-> Controller Controller -[hidden]-> Devices } state PresentationSetup{ Groups -[hidden]-> PlansAndGraphics } state Trends #FFFF77 state Schedule #magenta state AlarmSupression } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Skinparam

• Dans la définition du diagramme, comme pour les autres commandes,
• Dans un fichier inclus,
• Dans un fichier de configuration, renseigné dans la ligne de commande ou la tâche ANT.

@startuml skinparam backgroundColor LightYellow skinparam state { StartColor MediumBlue EndColor Red BackgroundColor Peru BackgroundColor<<Warning>> Olive BorderColor Gray FontName Impact } [*] --> NotShooting state "Not Shooting State" as NotShooting { state "Idle mode" as Idle <<Warning>> state "Configuring mode" as Configuring [*] --> Idle Idle --> Configuring : EvConfig Configuring --> Idle : EvConfig } NotShooting --> [*] @enduml

Test de tous les skinparam spécifiques aux diagrammes d'état:

@startuml skinparam State { AttributeFontColor blue AttributeFontName serif AttributeFontSize 9 AttributeFontStyle italic BackgroundColor palegreen BorderColor violet EndColor gold FontColor red FontName Sanserif FontSize 15 FontStyle bold StartColor silver } state A : a a a\na state B : b b b\nb [*] -> A : start A -> B : a2b B -> [*] : end @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Changement de style

@startuml <style> stateDiagram { BackgroundColor Peru 'LineColor Gray FontName Impact FontColor Red arrow { FontSize 13 LineColor Blue } } </style> [*] --> NotShooting state "Not Shooting State" as NotShooting { state "Idle mode" as Idle <<Warning>> state "Configuring mode" as Configuring [*] --> Idle Idle --> Configuring : EvConfig Configuring --> Idle : EvConfig } NotShooting --> [*] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Modifier la couleur et le style d'un état (style en ligne)

• #color ##[style]color

@startuml state FooGradient #red-green ##00FFFF state FooDashed #red|green ##[dashed]blue { } state FooDotted ##[dotted]blue { } state FooBold ##[bold] { } state Foo1 ##[dotted]green { state inner1 ##[dotted]yellow } state out ##[dotted]gold state Foo2 ##[bold]green { state inner2 ##[dotted]yellow } inner1 -> inner2 out -> inner2 @enduml

• #color;line:color;line.[bold|dashed|dotted];text:color

@startuml @startuml state FooGradient #red-green;line:00FFFF state FooDashed #red|green;line.dashed;line:blue { } state FooDotted #line.dotted;line:blue { } state FooBold #line.bold { } state Foo1 #line.dotted;line:green { state inner1 #line.dotted;line:yellow } state out #line.dotted;line:gold state Foo2 #line.bold;line:green { state inner2 #line.dotted;line:yellow } inner1 -> inner2 out -> inner2 @enduml @enduml

@startuml state s1 : s1 description state s2 #pink;line:red;line.bold;text:red : s2 description state s3 #palegreen;line:green;line.dashed;text:green : s3 description state s4 #aliceblue;line:blue;line.dotted;text:blue : s4 description @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Alias

@startuml state alias1 state "alias2" state "long name" as alias3 state alias4 as "long name" alias1 : ""state alias1"" alias2 : ""state "alias2""" alias3 : ""state "long name" as alias3"" alias4 : ""state alias4 as "long name""" alias1 -> alias2 alias2 -> alias3 alias3 -> alias4 @enduml

@startuml state alias1 : ""state alias1"" state "alias2" : ""state "alias2""" state "long name" as alias3 : ""state "long name" as alias3"" state alias4 as "long name" : ""state alias4 as "long name""" alias1 -> alias2 alias2 -> alias3 alias3 -> alias4 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Display JSON Data on State diagram

Simple example

@startuml state "A" as stateA state "C" as stateC { state B } json jsonJ { "fruit":"Apple", "size":"Large", "color": ["Red", "Green"] } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

State description

@startuml hide empty description state s0 state "This is the State 1" as s1 { s1: State description state s2 state s3: long descr. state s4 s4: long descr. } [*] -> s0 s0 --> s2 s2 -> s3 s3 -> s4 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Style for Nested State Body

@startuml <style> .foo { state,stateBody { BackGroundColor lightblue; } } </style> state MainState <<foo>> { state SubA } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Mainframe and frame

Mainframe

@startuml mainframe mainframe state a state b a --> b b--> [*] @enduml

Frame

@startuml frame frame { state a } state b a --> b b--> [*] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Specific SkinParameter

By default

@startuml [*] --> State1 State1 --> State2 : next step State2 --> State3 : next step State3 --> [*] @enduml

@startuml [*] --> Opened Opened --> Closed : close Opened <-- Closed : open Closed --> Locked : lock Closed <-- Locked : unlock @enduml

Edge Label Style

@startuml skinparam stateDiagramEdgeLabelStyle node skinparam ranksep 20 [*] --> State1 State1 --> State2 : next step State2 --> State3 : next step State3 --> [*] @enduml

@startuml skinparam stateDiagramEdgeLabelStyle node skinparam ranksep 20 [*] --> Opened Opened --> Closed : close Opened <-- Closed : open Closed --> Locked : lock Closed <-- Locked : unlock @enduml

Mix label defintion

@startuml skinparam ranksep 30 [*] --> State1 State1 --> State2 : next step State2 -[node]-> State3 : next step\n(on the middle of the arrow) State3 --> [*] @enduml