Altium Designer Documentation
...
((PCB Query Functions))_AD
PCB Query((Membership Checks))_AD
Query_Lang-PCBFunctions_MembershipChecks_OnGridOnGrid_AD
This document is no longer available beyond version 21. Information can now be found here: OnGrid for version 24
Parent page: PCB Query Functions - Membership Checks
Summary
Returns all objects whose X1 and Y1 properties comply with the Query.
Syntax
OnGrid(X1 : Number,Y1 : Number) : Boolean/Boolean_String
Each instance of Distance_String is a numerical string that specifies a distance in the PCB (Library) file. To be returned, an object's X1 property has to be an integral multiple of the first distance specified, and its Y1 property has to be an integral multiple of the second distance specified.
X1 and Y1 specify coordinates in the PCB (Library) file. To be returned, an object's X1 property has to be an integral multiple of the first value specified, and its Y1 property has to be an integral multiple of the second value specified.
Example Usage
OnGrid(25,25)
OnGrid(25,25) = True
OnGrid(25,25) = 'True'
Returns all objects whose X1 property is an integral multiple of 25mil and whose Y1 property is an integral multiple of 25mil.
OnGrid(5,100)
OnGrid(5,100) = True
OnGrid(5,100) = 'True'
Returns all objects whose X1 property is an integral multiple of 5mil and whose Y1 property is an integral multiple of 100mil.