The colortables class

Valid Parents: None

Valid Children: None

Description

Description An attribute object which is the parent of Gsharp color tables. The resources for this object are visible in the Color Editor dialog which is available in the Gsharp Professional Edition by selecting Edit->Colors. Each color table holds the definitions of each color found in the table. Colors are then reference via an index into the color table. Currently only the general color table, colortables.GeneralColorTable, is used.

New Resources

Colortables Resource Set

Antibackground (XuNantibackgroundColor)
The index of the color in the color table which serves as the background color. The background color is defined as black (0,0,0).

  • Type: float
  • Default: 1,­1:255
  • Range:

Background (XuNbackgroundColor)
The index of the color in the color table which serves as the background color. The background color is defined as white (100,100,100).

  • Type: float
  • Default: 0,­1:255
  • Range:

Hollow (XuNhollowColor)
The index of the color in the color table which serves as the hollow, or transparent, color.

  • Type: float
  • Default: ­1,­1:255
  • Range:

Number of Colors (XuNnumColors)
Set the number of colors to be displayed in the Color Editor. The resource does not change the actual size of the color table, which is 255, and has no affect in GSL scripts.

  • Type: float
  • Default: 88
  • Range: 2:255

Color Table (XuNrgbValues[index+1])
An array with 255 rows and 3 columns. Each row defines a color in the color table using the RGB color model. In GSL, color indexes begin with index 0. However, array elements are indexed beginning with 1. Therefore, colors are programmed as index+1, where index is a value used to set a color resource.

  • Type: float
  • Default: (,),
  • Range: 0:100

Inherited Resources

Controls Resource Set

Destroyable (XuNdestroyable)
This resource controls whether the object can be destroyed by a destroy or reset command. Values can be true (On) to set the object as destroyable, or false (Off) to set the object as permanent.

  • Type: float
  • Default: true
  • Range: false,true

Immutable (XuNimmutable)
This resource controls whether the object can be modified. Values are true (On) for non­modifiable, or false (Off) for modifiable. Setting this resource to true (On) locks the currents settings for the object and disables any further changes to the object, including resetting this resource.

  • Type: float
  • Default: false
  • Range: false,true

Object Name (XuNname)
The name of the object.

  • Type: string
  • Default:
  • Range: N/A

Object Enabled (XuNobjectEnabled)
This resource enables or disables the legend. This resource can be set to either true (On) to enable the object or false (Off) to disabled it.

  • Type: float
  • Default: true
  • Range: false,true

Include in Saved GSL (XuNsave)
This resource controls whether the object is included in saved GSL. Values are true (On) to include the object in saved GSL or false (Off) to omit the object.

  • Type: float
  • Default: true
  • Range: false,true

User Data (XuNuserData)
A dataset name or pointer which the user can associate with the object. The dataset is for user use and will not be used by Gsharp.

  • Type: string
  • Default: Unset
  • Range: N/A

Return to Gsharp Reference Manual