PCBLIB Filter

Parent page: Panels

Quickly locate and highlight PCB Library objects using logical queries in the PCBLIB Filter Panel.

Summary

The PCBLIB Filter panel allows you to construct filters through the creation of logical queries. A defined filter can then be applied to the active PCB component footprint, or all component footprints in the active PCB library, allowing you to select and edit multiple objects with great accuracy and efficiency.

Panel Access

To open the PCBLIB Filter panel, ensure that a PCB Library is the active document in the editor and click the PCB button  at the bottom-right of Altium Designer, and select the PCBLIB Filter entry from the pop-up menu:

or you can directly press shortcut key F12 to launch the Panel.

Panels can be configured to be floating in the editor space or docked to sides of the screen. If the PCBLIB Filter panel is currently in the group of docked Workspace panels on the left, use the PCBLIB Filter tab located at the bottom of the panels to bring it to the front.

Defining Filter Scope

The left-hand region of the PCBLIB Filter panel contains controls for defining (limiting) the scope of the filter.

The scope options are:

• All objects - apply the filter to all design objects.
• Selected objects - apply the filter only to those design objects that are currently selected.
• Non selected objects - apply the filter only to those design objects that are not currently selected.

Use the Whole Library option to control whether filtering is applied to just the active component (option disabled) or to all components in the active PCB library document (option enabled).

Defining Filter Queries

The central region of the PCBLIB Filter panel allows you to construct filters through the entry of logical queries.

You can type a query directly into the field, and as you type, a prompt list of possible keywords will appear as an aid.

Two facilities are available to provide aid in the creation of queries - the Query Helper and the Query Builder. These facilities can be very useful if you are unsure of the syntax of a query or the possible keywords that you may want to use.

Query Helper

To use the Query Helper, click the Helper button to open the Query Helper dialog. The underlying Query Engine analyzes the document and lists all available objects, along with generic keywords for use in queries.

Use the top section of the dialog to compose a query expression, using the available PCB Functions, PCB Object Lists and System Functions. The mid-section of the dialog provides a range of operators for use when constructing an expression. Use the Check Syntax button to verify that an expression is syntactically correct.

When the expression for the query has been defined as required, clicking OK will load the central region of the PCBLIB Filter panel with the query, ready to apply the filter.

Query Builder

To use the Query Builder, click the PCBLIB Filter panel's Builder button to open the Building Query from Board dialog.

This dialog enables you to create a query for targeting specific objects in the design document, by simple construction of a string of ANDed and/or ORed conditions.

The left-hand section of the dialog is where you specify the condition(s) that you require to target the set of objects needed. Initially the entry in the Condition Type/Operator column will be Add first condition. Clicking once on this entry will reveal a drop-down list of condition types.

The condition types listed will only reflect those relevant to a library component in the PCB Library Editor.

Select the condition and click in the Condition Value column to access a drop-down list of possible values for that condition type. As you define a condition in the left-hand section of the dialog, a preview of the currently built query is shown in the right-hand section.

Continue to add further conditions to narrow down your target set of design objects as required. Conditions can be ANDed or ORed together. The default logical operator is AND, which is automatically inserted when you add another condition.

To change the logical operator between conditions, click on the AND or OR entry in the Condition Type/Operator column and select the required operator. The preview of the query will update accordingly.

Specifying Precedence

The  and  buttons at the top of the PCBLIB Filter dialog allow you to essentially add and remove brackets around the presently selected condition (increasing and decreasing indent). This allows you to create precedence for certain logically ANDed or logically ORed conditions.

For example, consider the following built query:
(OnLayer('Mechanical 13') AND (IsArc OR IsTrack))

As in the example above, the first condition has been set to the type Exists on Layer, with value of Mechanical 13. Another condition was then been added, using the condition type Object Kind, with the value IsArc.

With the second condition selected in the dialog, clicking the right arrow button () causes brackets to be automatically added around the second condition. It is now possible to add another condition within the pair of brackets.

The third condition with condition type Object Kind is and value Track is then added within the brackets.

Finally, to change the logical operator from an AND to OR entry, as required by the desired search string, the OR operator is selected in the Condition Type/Operator column.

Use the Show Level drop-down at the top-left of the dialog to control the visual display of levels in your structured string of conditions. This essentially expands/collapses the display of brackets. Adding brackets effectively creates a new level. You can display levels 1-5, but for any further levels added use the Show All Levels option. Alternatively, use the and  buttons at the top of the dialog to expand or collapse the currently selected condition.

