OBJGetColorGradientΒΆ

OBJGetColorGradient returns two RGB colors which define the color gradient.

rmRGB = OBJGetColorGradient(hobj)
rmARGB = OBJGetColorGradient(hobj, bTransparency)

Return Value

rmRGB is a matrix with 2 rows and 3 columns.

Value Meaning
rmRGB[1;1] (Bottom) Red (0 to 255)
rmRGB[1;2] (Bottom) Green (0 to 255)
rmRGB[1;3] (Bottom) Blue (0 to 255)
rmRGB[2;1] (Top) Red (0 to 255)
rmRGB[2;2] (Top) Green (0 to 255)
rmRGB[2;3] (Top) Blue (0 to 255)

If bTransparency is TRUE (1), rmARGB is a matrix with 4 columns:

Value Meaning
rmARGB[1;1] (Bottom) Transparency value (alpha) between 0 and 255. 0 is transparent and 255 is opaque.
rmARGB[1;2] (Bottom) Red (0 to 255)
rmARGB[1;3] (Bottom) Green (0 to 255)
rmARGB[1;4] (Bottom) Blue (0 to 255)
rvColorARGB[2;1]
(Top) Transparency value (alpha) between 0 and 255. 0 is transparent
and 255 is opaque.
rmARGB[2;2] (Top) Red (0 to 255)
rmARGB[2;3] (Top) Green (0 to 255)
rmARGB[2;4] (Top) Blue (0 to 255)

Parameters

hobj

hobj identifies a line, text, rectangle, ellipse or layer (diagram) object.

History

Version Description
R2018.3 Transparency.

id-825385