Query_Lang-PCBFunctions_Fields_ColorColor_AD

Now reading version 1.0. For the latest, read: Query_Lang-PCBFunctions_Fields_Color((Color))_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 - Fields

Summary

Returns all Net objects whose Color property complies with the Query.

Syntax

Color : Numeric_String
Color : Number

The Color keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all non-Net objects (which do not have a Color property) have been totally excluded by one or more preceding entries within the Query expression. Either use entries in the expression such as Color <> '', or Color > ''. Alternatively, use entries specifically targeting net objects, such as ObjectKind = 'Net', or IsNet.

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the Color keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Color property's Blue, Green, and Red components, by using the following constructs:

  • Blue = Color Div 65536
  • Green = Color Div 256 Mod 256
  • Red = Color Mod 256

Example Usage

Color = '0'
Color <> '' && Color = 0

Returns all Net objects whose Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

Color = '16711680'
Color > '' && Color = 16711680

Returns all Net objects whose Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

Color <> '16777215'
Returns all objects except Net objects whose Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

ObjectKind = 'Net' && Color <> 16777215
Returns all Net objects whose Color property is not 16777215.

IsNet && Color Div 65536 >= 96 && Color Div 256 Mod 256 Between 64 And 192 && Color Mod 256 <= 128
Returns all Net objects whose Color property is such that the Blue component has a value which is greater than or equal to 96, the Green component has a value which is greater than or equal to 64 and less than or equal to 192, and the Red component has a value which is less than or equal to 128.

IsNet && Color Div 65536 <= 192
Returns all Net objects whose Color property's Blue component has a value which is less than or equal to 192.

IsNet && Color Mod 256 Between 64 And 192
Returns all Net objects whose Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

Tips

  1. The Color property is only defined for Net objects.
  2. The child objects of Net objects returned by the Query, are not returned.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.