Layer Checks
At a Glance
- Learn what each Layer Checks query keyword returns for different PCB layer types.
- See the syntax and example usage for common include and exclude layer queries.
- Understand the differences between related keywords such as top, bottom, outside, signal, paste, and solder mask functions.
The Layer Checks PCB query functions shown in the Query Helper dialog
This reference page details the query language keywords from the Layer Checks category available in PCB and PCB library documents. For help on a specific query keyword, use the following collapsible sections or highlight (or click inside) any given keyword in the Query Helper or a Filter panel then press F1 to access its section right away.
OnBottom
Summary
Returns all objects on the layers: Bottom Layer, Bottom Overlay, Bottom Paste, and Bottom Solder.
Syntax
OnBottom : Boolean
Example Usage
OnBottom
OnBottom = True
Returns all objects on the layers: Bottom Layer, Bottom Overlay, Bottom Paste, and Bottom Solder.
Not OnBottom
OnBottom = False
Returns all objects except objects on the layers: Bottom Layer, Bottom Overlay, Bottom Paste, and Bottom Solder.
OnBottomLayer
Summary
Returns all objects on the Bottom Layer.
Syntax
OnBottomLayer : Boolean
Example Usage
OnBottomLayer
OnBottomLayer = True
Returns all objects on the Bottom Layer.
Not OnBottomLayer
OnBottomLayer = False
Returns all objects except objects on the Bottom Layer.
OnBottomPaste
Summary
Returns all objects on the Bottom Paste layer, and all pads on the Bottom Layer – the latter objects are returned because they also render to the Bottom Paste layer.
Syntax
OnBottomPaste : Boolean
Example Usage
OnBottomPaste
OnBottomPaste = True
Returns all objects on the Bottom Paste layer, and all pads on the Bottom Layer.
Not OnBottomPaste
OnBottomPaste = False
Returns all objects except objects on the Bottom Paste layer, and all pads on the Bottom Layer.
OnBottomSilkscreen
Summary
Returns all objects on the Bottom Overlay layer.
Syntax
OnBottomSilkscreen : Boolean
Example Usage
OnBottomSilkscreen
OnBottomSilkscreen = True
Returns all objects on the Bottom Overlay layer.
Not OnBottomSilkscreen
OnBottomSilkscreen = False
Returns all objects except objects on the Bottom Overlay layer.
OnBottomSolderMask
Summary
Returns all objects on the Bottom Solder layer, all pads on the Bottom Layer and Multi-Layer, and all vias ending on the Bottom Layer. The pad and via objects are returned because they also render to the Bottom Solder layer.
Syntax
OnBottomSolderMask : Boolean
Example Usage
OnBottomSolderMask
OnBottomSolderMask = True
Returns all objects on the Bottom Solder layer, all pads on the Bottom Layer and Multi-Layer, and all vias ending on the Bottom Layer.
Not OnBottomSolderMask
OnBottomSolderMask = False
Returns all objects except objects on the Bottom Solder layer, all pads on the Bottom Layer and Multi-Layer, and all vias ending on the Bottom Layer.
OnCopper
Summary
Returns all objects on signal layers, the Multi-Layer, and internal plane layers.
Syntax
OnCopper : Boolean
Example Usage
OnCopper
OnCopper
Returns all objects on signal layers, the Multi-Layer, and internal plane layers.
Not OnCopper
OnCopper = False
Returns all objects except objects on signal layers, the Multi-Layer, and internal plane layers.
OnInverted
Summary
Returns all objects on the following layers: Top Paste, Bottom Paste, Top Solder, Bottom Solder, and Internal Plane layers (Internal Plane 1-16). These layers are all of an "Inverted" or "Reverse" nature, because the presence of any object on these layers results in a corresponding opening in a solder paste stencil, or in the solder mask film, or a corresponding absence of copper (in the cases of Paste Mask, Solder Mask, and Internal Plane layers respectively).
Syntax
OnInverted : Boolean
Example Usage
OnInverted
OnInverted
Returns all objects on the following layers: Top Paste, Bottom Paste, Top Solder, Bottom Solder, and Internal Plane layers (Internal Plane 1-16).
Not OnInverted
OnInverted = False
Returns all objects except objects on the following layers: Top Paste, Bottom Paste, Top Solder, Bottom Solder, and Internal Plane layers (Internal Plane 1-16).
OnMechanical
Summary
Returns all objects on any enabled Mechanical layers.
Syntax
OnMechanical : Boolean
Example Usage
OnMechanical
OnMechanical
Returns all objects on any enabled Mechanical layers.
Not OnMechanical
OnMechanical
Returns all objects except objects on any enabled Mechanical layers.
OnMid
Summary
Returns all objects on any internal signal layers.
Syntax
OnMid : Boolean
Example Usage
OnMid
OnMid = True
Returns all objects on any internal signal layers.
Not OnMid
OnMid = False
Returns all objects except objects on any internal signal layers.
OnMultiLayer
Summary
Returns all objects on the Multi-Layer layer.
Syntax
OnMultiLayer : Boolean
Example Usage
OnMultiLayer
OnMultiLayer
Returns all objects on the Multi-Layer layer.
Not OnMultiLayer
OnMultiLayer = False
Returns all objects except objects on the Multi-Layer layer.
OnOutside
Summary
Returns all objects on the 'outside' signal layers – Top Layer and Bottom Layer.
Syntax
OnOutside : Boolean
Example Usage
OnOutside
OnOutside = True
Returns all objects on the 'outside' signal layers – Top Layer and Bottom Layer.
Not OnOutside
OnOutside = False
Returns all objects except objects on the 'outside' signal layers – Top Layer and Bottom Layer.
Note
Note that objects placed on the Multi-Layer layer will not be returned by the OnOutside query keyword. Use the OnMultiLayer query keyword to target objects on the Multi-Layer layer or the ExistsOnLayer('Top Layer') Or ExistsOnLayer('Bottom Layer') query to target objects (including objects on the Multi-Layer layer) that have shapes on the Top Layer or Bottom Layer.
OnPaste
Summary
Returns all objects on the Top Paste and Bottom Paste layers, and all pads on the Top Layer and Bottom Layer – the pad objects on these layers are returned because they also render to the Top Paste and Bottom Paste layers respectively.
Syntax
OnPaste : Boolean
Example Usage
OnPaste
OnPaste = True
Returns all objects on the Top Paste and Bottom Paste layers, and all pads on the Top Layer and Bottom Layer.
Not OnPaste
OnPaste = False
Returns all objects except objects on the Top Paste and Bottom Paste layers, and all pads on the Top Layer and Bottom Layer.
OnPlane
Summary
Returns all objects on internal plane layers (Internal Plane 1-16).
Syntax
OnPlane : Boolean
Example Usage
OnPlane
OnPlane = True
Returns all objects on internal plane layers (Internal Plane 1-16).
Not OnPlane
OnPlane = False
Returns all objects except objects on internal plane layers (Internal Plane 1-16).
OnSignal
Summary
Returns all objects on signal layers and the Multi-Layer.
Syntax
OnSignal : Boolean
Example Usage
OnSignal
OnSignal = True
Returns all objects on signal layers and the Multi-Layer.
Not OnSignal
OnSignal = False
Returns all objects except objects on signal layers and the Multi-Layer.
OnSilkscreen
Summary
Returns all objects on the Top Overlay and Bottom Overlay layers.
Syntax
OnSilkscreen : Boolean
Example Usage
OnSilkscreen
OnSilkscreen = True
Returns all objects on the Top Overlay and Bottom Overlay layers.
Not OnSilkscreen
OnSilkscreen = False
Returns all objects except objects on the Top Overlay and Bottom Overlay layers.
OnSolderMask
Summary
Returns all objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer. The pad and via objects are returned because they also render to the Top Solder or Bottom Solder layer respectively.
Syntax
OnSolderMask : Boolean
Example Usage
OnSolderMask
OnSolderMask = True
Returns all objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer.
Not OnSolderMask
OnSolderMask = False
Returns all objects except objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer.
OnTop
Summary
Returns all objects on the layers: Top Layer, Top Overlay, Top Paste, and Top Solder.
Syntax
OnTop : Boolean
Example Usage
OnTop
OnTop = True
Returns all objects on the layers: Top Layer, Top Overlay, Top Paste, and Top Solder.
Not OnTop
OnTop = False
Returns all objects except objects on the layers: Top Layer, Top Overlay, Top Paste, and Top Solder.
OnTopLayer
Summary
Returns all objects on the Top Layer.
Syntax
OnTopLayer : Boolean
Example Usage
OnTopLayer
OnTopLayer = True
Returns all objects on the Top Layer.
Not OnTopLayer
OnTopLayer = False
Returns all objects except objects on the Top Layer.
OnTopPaste
Summary
Returns all objects on the Top Paste layer, and all pads on the Top Layer – the latter objects are returned because they also render to the Top Paste layer.
Syntax
OnTopPaste : Boolean
Example Usage
OnTopPaste
OnTopPaste
Returns all objects on the Top Paste layer, and all pads on the Top Layer.
Not OnTopPaste
OnTopPaste
Returns all objects except objects on the Top Paste layer, and all pads on the Top Layer.
OnTopSilkscreen
Summary
Returns all objects on the Top Overlay layer.
Syntax
OnTopSilkscreen : Boolean
Example Usage
OnTopSilkscreen
OnTopSilkscreen = True
Returns all objects on the Top Overlay layer.
Not OnTopSilkscreen
OnTopSilkscreen = False
Returns all objects except objects on the Top Overlay layer.
OnTopSolderMask
Summary
Returns all objects on the Top Solder layer, all pads on the Top Layer and Multi-Layer, and all vias starting on the Top Layer. The pad and via objects are returned because they also render to the Top Solder layer.
Syntax
OnTopSolderMask : Boolean
Example Usage
OnTopSolderMask
OnTopSolderMask
Returns all objects on the Top Solder layer, all pads on the Top Layer and Multi-Layer, and all vias starting on the Top Layer.
Not OnTopSolderMask
OnTopSolderMask = False
Returns all objects except objects on the Top Solder layer, all pads on the Top Layer and Multi-Layer, and all vias starting on the Top Layer.