hiMatchColor

hiMatchColor( 
l_RGBcolor 
) 
=> x_colormapIndex 

Description

Returns a layer color index corresponding to the specified RGB color. It creates a new color index if the color specified does not have any corresponding index.

Argument

l_RGBcolor

List of red, green, and blue integer coordinates in the range 0-1000 representing a color, such that it can be returned by the nameToColor function.

Value Returned

x_colormapIndex

A color index representing the layer color that matches the color specification. Returns the new color index, if the color specified does not have any corresponding index.

Examples

Returns a color index corresponding to a list of specified integer coordinates.

hiMatchColor('(1000 0 0))

=>6 20

Returns a color index corresponding to the color, red.

hiMatchColor(nameToColor("red"))

=>8 20

Returns a color index corresponding to the RGB string, #FF0000.

hiMatchColor(nameToColor("#FF0000))

=>10 20

Related Topics

Icon Functions

nameToColor

hiStringToIcon

Return to top