Altium Designer Documentation
...
PCB Query Functions
Membership Checks
OnLayer
Created: October 31, 2018 | Updated: October 31, 2018
| Applies to versions: 18.0, 18.1, 19.0, 19.1, 20.0, 20.1 and 20.2
Now reading version 18.1. For the latest, read: OnLayer for version 21
Parent page: PCB Query Functions - Membership Checks
Summary
Returns all objects whose Layer property complies with the Query.
Syntax
OnLayer(Layer : String) : Boolean/Boolean_String
Example Usage
OnLayer('Top Layer')
OnLayer('Top Layer') = True
OnLayer('Top Layer') = 'True'
Returns all objects whose Layer property is Top Layer.
Not OnLayer('Mechanical 3')
OnLayer('Mechanical 3') = False
OnLayer('Mechanical 3') = 'False'
Returns all objects except objects whose Layer property is Mechanical 3 layer.
Tips
- The single quote characters (') at the start and end of
Layerare mandatory.