Description
Retrieves the colors used when defining the specified Color Palette.
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Method Signature
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
|
interpolate
|
|
Description:
|
Determines whether the retrieved colors will be interpolated from the palette definition or not.
|
Valid Values:
|
Value
|
Label
|
0
|
false
|
1
|
true
|
|
Return Value
The Array of colors.
Syntax
myArray1 = ColorTools.GetPaletteColors(myString1, myVariable1, myVariable2);
|
See also
ColorUtilities Object
ColorUtilities.GetPaletteColors
Color Reference
|