To move a selected condition in the query string being built, use the  and  buttons at the top of the dialog. For a condition that has sub-levels (i.e. a bracketed condition), any condition in the level structure can be moved. When levels are expanded, a condition can be moved down or up through the levels. When levels are collapsed, a condition will be moved over the level structure.

To delete a condition, select it and either click the  button at the top of the dialog, or use the DELETE key.

When the expression for the query has been defined as required, clicking OK will load the central region of the PCBLIB Filter panel with the query, ready to apply the filter.

Historical Queries

Additional buttons in the lower region of the PCBLIB Filter panel provide access to previously used and favorite (stored) queries.

As you enter and apply a new query, it will be added to a query history list. Click the History button to access this list - the Expression Manager dialog will open, with the History tab active.

To use an historical query from the list, either select its entry and click on the Apply Expression button, or double-click on the entry directly. The dialog will close and the expression for the query will be loaded into the central region of the PCBLIB Filter panel.

An historical query can be added to the list of favorite queries, by selecting its entry and clicking the Add To Favorites button. Use the Clear History button if you wish to 'flush' the history list. Up to nine most recently used query expressions from the list will be available for use from the panel's right-click menu.

Favorite Queries

Any defined query may be added to a list of favorite queries in two ways:

• By using the Add to Favorites command from the panel's right-click menu - to add the query expression currently defined in the central region of the panel.
• By selecting an historical query entry in the History tab of the Expression Manager dialog and clicking the Add To Favorites button.

Click the Favorites button in the PCBLIB Filter panel in order to access this list - the Expression Manager dialog will appear, with the Favorites tab active.

To use a favorite query from the list, either select its entry and click on the Apply Expression button, or double-click on the entry directly. The dialog will close and the expression for the query will be loaded into the central region of the PCB Filter panel.

When a query expression is added to the favorites list, it is assigned a unique name. By default, a generic name is assigned - Favorite_n - where n is the next available unused number. The name for an entry can be changed at any stage by using one of the following methods:

• Selecting the query entry and clicking the Rename button.
• Selecting the query entry and choosing the Change command from the available right-click menu.
• Selecting the query entry and then clicking again within the Name field.

In each case, type the new name as required and click outside the Name field to effect the change.

To remove a query from the favorites list, select its entry in the list and either click on the Remove button or choose the Remove command from the available right-click menu. A dialog will appear requesting confirmation of the removal. Up to ten most recently added query expressions to the list will be available for use from the top of the panel's right-click menu. Note that the content of the Favorites list is common to (and accessible from) both the PCBLIB Filter and PCB Filter panels.

Defining Filter Highlighting

Before application of the query in the PCBLIB Filter panel, it is best to define how you wish the result of the filtering to appear visually in the design workspace. The right-hand region of the panel provides various options which collectively form the highlight controls for permanent filtering.

The 'Objects passing the filter' options allow you to control how all objects that fall under the scope, and match the specific query expression of the filter, will be visually displayed in the workspace.

• Select - when enabled (default), the filtered objects will be selected in the workspace.
• Zoom - when enabled (default), the filtered objects will be zoomed and centered (where possible) in the library editor window.

Conversely, the 'Objects not passing the filter' options allow you to control how all objects that do not fall under the scope, and/or match the specific query expression of the filter, will be visually displayed in the workspace.

• Deselect - when enabled (default), all objects not falling under the scope of the filter will be deselected in the workspace.
• Mask / Dim / Normal - this dropdown list provides you with options for visibly contrasting filtered and unfiltered objects within the library editor window. The effectiveness of masking and dimming is determined by the Highlighting Options set in the PCB Editor - Display page of the Preferences dialog - File | Preferences.

Controls for adjusting masking and dimming are accessed by clicking the Mask Level button  at the bottom-right of Altium Designer.

• When Mask is selected in the PCB Filter panel options, filtered objects will appear visible in the design editor window, with all other objects being made monochrome. To set the contrast of the background (un-highlighted) objects, click the Mask Level button  at the bottom-right of Altium Designer when the PCB Editor is active:
  
  When this option is applied, unfiltered objects will be unavailable for selection or editing.
• When Dim is selected in the panel options, filtered objects will appear visible in the design editor window, with all other objects retaining their colors, but being shaded. Set the balance between filtered and unfiltered objects using the Masked Objects Factor and Highlight Objects Factor sliders after clicking Mask Level button :
  
• When Normal is selected, filtered objects are highlighted, however, the appearance of unfiltered objects remains unchanged.

