Altium Designer Documentation
...
PCB Query Functions
Membership Checks
OnLayer
Created: August 02, 2022 | Updated: August 02, 2022
| Applies to version: 21
This document is no longer available beyond version 21. Information can now be found here: OnLayer for version 25
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.