Query_Lang-PCBFunctions_MembershipChecks_InRegionRelativeInRegionRelative_AD

Created: September 19, 2015 | Updated: August 20, 2021 | Applies to versions: 1.0, 1.1, 2.0, 2.1, 3.0, 3.1 and 3.2

Now reading version 2.1. For the latest, read: Query_Lang-PCBFunctions_MembershipChecks_InRegionRelative((InRegionRelative))_AD for version 4

Nexus message

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 that reside within the area specified by the Query.

Syntax

InRegionRelative(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.

All coordinates are referenced to the user origin (PCB files) or component insertion point (PCB Library files), rather than to the absolute origin, and at present, all coordinates always use units of mils. (1 mil = 0.001 inch).

Example Usage

InRegionRelative(-700,-400,1300,1600) InRegionRelative(-700,-400,1300,1600) = True InRegionRelative(-700,-400,1300,1600) = 'True'
Returns objects residing within the rectangular region bounded by X1 = -700 and X2 = 1300, and by Y1 = -400 and Y2 = 1600; those coordinates are referenced to the user origin (or component insertion point).

Tips

Parent component, coordinate, dimension, and Net objects are not returned.

Druckversion

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.