Any combination of these options can be enabled. For example, you might want to have all filtered objects that fall under the scope of your query to be zoomed, centered and selected in the design editor window, whilst applying masking to take away the clutter of other design objects.

Applying and Clearing the Filter

Once you have defined a query and set up the options in the panel as required, the filter can be applied by clicking the panel's Apply button or pressing ENTER.

An applied example of a simple filter that finds any Arc with a width less than 0.2mm. The visual result is zoomed, masked and the objects are not selected.

To clear the currently-applied filter from within the panel, clear (select and delete) the query expression in the central region of the panel and either click the Apply button or press ENTER. All objects in the design workspace will be restored to full visibility and be available for selection/editing.

Alternatively, to clear filtering in the workspace, but leave the query expression loaded into the central region of the panel, use the Clear button at the bottom-right of Altium Designer.

Right-Click Menus

Right-clicking within the PCBLIB Filter panel provides access to additional options and commands via a pop-up menu.

The menu provides the following commands:

• Add to Favorites - use this command to add the query expression currently displayed in the central region of the panel to the list of favorite queries. The query will appear as a new entry on the Favorites tab of the Expression Manager dialog. As a query is added to the list of favorite queries, it will be displayed at the top of the right-click menu. 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.
• Organize Favorites - use this command to access the Favorites tab of the Expression Manager dialog, from where you can organize (rename, delete) entries in the list of favorite queries.
• Examples - click to access a sub-menu of predefined example filters. Choosing an example filter will load the associated, underlying query expression into the central region of the panel.
• History - click on this entry to access a sub-menu containing the nine most recently used query expressions, taken from the query history list for the panel.  Click on the More entry to access the History tab of the Expression Manager dialog, from where you can browse through and apply a query from the full list of historical queries and also clear the history list as required.
• Show Scope Options - use this command to toggle the display of the filter scope (left-hand) region of the panel.
• Show Masking Options - use this command to toggle the display of the filter highlighting (right-hand) region of the panel.

The top entries in the menu offer a selection of the current Favorites - click on an entry to load it into the panel.

Notes

General:

• Pressing the F12 key will toggle the visibility of the panel in the workspace.
• The Query Builder (Building Query from Board dialog) provides a simple method of constructing a query, using sensitive condition types and values that only allow you to build using relevant 'building blocks'. For advanced query construction, with full keyword specification and operator syntax, use the Query Helper dialog.
• When using the Query Helper dialog to construct a query, clicking inside a typed keyword or on a keyword in one of the available lists and pressing F1 will launch help for that particular keyword. Similar access to keyword-level help is available by clicking within a keyword in the central region of the PCBLIB Filter panel and pressing F1.
• As the display options for objects passing and not passing the applied filter are separated, you can effectively apply new filter queries to build upon the results of previous filtering.
• Filtering applied when using Queries from the PCBLIB Filter panel is permanent for the session. A permanent filter must be cleared by a corresponding Clear action (e.g. clicking on the  button or by applying an empty query from the PCBLIB Filter panel).
• Depending on the shape and size of the PCBLIB Filter panel itself, the content will be dynamically arranged horizontally or vertically.

When using the Query Builder:

• You can adjust any condition in your query string, at any time, by clicking on the entry for that condition in the Condition Type/Operator column and choosing the required new condition from the available entries in the drop-down list. Again, the preview of the query will update accordingly.
• The currently selected condition or logical operator in the left side of the dialog is visually confirmed in the preview section of the dialog by the entry appearing in red text.
• Use CTRL + Up Arrow and CTRL + Down Arrow keyboard shortcuts to move the selected condition entry up or down in the structure respectively.
• Use CTRL + Right Arrow and CTRL + Left Arrow keyboard shortcuts to increase or decrease indent at the selected position in the structure (add/remove brackets) respectively.

When building Query Expressions:

• It is highly advisable to use brackets whenever there is any possibility whatsoever that the query might not be correctly interpreted.
• Brackets have the highest precedence within an order of precedence that has been defined for the various operators provided and which determines how queries are interpreted by the software (whenever the user has not provided brackets). The sequence of this order is as follows:
    Brackets
  Not
  ^, *, /, Div, Mod, And
  +, -, Or, Xor
  =, <>, <, >, <=, >=
  &&, ||
  This order of precedence is similar to that used in Pascal type languages. However, generous usage of brackets removes doubt and makes the resulting queries easier to read by others.
• Ambiguities are resolved by working from left to right.
• Parentheses are evaluated from inside to outside and equal levels are done left to right.