Display Model Element’s Description with Note

tomcat-thumbDetails of model elements can be documented in written form via the Description Pane or inside the Specification dialog. In order to avoid putting too much information on the diagram by default descriptions are not showing on the diagram. Instead of unfolding the description manually on diagram by writing textual annotation, you can make use of the Note element to display the description its connecting model element.


To display the description of model element via note:

  1. Click on the Note tool in diagram toolbar.

    Select Note tool

    Select Note tool

  2. Click on the blank area of your diagram to create the note.

    Click on blank area of the diagram to create note

    Click on blank area of the diagram to create note

  3. Drag out the anchor icon from the note and drop it to the element which you would like to display its description.

    Attach note to target element with anchor

    Attach note to target element with anchor

  4. Double click on the note and enter ${modelDescription} as its content. Then click on the blank area of the diagram to confirm your editing.

    Enter ${modelDescription} as the content of the note

    Enter ${modelDescription} as the content of the note

After that the description of the connecting model element will be show on the note.

The note displaying the description of its connecting model element

The note displaying the description of its connecting model element

* When the note is connecting to multiple model elements, it will only show the description of its first connected element.

Related Know-how

Related Links

0 replies

Leave a Reply

Want to join the discussion?
Feel free to contribute!

Leave a Reply