OnLayer

Now reading version 19.0. For the latest, read: OnLayer for version 21
Applies to Altium Designer versions: 18.0, 18.1, 19.0, 19.1, 20.0, 20.1 and 20.2

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 Layers & Colors tab of the View Configuration panel.

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

  1. The single quote characters (') at the start and end of Layer are mandatory.
Note

The features available depend on your level of Altium Designer Software Subscription.