Topic
Prev Next

Work With Diagram Filters

You can modify the display of objects on a diagram using Diagram Filters, which you create and use through the Diagram Filters window. This window is dockable, so you can move it around or 'fix' it next to the Diagram View while you activate, deactivate and edit the filters.

Access

Ribbon

Layout > Tools > Diagram Filters    or

Show > Window > Diagram Filters

Create a single filter to be applied to your diagrams

Step

Action

See also

1

Perform one of these actions:

  • On the Diagram Filter toolbar, click on the 'New Filter' icon - the first on the left
  • Right-click on the list panel and select the 'New Filter' option

The 'Create New Diagram Filter' dialog displays.

2

In the 'Enter Filter Name' field, type a name for the filter, then click on the OK button.

The 'Diagram Filter' dialog displays.

3

In the 'Active Filter Set' field, either:

  • Use the default value of 'Element' or
  • Click on the drop-down arrow and select 'Connector' or 'TagValue'

The body of the dialog displays a list of properties of elements, connectors or Tagged Values.

4

Scroll through the properties to filter on, and select the checkbox against each property you require.

5

For each property, click on the 'Condition' field and select, from the drop-down list, the comparison condition to be applied.

Consider how the combination of 'Condition - Equal To / Not Equal To' and 'Filter Effect' might affect the results on the diagram.

Diagram Filters

6

For each property, double-click on the 'Value' field and type or select any specific value to filter on.

7

Click on the OK button to save the filter and return to the Diagram Filters window.

Unless you have specifically created the filter in a Filter Group, the filter is listed underneath the default Model group at the top of the window.

Create a Filter Group

Step

Action

See also

1

In the Diagram Filters window toolbar, click on the drop-down arrow next to the Filter icon and select the 'New Filter Grouping' option.

The 'Create New Diagram Filter Grouping' dialog displays.

2

In the 'Enter Filter Name' field, type the name of the filter group, and click on the OK button.

The filter group is added to the end of the list in the Diagram Filters window, and the 'Create New Diagram Filter' dialog displays for you to add a new filter to the filter group.

3

Define the new filter in the group as described in the Create a single filter to be applied to your diagrams table. You can apply that procedure to define the other filters for the group, clicking on the group name and then on the 'New Filter' option to start.

Alternatively, you can copy or cut an existing filter from the Model list or from another filter group, and paste that filter into the new group. Right-click on the source filter and select the 'Cut' or 'Copy' option, then right-click on the target group and select the 'Paste' option.

Other Operations

Operation

Detail

See also

Edit a Filter

To edit an existing filter on the Diagram Filters window, either:

  • Double-click on the filter name
  • Click on the filter name and select the 'Properties' icon from the toolbar (the second icon from the left), or
  • Right-click on the name and select the 'Properties' option

The 'Diagram Filter' dialog displays; adjust the filtered fields as described in the Create a single filter to be applied to your diagrams table.

Change the name of the Filter or Filter Group

Right-click on the name and select the 'Change Name' option.

The appropriate 'Create New Diagram Filter ...' dialog displays.

Type over the existing name with the new name, and click on the OK button.

Define how filters in a group combine

When you define two or more filters in a filter group, they default to operating in combination, with an AND relationship. That is, an object must satisfy the criteria of all the selected filters in the group before being operated on.

You can change this to an OR relationship, where the object must satisfy the criteria of any of the filters before being operated on. To set the relationship of the group filters to OR (or change it back from OR to AND):

  1. Right-click on the filter group name and select the 'Properties' option. The 'Set logical operator for Filter Grouping' dialog displays.
  2. In the 'Operator' field, click on the drop-down arrow and select the required value - OR or AND.
  3. Click on the OK button.

Set Effect of Filters

The filter effect applies to all filters in the Diagram Filters window. To set how your filters identify selected items on your diagrams, click on the drop-down arrow of the toolbar 'Filter Effect' field, and select one of these options:

  • Fade - display all items that do not match the filter criteria in a pale version of the diagram background color
  • Gray Scale - display all items that do not match the filter criteria in pale gray
  • Hide - conceal all items that do not match the filter criteria
  • Select - select and highlight (with a hashed line) all those items that do match the filter criteria

If the filter is for elements in the Package Browser or Diagram List, note that the 'Select' filter effect cannot show up in this context.

Enable Filters

To enable a filter so that it takes immediate effect on your diagrams, select the check box against the filter name.

You can select more than one filter at a time, to combine their effects.

For a Filter Group, if you select the group checkbox all filters in the group are selected. You can then, if necessary, disable individual filters in the group.

Disable/Clear Filters

To disable a filter and clear the effect of the filter on the diagram so that it displays in full, clear the checkbox.

To disable all filters, either:

  • Click on the 'Reload Filters' icon in the toolbar (third option from the left), or
  • Right-click on the list panel and select the 'Reload Filters' option

Copy or Move a Filter between Filter Groups

To add an existing filter to another Filter Group, right-click on the filter and select the 'Copy' or 'Move' option as appropriate. Then right-click on the target Filter Group and select the 'Paste' option. If you are moving a filter, it is not removed from the source group until it has been pasted to the target group.

You cannot move a Filter Group or add one group to another.

Toggle between Diagram Filters and Context Filtering

To disable the filters you have defined and simply highlight a selected element and its immediate relatives, right-click on the Diagram Filters window background or the diagram background itself and select the 'Context Filtering' option.

To re-enable the Diagram Filter effects, display the Diagram Filters window or diagram context menus again and deselect the 'Context Filtering' option.

Context Filter a Diagram

Delete a Filter

To remove a filter or filter group from the Diagram Filters window, either:

  • Click on the filter name and click on the Delete icon in the toolbar, or
  • Right-click on the filter name and select the 'Delete Filter' option

A prompt displays to confirm the deletion.