Altium Designer Documentation

FilterSelect

Created: November 14, 2016 | Updated: April 11, 2017
Now reading version 17.1. For the latest, read: FilterSelect for version 21
Applies to Altium Designer versions: 16.0, 16.1, 17.0 and 17.1

Parent page: Schematic Commands

The following pre-packaged resources, derived from this base command, are available:


Applied Parameters: None

Summary

This feature is used to apply a filter to the current document, using either a directly typed query expression, or one that exists in the query History list. A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

This feature can be accessed from the Schematic Editor, and Schematic Library Editor, in the following ways:

  • Right-clicking in the design workspace and using the Filter For field on the Filter sub-menu.
  • Using the Filter For field, available on the Filter pop-up menu - accessed by pressing Y in the design workspace.

Use

Simply enter the query expression for the filter you wish to apply and press Enter, or choose an historical filter query expression from the drop-down list. Filtering will be applied to the design and all design objects that fall under the scope of the filter will remain fully visible, with all other design objects becoming dimmed.

Tips

  1. The drop-down list contains all filter queries that currently exist in the query History list - on the History tab of the Expression Manager dialog.
  2. Adjust the level of masking applied to objects not falling under the scope of the active filter, by using the Filter slider bar - accessed from the Mask Level button (bottom right of main design window).


Applied Parameters: Source=Favorite|Index=n|Zoom=True|Select=True (where n is in the range 0 to 9)

Summary

This command is used to enter the indicated favorite filter logical query expression, into the main Query Expression region of the SCH Filter panel (if the active document is a schematic), or SCHLIB Filter panel (if the active document is a schematic library). A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

The related indexed commands are available from the Schematic Editor, and Schematic Library Editor - from the top of the right-click menu for the main Query Expression region, accessed from the SCH Filter panel, or SCHLIB Filter panel.

The ten most recently added queries to the favorites list will be displayed on the menu (most recent at the top), enabling you to quickly access and reuse your favorite query expressions.

Use

After launching the command, the indicated favorite query expression will be loaded into the filter panel's main Query Expression region, ready for application, or additional modification.

Tips

  1. The full list of favorite filter expressions can be found on the Favorites tab of the Expression Manager dialog.
  2. Bear in mind that the content of the Favorites list is common to (and can be populated from) both the Schematic Editor, and Schematic Library Editor. Some query expressions may not return results when used in the Schematic Editor, especially if they have been created to target objects that are available within the Schematic Library Editor only.


Applied Parameters: Apply=True|Source=Favorite|Index=n|Zoom=True|Select=True (where n is in the range 0 to 9)

Summary

This command is used to apply filtering to the current document, using the indicated favorite filter logical query expression. A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

The related indexed commands are available from the Schematic Editor, and Schematic Library Editor:

  • From the top of the design workspace's right-click Filter sub-menu.
  • From the top of the Filter pop-up menu - accessed by pressing Y in the design workspace.
The ten most recently added queries to the favorites list will be displayed on the menu (most recent at the top), enabling you to quickly access and reuse your favorite query expressions.

Use

After launching the command, filtering will be applied to the active document using the indicated favorite query expression. All design objects that fall under the scope of the filter will remain fully visible, with all other design objects becoming dimmed.

Tips

  1. The full list of favorite filter expressions can be found on the Favorites tab of the Expression Manager dialog.
  2. Bear in mind that the content of the Favorites list is common to (and can be populated from) both the Schematic Editor, and Schematic Library Editor. Some query expressions may not return results when used in the Schematic Editor, especially if they have been created to target objects that are available within the Schematic Library Editor only.
  3. Adjust the level of masking applied to objects not falling under the scope of the active filter, by using the Filter slider bar - accessed from the Mask Level button (bottom right of main design window).


Applied Parameters: Action=AddToFavorites

Summary

This command is used to add the currently defined logical query expression - in the main Query Expression region of the SCH Filter panel (if the active document is a schematic), or SCHLIB Filter panel (if the active document is a schematic library) - to the list of favorite filter expressions. A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

This command is accessed from the SCH Filter panel, or SCHLIB Filter panel, by right-clicking in the main Query Expression region and choosing the Add to Favorites command from the context menu.

Use

