Query_Lang-PCBFunctions_MembershipChecks_OnLayerOnLayer_AD

This document is no longer available beyond version 21. Information can now be found here: OnLayer for version 24

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.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Note

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.