Parent page: Sch Panels
The SCHLIB Filter panel allows you to construct filters through the creation of logical queries. A defined filter can then be applied to the active schematic library component or all components in the active schematic library, allowing you to select and edit multiple objects with greater accuracy and efficiency. The visual display of objects can be specified based on those that match the search criteria of the filter and those that do not.
When a Schematic Library is the active document, open the SCHLIB Filter panel by clicking SCH button at the bottom-right of Altium Designer then select SCHLIB Filter from the pop-up menu.
Panels can be configured to be floating in the editor space or docked to sides of the screen. If the SCHLIB Filter panel is currently in the group of docked Workspace panels on the left, use the SCHLIB Filter tab located at the bottom of the panels to bring it to the front.
The left-hand region of the SCHLIB Filter panel contains controls for defining (limiting) the scope of the filter.
The scope options are:
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 schematic library document (option enabled).
The central region of the SCHLIB 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.
Along with the prompt list, the panel also offers the Query Helper facility to provide aid in the creation of queries. This facility can be very useful if you are unsure of the syntax of a query or the possible keywords that you may want to use.
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 SCH Functions 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, click OK to load the query into the central region of the SCHLIB Filter panel. Apply the filter using the Apply button.
The above example finds digital power pins for the current component, or more usefully, for all the components in the active library when the panel's Whole Library option is enabled. Using the
And expression, it filters pins that are of the Power type (
PinElectrical = 'Power') and have a name prefix of 'D' (
Name Like 'D*').
When applied to the whole library, pins that satisfy the filter will be highlighted for all other components, such as that shown below:
For more information on applying filters, see the Applying and Clearing a Filter section below.
Additional buttons in the lower region of the SCHLIB 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 SCHLIB 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.
Any defined query may be added to a list of favorite queries in two ways:
Click the Favorites button in the SCHLIB 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 SCH 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:
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 SCHLIB Filter and SCH Filter panels.
Before application of the query in the SCHLIB Filter panel, it is best to define how you wish the result of the filtering to appear visually in the design editor 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.
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.
The visual effect of masking is set using the Mask Level slider control located on the bottom-right of Altium Designer.
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.
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 and leave the query expression loaded into the central region of the panel, use the Clear button at the bottom-right of Altium Designer or Clear Current Filter button ( ) in the main toolbar.
Right-clicking within the SCHLIB Filter panel provides access to additional options and commands via a pop-up menu.
The menu provides the following commands:
The top entries in the menu offer a selection of the current Favorites - click on an entry to load it into the panel.
^, *, /, Div, Mod, And
+, -, Or, Xor
=, <>, <, >, <=, >=