First, ensure that the currently defined query expression is as required (and syntactically correct!). After launching the command, the query expression will be added as a new entry to the list of favorite filter expressions.

Tips

  1. The full list of favorite filter expressions can be found on the Favorites tab of the Expression Manager dialog. The new addition will be added at the bottom of the list, but as it is the most recent addition, will be available at the top of the favorite filters lists, where available in the software (right-click menu in the Query Expression region of a filter panel, and the right-click Filter sub-menu for the workspace).


Applied Parameters: Action=ShowFavorites

Summary

This command is used to access the Favorites tab of the Expression Manager dialog, from where you can manage the list of favorite queries as required. A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

This command can be accessed from the Schematic Editor, and Schematic Library Editor, by:

  • Right-clicking in the design workspace and choosing the Filter » Organize Favorites command, from the context menu.
  • Choosing the Organize Favorites command from the Filter pop-up menu - accessed by pressing Y in the design workspace.
  • Right-clicking in the main Query Expression region of the SCH Filter panel (Schematic Editor), or SCHLIB Filter panel (Schematic Library Editor), and choosing the Organize Favorites command from the context menu.
In the filter panels, the Favorites tab of the Expression Manager dialog can also be quickly accessed by clicking the Favorites button, located below the main Query Expression region.

Use

After launching the command, the Expression Manager dialog will appear, with the Favorites tab presented as the active tab. From here you can:

  • Edit the name of a selected favorite query in the list. When a query expression is added to the favorites list, it is assigned a unique name in the default format Favorite_n, where n is the next available unused number. Change this to a more meaningful name – for example a name that conjures the intent of the expression.
  • Edit the logical query expression for a selected favorite query in the list - changing it as required to more accurately target the required set of objects (or a completely different set of objects). Highlighting options can also be modified (what to do with objects falling and not falling, under the scope of the filter).
  • Remove a selected favorite query from the list.
  • Apply a selected favorite query expression. Depending on from where the dialog was accessed, this will either load the expression into the filter panel, or apply filtering using the expression, in the workspace.

Tips

  1. The Expression manager dialog also offers a History tab. This provides a list of all previously used - historical - query expressions. A selected historical expression can be quickly added to the favorites list.


Applied Parameters: Source=History|Index=n|Zoom=True|Select=True (where n is in the range 1 to 9)

Summary

This command is used to enter the indicated historical filter logical query expression, into the main Query Expression region of the SCH Filter panel (if the active document is a schematic), or SCHLIB Filter panel (if the active document is a schematic library). A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

The related indexed commands are available from the top of the right-click History sub-menu for the main Query Expression region, accessed from the SCH Filter panel, or SCHLIB Filter panel.

The nine most recently used queries from the history list will be displayed on the menu (most recently used at the top), enabling you to quickly access and reuse your historical query expressions.

Use

After launching the command, the indicated historical query expression will be loaded into the filter panel's main Query Expression region, ready for application, or additional modification.

Tips

  1. The full list of historical filter expressions can be found on the History tab of the Expression Manager dialog.
  2. Bear in mind that the content of the History list is common to (and can be populated from) both the Schematic Editor, and Schematic Library Editor. Some query expressions may not return results when used in the Schematic Editor, especially if they have been created to target objects that are available within the Schematic Library Editor only.


Applied Parameters: Apply=True|Source=History|Index=n|Zoom=True|Select=True (where n is in the range 1 to 9)

Summary

This command is used to apply filtering to the current document, using the indicated historical filter logical query expression. A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

The related indexed commands are available:

  • From the top of the design workspace's right-click Filter » History sub-menu.
  • From the top of the Filter pop-up's History sub-menu - access the Filter pop-up by pressing Y in the design workspace.
The nine most recently used queries from the history list will be displayed on the menu (most recently used at the top), enabling you to quickly access and reuse your historical query expressions.

Use

After launching the command, filtering will be applied to the active document using the indicated historical query expression. All design objects that fall under the scope of the filter will remain fully visible, with all other design objects becoming dimmed.

