IDLgrPalette Properties

IDLgrPalette objects have the following properties in addition to properties inherited from any superclasses. Properties with the word “Yes” in the “Get” column of the property table can be retrieved via IDLgrPalette::GetProperty. Properties with the word “Yes” in the “Init” column of the property table can be set via IDLgrPalette::Init. Properties with the word “Yes” in the “Set” column in the property table can be set via IDLgrPalette::SetProperty.

Note: For a discussion of the property description tables shown below, see Modifying Object Property Descriptions.

Objects of this class have the following properties.

• ALL
• BLUE_VALUES
• BOTTOM_STRETCH
• GAMMA
• GREEN_VALUES
• NAME
• N_COLORS
• RED_VALUES
• TOP_STRETCH
• UVALUE

ALL

An anonymous structure that contains the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.

Note: The fields of this structure may change in subsequent releases of IDL.

Property Type	Structure
Name String	not displayed
Get: Yes	Set: No	Init: No	Registered: No

BLUE_VALUES

A byte vector containing the blue values for the color palette. Setting this value is the same as specifying the aBlue argument to the IDLgrPalette::Init method.

Property Type	Byte vector
Name String	not displayed
Get: Yes	Set: Yes	Init: Yes	Registered: No

BOTTOM_STRETCH

An integer value in the range of 0 ≤ Value ≤ 100 to indicate what percentage of the palette entries at the bottom of the palette should be filled with the value of the first palette entry. The entire range of red, green, and blue values will be compressed to fit within the range of palette entries beginning at this entry and ending at the entry specified by the value of the TOP_STRETCH property. The default is 0 (zero).

Property Type	Integer
Name String	not displayed
Get: Yes	Set: Yes	Init: Yes	Registered: No

GAMMA

A floating-point value that indicates the gamma value to be applied to the color palette. This value should be in the range of 0.1 ≤ Gamma ≤ 10.0. The default is 1.0.

Property Type	Floating-point
Name String	not displayed
Get: Yes	Set: Yes	Init: Yes	Registered: No

GREEN_VALUES

A byte vector containing the green values for the color palette. Setting this value is the same as specifying the aGreen argument to the IDLgrPalette::Init method.

Property Type	Byte-vector
Name String	not displayed
Get: Yes	Set: Yes	Init: Yes	Registered: No

NAME

A string giving the human-readable name of this object.

Property Type	STRING
Name String	Name
Get: Yes	Set: Yes	Init:Yes	Registered: No

N_COLORS

An integer value that determines the number of elements in the color palette.

Property Type	Integer
Name String	not displayed
Get: Yes	Set: No	Init: No	Registered: No

RED_VALUES

A byte vector containing the red values for the color palette. Setting this value is the same as specifying the aRed argument to the IDLgrPalette::Init method.

Property Type	Byte vector
Name String	not displayed
Get: Yes	Set: Yes	Init: Yes	Registered: No

TOP_STRETCH

A floating-point value in the range of 0 ≤ Value ≤ 100 to indicate what percentage of the palette entries at the top of the palette should be filled with the value of the last palette entry. The entire range of red, green, and blue values will be compressed to fit within the range of palette entries beginning at the entry specified by the value of the BOTTOM_STRETCH property and ending at this entry. The default is 0 (zero).

Property Type	Floating-point
Name String	not displayed
Get: Yes	Set: Yes	Init: Yes	Registered: No

UVALUE

A value of any type containing any information you wish.

Note: Object references or pointers contained in the UVALUE property are not automatically cleaned up when the IDLgrPalette object is destroyed.

Property Type	User Defined
Name String	not displayed
Get: Yes	Set: Yes	Init:Yes	Registered: No