Search In: Doc:Documentation: NEXUS Client
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 3.1
43.23.13.02.12.01.11.0
Close
Search Search on Documentation
Documentation Altium NEXUS Documentation ... PCB Query Functions Membership Checks

OnLayer

Created: October 31, 2018 | Updated: March 06, 2024 | Applies to versions: 1.0, 1.1, 2.0, 2.1, 3.0, 3.1 and 3.2
Now reading version 3.1. For the latest, read: OnLayer for version 4

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

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.