Tips

  1. The full list of historical filter expressions can be found on the History tab of the Expression Manager dialog.
  2. Bear in mind that the content of the History list is common to (and can be populated from) both the Schematic Editor, and Schematic Library Editor. Some query expressions may not return results when used in the Schematic Editor, especially if they have been created to target objects that are available within the Schematic Library Editor only.
  3. Adjust the level of masking applied to objects not falling under the scope of the active filter, by using the Filter slider bar - accessed from the Mask Level button (bottom right of main design window).


Applied Parameters: Action=ShowHistory

Summary

This command is used to access the History tab of the Expression Manager dialog, from where you can manage the list of historical queries as required. A logical query expression is a string you enter using specific keywords and syntax - from an established Query Language - which will return the targeted objects, when the filter is applied.

Access

This command can be accessed from the Schematic Editor, and Schematic Library Editor, by:

  • Right-clicking in the design workspace and choosing the Filter » History » More command, from the context menu.
  • Choosing the History » More command from the Filter pop-up menu - accessed by pressing Y in the design workspace.
  • Right-clicking in the main Query Expression region of the SCH Filter panel (Schematic Editor), or SCHLIB Filter panel (Schematic Library Editor), and choosing the History » More command from the context menu.
In the filter panels, the History tab of the Expression Manager dialog can also be quickly accessed by clicking the History button, located below the main Query Expression region.

Use

After launching the command, the Expression Manager dialog will appear, with the History tab presented as the active tab. From here you can:

  • Add a selected historical query expression to the Favorites list.
  • Apply a selected historical query expression. Depending on from where the dialog was accessed, this will either load the expression into the filter panel, or apply filtering using the expression, in the workspace.
  • Clear the list - essentially purging all historical query expressions.

Tips

  1. The Expression manager dialog also offers a Favorites tab. This provides a list of all favorite query expressions. When added as a favorite, you have the ability to edit the logical query expression for a selected favorite query in the list - changing it as required to more accurately target the required set of objects (or a completely different set of objects). Highlighting options can also be modified (what to do with objects falling and not falling, under the scope of the filter).


Applied Parameters: Clear=True

Summary

This command is used to clear the filter that is currently being applied to the active document.

Access

This command can be accessed from the Schematic Editor, and Schematic Library Editor, by:

  • Right-clicking in the design workspace and choosing the Filter » Clear Filter command, from the context menu.
  • Choosing the Clear Filter command from the Filter pop-up menu - accessed by pressing Y in the design workspace.
  • Clicking the  button on the Schematic Standard toolbar (Schematic Editor), or Sch Lib Standard toolbar (Schematic Library Editor).
  • Using the Shift+C keyboard shortcut.
The current filter can also be cleared by clicking the Clear button, at the bottom-right of the design workspace.

Use

After launching the command, the current filter that is being applied to the document will be cleared and all design objects that were previously made unavailable by the application of the filter (i.e. were dimmed out) will be made available once again for normal editing.

Tips

  1. Current filtering can also be cleared by applying an empty query expression from the relevant filter panel for the active document.


Applied Parameters: Action=FindSimilar

Summary

This command is used to access the Find Similar Objects dialog, from which to set up search criteria for the Find Similar Objects (FSO) process. This process uses the attributes of a target object as a reference for finding several other objects with similar characteristics. This provides a fast, efficient method with which to select multiple similar objects for simultaneous editing.

Access

This command can be accessed from the Schematic Editor, and Schematic Library Editor, by:

  • Choosing the Edit » Find Similar Objects command, from the main menus.
  • Using the Shift+F keyboard shortcut.

Use

After launching the command, the cursor will change to a cross-hair and you will be prompted to choose a design object in the workspace. Simply position the cursor over the object required and click, or press Enter. The Find Similar Objects dialog will appear.

The dialog has three columns; the first (left) column lists the object's parameters, the second (middle) column lists the parameter's current value, and the third (right) column is used to specify how that parameter should be used to select additional objects. By default, the Object Kind parameter will be set to Same, with all other parameters set to Any. This basically means 'find all objects of the same kind, regardless of other parameteric values'. Make changes to narrow the search as required.

To search for objects with different values, enter the search pattern into the attribute value column directly; the '*' character can be used as a wildcard for finding any group of characters – i.e. C* will find C1, C2, C20, C397, Cap5, etc. Edits made to the attribute value in the dialog will not alter the attributes of the reference object.

