OnLayer

Created: September 13, 2015 | Updated: August 20, 2021 | Applies to versions: 15.1, 16.0, 16.1, 17.0 and 17.1

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

Layer is the name of the layer, as it appears on the Board Layers And Colors tab of the View Configurations dialog.

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 Layer are mandatory.