Diagram Legends
The Diagram Legends pattern creates a package that contains a large number of pre-built and configured legends that can be added to any diagram to help viewers understand the diagram. The legends are configured to dynamically alter the appearance of elements and connectors in the diagram in accordance with the properties.

Figure 1. Shows a sample of legends from a  reference diagram that is included so the visual styles of the legends that are listed in the Project can be viewed as they would appear in a model diagram.

Figure 1. Shows a screen-shot of the Project Browser showing the available legends that can be dragged and dropped onto a diagram.
Discussion
The purpose of the pattern is to provide a library of pre-configured legends that can be used to embellish any diagram based on a wide-range of element and connector properties. The legends can be added to a reusable section of the Project Browser and then individual legends can be added to any diagram.

They are typically used in the situation where an audience may not be familiar with the element on the diagram (e.g. Legend - Type) or if a modelers want to draw the readers eye to elements that have a particular property values (e.g. Legend - Status).

The following is a list of some things you may want to do when working with this pattern.
·	Ensure the package is in a part of the repository where it can be used as a library of Legends for multiple diagrams and potentially projects.
Change the properties of the Legend element itself to alter the way the legend appears in diagrams.
Change the Fill or Line color that has been specified for each of the listed items.
Change the Line thickness that has been specified for each of the listed items.
Add additional items to the legend.

The following is a list of some of the next steps available when applying the pattern.
·	Create additional Legends that can be reused across projects, teams or diagrams.

Useful Workspace Layouts Core | Core Modeling, Wide View
Reference
The following help topics will assist you learn about how to work with this pattern.
Diagram Legends
Legend Properties
Create Legends

The following are some of the tools that will be helpful when working with this pattern.
Hand Drawn and Whiteboard Diagrams
The Hand Drawn and Whiteboard Mode are display options available for any diagram that changes a system-drawn diagram to appear as though it was drawn by hand and, optionally, hand drawn on a whiteboard. It is a powerful device to engage an audience by presenting the diagram in a rough and more immediate style giving the impression that it is just a sketch that can be changed. For more details see the Hand Drawn and Whiteboard Mode help topic.
Alternate Images for Diagram Elements
Most standard elements allow an alternate image to be defined for an element that will be used in place of the graphical notation for the element either on a selected diagram or as a default on all diagrams. For more details see the Using the Image Manager help topic.
Diagram Layout
The Diagram Layout tool allows you to layout an entire diagram, selected elements or sections of a diagram to make it more visually appealing or meaningful to a particular audience. There are a wide range of layout types to choose from and some types have filters that can be applied. For more details see the Diagram Layout help topic.
Pan and Zoom
The Pan and Zoom facility is one of the tools that can be used to navigate around a large diagram. Often the resolution of a diagram must be reduced to ensure it is wholly visible but by using the Pan and Zoom window you can leave the diagram at a readable resolution and pan around to areas of interest zooming in when necessary. For more details see the Pan and Zoom help topic.
Diagram Legends
The Diagram Legend facility is useful for manually or automatically changing the appearance of elements and connectors on a diagram. A legend can be added from the Common Toolbox and configured to codify the fill and line color and line thickness. This is a powerful way to add meaning and expression to a diagram and is particularly expressive when applied automatically based on element or connector properties. It can be used with a number of specialized diagrams such as roadmaps to create a powerful visualization.  For more details see the Diagram Legends help topic.

© 2000 - 2018  Sparx Systems Pty Ltd.  All rights Reserved.