Below the three columns are a number of options that can be set according to the desired operation once the find is executed. To select objects according to filter settings in the Find Similar Objects dialog, ensure the Select Matching option is enabled before clicking OK to execute the find. Also take note of the Clear Existing option, and ensure it is enabled, unless cumulative selection is required.

Having found the group of objects required, simultaneous property-editing of multiple objects can be performed using the relevant Inspector panel, or List panel. The Find Similar Objects dialog even has an option to have the Inspector panel launch after clicking OK.

Tips

  1. Use the Apply button to test and fine tune search criteria to yield the desired results, without closing the dialog.
  2. Adjust the level of masking applied to objects not falling under the scope of the active filter, by using the Filter slider bar - accessed from the Mask Level button (bottom right of main design window).
  3. The current filtering can be cleared by clicking the Clear button, at the bottom-right of the design workspace.


Applied Parameters: Action=FindSimilarUnderCursor

Summary

This command is used to access the Find Similar Objects dialog, from which to set up search criteria for the Find Similar Objects (FSO) process. This process uses the attributes of the object under the cursor as a reference for finding several other objects with similar characteristics. This provides a fast, efficient method with which to select multiple similar objects for simultaneous editing.

Access

This command is accessed from the Schematic Editor, and Schematic Library Editor, by right-clicking over a placed design object and choosing the Find Similar Objects command from the context menu.

Use

First, position the cursor over the required object in the main design workspace, similar objects to which, you wish to find.

After launching the command, the Find Similar Objects dialog will appear.

The dialog has three columns; the first (left) column lists the object's parameters, the second (middle) column lists the parameter's current value, and the third (right) column is used to specify how that parameter should be used to select additional objects. By default, the Object Kind parameter will be set to Same, with all other parameters set to Any. This basically means 'find all objects of the same kind, regardless of other parameteric values'. Make changes to narrow the search as required.

To search for objects with different values, enter the search pattern into the attribute value column directly; the '*' character can be used as a wildcard for finding any group of characters – i.e. C* will find C1, C2, C20, C397, Cap5, etc. Edits made to the attribute value in the dialog will not alter the attributes of the reference object.

Below the three columns are a number of options that can be set according to the desired operation once the find is executed. To select objects according to filter settings in the Find Similar Objects dialog, ensure the Select Matching option is enabled before clicking OK to execute the find. Also take note of the Clear Existing option, and ensure it is enabled, unless cumulative selection is required.

Having found the group of objects required, simultaneous property-editing of multiple objects can be performed using the relevant Inspector panel, or List panel. The Find Similar Objects dialog even has an option to have the Inspector panel launch after clicking OK.

Tips

  1. Use the Apply button to test and fine tune search criteria to yield the desired results, without closing the dialog.
  2. Adjust the level of masking applied to objects not falling under the scope of the active filter, by using the Filter slider bar - accessed from the Mask Level button (bottom right of main design window).
  3. The current filtering can be cleared by clicking the Clear button, at the bottom-right of the design workspace.


Applied Parameters: Action=ToggleScopeOptions

Summary

This command is used to toggle the display of the filter scope region of the SCH Filter panel (if the active document is a schematic), or SCHLIB Filter panel (if the active document is a schematic library).

Access

This command is accessed from the Schematic Editor, and Schematic Library Editor - from the SCH Filter panel, or SCHLIB Filter panel, respectively - by right-clicking in the main Query Expression region and choosing the Show Scope Options command from the context menu.

Use

After launching the command, the region of the active filter panel containing scoping options will either be hidden or displayed, depending on its previous state.


Applied Parameters: Action=ToggleMaskingOptions

Summary

This command is used to toggle the display of the filter highlighting region of the SCH Filter panel (if the active document is a schematic), or SCHLIB Filter panel (if the active document is a schematic library).

Access

This command is accessed from the Schematic Editor, and Schematic Library Editor - from the SCH Filter panel, or SCHLIB Filter panel, respectively - by right-clicking in the main Query Expression region and choosing the Show Masking Options command from the context menu.

Use

After launching the command, the region of the active filter panel containing highlighting/masking options will either be hidden or displayed, depending on its previous state.

 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: