Is there a way to disaply summary table (right side) in Sequence diagram?

0 votes
asked Feb 2, 2015 in Wanted features by anonymous
HI

Is it possible to display brief summary  information in sequence diagram? I would like to display few bullet points right to sequence diagram.

Thanks

Naresh

1 Answer

0 votes
answered Feb 3, 2015 by plantuml (134,510 points)

Hello, you can use the legend keyword, but the legend is put on the bottom of the diagram (but you can have it right aligned)

@startuml
Alice -> Bob : Hello my dear friend
legend right
* this
* is a short
* legend
endlegend
@enduml


If this is not exactly what you expected, we should add more option to the legend position.

commented Feb 3, 2015 by anonymous
Thank you very much for the reply.
We are mainly interested to display it at top right rather than displaying it at bottom right. If image is too big (lets say 5 pages) it make sense to display summary at top right rather.
commented Feb 6, 2015 by plantuml (134,510 points)
In the following beta:
https://dl.dropboxusercontent.com/u/13064071/plantuml.jar

We have implemented this syntax:

@startuml
legend top left
  This is the legend
  on several lines
end legend

Alice -> BobWithALongName : hello
@enduml

Is it what you are expecting ?
commented Feb 6, 2015 by anonymous
Thank you very much for considering the request.

One more follow up on this, Is it possible to add a table in the legend ?
commented Feb 6, 2015 by plantuml (134,510 points)
Yes, you can use creole syntax:

http://plantuml.sourceforge.net/creole.html

@startuml
legend left
  This is the legend
  on several lines

  Example of simple table
  |= |= table |= header |
  | a | table | row |
  | b | table | row |

end legend

Alice -> BobWithALongName : hello
@enduml

http://www.plantuml.com/plantuml/png/POzB2iCm34JtFiLSe1Sej2I5xafNXQwLHeaDibrizxF8uIixsHKa6CqJ-dIvK2elBqPuvZ12U2e6k5cNeL4iOoLgne3CRqua41Su6_NEN_9FOSG9sJLLQ11MiXngjAeAopHomb89I7CZIF6pkSEVQzQJsdxJYtimTaUSud1tnVQN6EOhUSPUfuj4qscV_l83
commented Feb 12, 2015 by anonymous
Hi

legend top left/right having one problem.

If add a title, legend is coming on top of the title so title will not visible.

Example:

@startuml
title some big title
legend top left

  This is the legend
  on several lines
end legend

Alice -> BobWithALongName : hello
@enduml
commented Feb 12, 2015 by plantuml (134,510 points)
Ok, thanks for the report.

This should be fixed in the last beta:
https://dl.dropboxusercontent.com/u/13064071/plantuml.jar

Regards,
...