Altium Designer Documentation
...
PCB Query Functions
Membership Checks
InRegion
Created: September 19, 2015 | Updated: August 20, 2021
| Applies to versions: 15.1, 16.0, 16.1, 17.0, 17.1, 18.0, 18.1, 19.0, 19.1, 20.0, 20.1 and 20.2
Now reading version 20.0. For the latest, read: InRegion for version 21
Parent page: PCB Query Functions - Membership Checks
Summary
Returns all objects that reside within the area specified by the Query.
Syntax
InRegion(X1 : Number ,Y1 : Number ,X2 : Number ,Y2 : Number) : Boolean/Boolean_String
X1,Y1 and X2,Y2 specify coordinates in the PCB (Library) file. The left and right boundaries of the region are specified by the X1 and X2 parameters, while the lower and upper boundaries of the region are specified by the Y1 and Y2 parameters.
Example Usage
InRegion(12700,4700,13300,5000)
InRegion(12700,4700,13300,5000) = True
InRegion(12700,4700,13300,5000) = 'True'
Returns objects residing within the rectangular region bounded by X1 = 12700 and X2 = 13300, and by Y1 = 4700 and Y2 = 5000; those coordinates are referenced to the absolute origin.
Tips
- Parent component, coordinate, dimension, and Net objects are not returned.
- This keyword is an alias for the InRegionAbsolute keyword.