On this page

You can manage the Legends by choosing to either apply, unapply, suspend, or disable them in the diagrams and/or tables of your project. You can also adorn a Legend in a diagram or table without displaying the Legend itself, as shown below.

A Requirement Table displaying only Legend adornments

Applying a Legend in an open diagram or table

To apply a Legend in an open diagram or table

Do one of the following:

  • Create a Legend in a diagram or table.
  • Drag an existing Legend from the model browser to a diagram.
  • Display a Legend via the Legend  button:
    1. Click  in the diagram or table toolbar.
    2. In the drop-down menu, select Apply Legends.
    3. Select the Legend(s) you want to display.
    4. Click the OK button.

Completing one of the actions described above displays the Legend in an open diagram or table, and applies its Legend Item adornments to the relevant diagram shapes or table rows.

Manipulate Legends without Diagram Lock

You can also temporarily suspend or activate a Legend via the Suspended/Active toggle button available next to the Legend name in the Apply Legends option. This functionality can be useful for demonstration purposes, working with read-only diagrams/tables, or if you want to preview a diagram/table with or without adornments of a Legend without making permanent changes. The changes made via the Suspended/Active toggle button are only temporary, i.e., they are not saved upon the saving of a project.

Unapplying a Legend from an open diagram or table

To unapply a Legend from an open diagram or table

Do one of the following:

  • Delete the Legend shape from a diagram.
  • Hover the mouse pointer over a legend in a table, click  and select Hide.
  • Remove a Legend via the Legend  button:
    1. Click  in the diagram or table toolbar.
    2. In the drop-down menu, select Apply Legends.
    3. Clear the check mark of the Legend(s) you want to remove.
    4. Click the OK button.

The actions described above remove a Legend from an open diagram or table, and Legend Item adornments are no longer applied to the relevant diagram shapes or table rows.

Keeping Legend adornments

When you delete a Legend shape in a diagram or select the Hide command for a Legend in a table, the question message appears, allowing you to keep Legend Item adornments after the Legend is removed.

Displaying an applied Legend in an open diagram or table

You can display an applied Legend that was previously removed from a diagram or table.

To display an applied Legend in an open diagram or table

  1. In a table or diagram toolbar, click the Legend  button.
  2. In the drop-down menu, select Display Applied Legends.
  3. Select the Legend(s) you want to display.
  4. Click the Display button.

Disabling/enabling Legends

To disable/enable Legends

  1. In the main toolbar, click Options > Project. The Project Options dialog opens.
  2. In the General options group, select Legends.
  3. To disable/enable selected Legends:

    1. For the Ignored Legends option, click the three dots edit.png button. The Select Legend dialog opens.

    2. Click the Multiple Selection button and do one of the following:

      1. To disable Legends: on the left side of the dialog, select the Legend you want to disable, click the  button and click OK.

      2. To enable Legends: on the right side of the dialog, select the Legend you want to enable, click the  button and click OK.
  4. To disable/enable all Legends:
    1. Set the Use Legends option to true to enable or false to disable the Legends of the project. Click OK.
  5. Click OK.

Once the Legend is disabled, even if it is displayed on the diagram, the Legend cannot be used to filter the diagram, and the diagram symbols are not colored by Legend adornments. Once all the Legends are disabled, even if they are displayed on the diagram, the Legends cannot be used to filter the diagram, and the diagram symbols are not colored by Legend adornments.

Applying Legends by Condition

You can apply Legend adornments in a diagram or table without displaying the Legend. To achieve this, define the condition that diagrams should meet for the Legend to be applied (the Diagrams by Condition property). Legends with the specified Diagrams by Condition property are considered Global Legends, as the Legends' adornments are automatically applied to existing and newly created diagrams that meet the defined condition. Such Legends are marked in the Apply Legends and Display Legends menus with the (global) indication:


Example

Let's say that you want to apply the adornments of a Legend to all Requirement Diagrams and one specific Requirement Table of your model. To do this, follow these steps:

  1. Open the Specification window of a Legend.
  2. Select the Diagrams by Condition property specification cell and click .
  3. In the Diagrams by Condition dialog, select the Condition radio button.
  4. In the Property Test operation specification area, select the Type property and enter the Requirement Diagram as its value.



  5. Click OK.
  6. Select the Specific Diagrams property specification cell and click .
  7. In the Select Diagram dialog, select the desired Requirement Table.
  8. Click OK.


After completing the above steps, the Legend adornments are applied to all Requirement Diagrams and the selected Requirement Table. By specifying the Diagrams by Condition property, you also ensure that the Legend adornments will be automatically applied to newly created Requirement Diagrams as well because they meet the defined condition. 

Related pages