Search In: Doc:Documentation: NEXUS Client
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 4
43.23.13.02.12.01.11.0
Close
Search Search on Documentation
Documentation Altium NEXUS Documentation ... Schematic Query Functions Fields

PinName_CustomColor

Created: August 02, 2022 | Updated: August 02, 2022 | Applies to version: 4

This document is no longer available beyond version 4. Information can now be found here: PinName_CustomColor for version 5

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: Schematic Query Functions - Fields

Summary

Returns all pin objects whose Pin Name Color property complies with the Query.

Syntax

PinName_CustomColor : Numeric_String
PinName_CustomColor : Number

The PinName_CustomColor 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 objects (which do not have a Pin Name Color property) have been totally excluded by one or more preceding entries within the Query expression. Either use entries in the expression such as PinName_CustomColor <> '', PinName_CustomColor > '', or use entries specifically targeting pin objects, i.e. IsPin.

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 PinName_CustomColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Pin Name Color property's Blue, Green, and Red components, by using the following constructs:

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

Example Usage

PinName_CustomColor = '0'
PinName_CustomColor <> '' && PinName_CustomColor = 0
Returns all pin objects whose Pin Name Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

PinName_CustomColor = '16711680'
PinName_CustomColor > '' && PinName_CustomColor = 16711680
Returns all pin objects whose Pin Name Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

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

IsPin && PinName_CustomColor Div 65536 <= 192
Returns all pin objects whose Pin Name Color property's Blue component has a value which is less than or equal to 192.

IsPin && PinName_CustomColor Mod 256 Between 64 And 192
Returns all pin objects whose Pin Name 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 Pin Name Color property is only defined for pin objects.

 

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