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

ExistsOnLayer

Created: October 31, 2018 | Updated: October 31, 2018 | Applies to versions: 18.0, 18.1, 19.0, 19.1, 20.0, 20.1 and 20.2
Now reading version 20.1. For the latest, read: ExistsOnLayer for version 21

Parent page: PCB Query Functions - Membership Checks

Summary

Returns all objects that exist on the specified layer.

Syntax

ExistsOnLayer(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

ExistsOnLayer('Top Layer')
ExistsOnLayer('Top Layer') = True
ExistsOnLayer('Top Layer') = 'True'
Returns all objects that exist on the Top Layer.

Not ExistsOnLayer('Mechanical 3')
ExistsOnLayer('Mechanical 3') = False
ExistsOnLayer('Mechanical 3') = 'False'
Returns all objects except objects that exist on the 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.