Description
Retrieves the colors used when defining the specified Color Palette.
Timing Precision Mode
This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.
Click here to see the documentation for this object in nanosecond timing precision mode.
Method Signature
ColorUtilities.GetPaletteColors(
|
String colorPalette,
|
|
Variable numberOfColors)
|
Arguments
colorPalette
|
|
Description:
|
The palette whose colors are to be retrieved.
|
Valid Values:
|
Value
|
Label
|
"Accessible"
|
Qualitative: Accessible
|
"Bright"
|
Qualitative: Bright
|
"Classic"
|
Qualitative: Classic
|
"Dark"
|
Qualitative: Dark
|
"Light"
|
Qualitative: Light
|
"Paired"
|
Qualitative: Paired
|
"Pastel"
|
Qualitative: Pastel
|
"Blues"
|
Sequential: Blues
|
"CubeHelix"
|
Sequential: CubeHelix
|
"Grays"
|
Sequential: Grays
|
"Greens"
|
Sequential: Greens
|
"Purples"
|
Sequential: Purples
|
"Reds"
|
Sequential: Reds
|
"Spectral"
|
Sequential: Spectral
|
"BluePurpleYellow"
|
Diverging: BluePurpleYellow
|
"GreenCyanBlue"
|
Diverging: GreenCyanBlue
|
"GreenYellowRed"
|
Diverging: GreenYellowRed
|
"PurpleBlueGreen"
|
Diverging: PurpleBlueGreen
|
"YellowRedPurple"
|
Diverging: YellowRedPurple
|
"BlueCyanGreen"
|
Terrain: BlueCyanGreen
|
"BlueYellowGreen"
|
Terrain: BlueYellowGreen
|
"BrownWhiteOrange"
|
Terrain: BrownWhiteOrange
|
"GreenBrownWhite"
|
Terrain: GreenBrownWhite
|
"YellowTanBeige"
|
Terrain: YellowTanBeige
|
|
numberOfColors
|
|
Description:
|
The number of colors to retrieve.
|
Valid Range:
|
numberOfColors > 0
|
Return Value
The Array of colors.
Syntax
myArray1 = ColorTools.GetPaletteColors(myString1, myVariable1);
|
See also
ColorUtilities Object
ColorUtilities.GetPaletteColors
Color Reference
|