Color

new Color(red, green, blue, alpha)

A color, specified using red, green, blue, and alpha values, which range from 0 (no intensity) to 1.0 (full intensity).
Name Type Default Description
red Number 1.0 optional The red component.
green Number 1.0 optional The green component.
blue Number 1.0 optional The blue component.
alpha Number 1.0 optional The alpha component.
See:
Source: Core/Color.js, line 50

Members

staticconstantColor.ALICEBLUE :Color

An immutable Color instance initialized to CSS color #F0F8FF
Source: Core/Color.js, line 721

staticconstantColor.ANTIQUEWHITE :Color

An immutable Color instance initialized to CSS color #FAEBD7
Source: Core/Color.js, line 730

staticconstantColor.AQUA :Color

An immutable Color instance initialized to CSS color #00FFFF
Source: Core/Color.js, line 739

staticconstantColor.AQUAMARINE :Color

An immutable Color instance initialized to CSS color #7FFFD4
Source: Core/Color.js, line 748

staticconstantColor.AZURE :Color

An immutable Color instance initialized to CSS color #F0FFFF
Source: Core/Color.js, line 757

staticconstantColor.BEIGE :Color

An immutable Color instance initialized to CSS color #F5F5DC
Source: Core/Color.js, line 766

staticconstantColor.BISQUE :Color

An immutable Color instance initialized to CSS color #FFE4C4
Source: Core/Color.js, line 775

staticconstantColor.BLACK :Color

An immutable Color instance initialized to CSS color #000000
Source: Core/Color.js, line 784

staticconstantColor.BLANCHEDALMOND :Color

An immutable Color instance initialized to CSS color #FFEBCD
Source: Core/Color.js, line 793

staticconstantColor.BLUE :Color

An immutable Color instance initialized to CSS color #0000FF
Source: Core/Color.js, line 802

staticconstantColor.BLUEVIOLET :Color

An immutable Color instance initialized to CSS color #8A2BE2
Source: Core/Color.js, line 811

staticconstantColor.BROWN :Color

An immutable Color instance initialized to CSS color #A52A2A
Source: Core/Color.js, line 820

staticconstantColor.BURLYWOOD :Color

An immutable Color instance initialized to CSS color #DEB887
Source: Core/Color.js, line 829

staticconstantColor.CADETBLUE :Color

An immutable Color instance initialized to CSS color #5F9EA0
Source: Core/Color.js, line 838

staticconstantColor.CHARTREUSE :Color

An immutable Color instance initialized to CSS color #7FFF00
Source: Core/Color.js, line 846

staticconstantColor.CHOCOLATE :Color

An immutable Color instance initialized to CSS color #D2691E
Source: Core/Color.js, line 855

staticconstantColor.CORAL :Color

An immutable Color instance initialized to CSS color #FF7F50
Source: Core/Color.js, line 864

staticconstantColor.CORNFLOWERBLUE :Color

An immutable Color instance initialized to CSS color #6495ED
Source: Core/Color.js, line 873

staticconstantColor.CORNSILK :Color

An immutable Color instance initialized to CSS color #FFF8DC
Source: Core/Color.js, line 882

staticconstantColor.CRIMSON :Color

An immutable Color instance initialized to CSS color #DC143C
Source: Core/Color.js, line 891

staticconstantColor.CYAN :Color

An immutable Color instance initialized to CSS color #00FFFF
Source: Core/Color.js, line 900

staticconstantColor.DARKBLUE :Color

An immutable Color instance initialized to CSS color #00008B
Source: Core/Color.js, line 909

staticconstantColor.DARKCYAN :Color

An immutable Color instance initialized to CSS color #008B8B
Source: Core/Color.js, line 918

staticconstantColor.DARKGOLDENROD :Color

An immutable Color instance initialized to CSS color #B8860B
Source: Core/Color.js, line 927

staticconstantColor.DARKGRAY :Color

An immutable Color instance initialized to CSS color #A9A9A9
Source: Core/Color.js, line 936

staticconstantColor.DARKGREEN :Color

An immutable Color instance initialized to CSS color #006400
Source: Core/Color.js, line 945

staticconstantColor.DARKGREY :Color

An immutable Color instance initialized to CSS color #A9A9A9
Source: Core/Color.js, line 954

staticconstantColor.DARKKHAKI :Color

An immutable Color instance initialized to CSS color #BDB76B
Source: Core/Color.js, line 963

staticconstantColor.DARKMAGENTA :Color

An immutable Color instance initialized to CSS color #8B008B
Source: Core/Color.js, line 972

staticconstantColor.DARKOLIVEGREEN :Color

An immutable Color instance initialized to CSS color #556B2F
Source: Core/Color.js, line 981

staticconstantColor.DARKORANGE :Color

An immutable Color instance initialized to CSS color #FF8C00
Source: Core/Color.js, line 990

staticconstantColor.DARKORCHID :Color

An immutable Color instance initialized to CSS color #9932CC
Source: Core/Color.js, line 999

staticconstantColor.DARKRED :Color

An immutable Color instance initialized to CSS color #8B0000
Source: Core/Color.js, line 1008

staticconstantColor.DARKSALMON :Color

An immutable Color instance initialized to CSS color #E9967A
Source: Core/Color.js, line 1017

staticconstantColor.DARKSEAGREEN :Color

An immutable Color instance initialized to CSS color #8FBC8F
Source: Core/Color.js, line 1026

staticconstantColor.DARKSLATEBLUE :Color

An immutable Color instance initialized to CSS color #483D8B
Source: Core/Color.js, line 1035

staticconstantColor.DARKSLATEGRAY :Color

An immutable Color instance initialized to CSS color #2F4F4F
Source: Core/Color.js, line 1044

staticconstantColor.DARKSLATEGREY :Color

An immutable Color instance initialized to CSS color #2F4F4F
Source: Core/Color.js, line 1053

staticconstantColor.DARKTURQUOISE :Color

An immutable Color instance initialized to CSS color #00CED1
Source: Core/Color.js, line 1062

staticconstantColor.DARKVIOLET :Color

An immutable Color instance initialized to CSS color #9400D3
Source: Core/Color.js, line 1071

staticconstantColor.DEEPPINK :Color

An immutable Color instance initialized to CSS color #FF1493
Source: Core/Color.js, line 1080

staticconstantColor.DEEPSKYBLUE :Color

An immutable Color instance initialized to CSS color #00BFFF
Source: Core/Color.js, line 1089

staticconstantColor.DIMGRAY :Color

An immutable Color instance initialized to CSS color #696969
Source: Core/Color.js, line 1098

staticconstantColor.DIMGREY :Color

An immutable Color instance initialized to CSS color #696969
Source: Core/Color.js, line 1107

staticconstantColor.DODGERBLUE :Color

An immutable Color instance initialized to CSS color #1E90FF
Source: Core/Color.js, line 1116

staticconstantColor.FIREBRICK :Color

An immutable Color instance initialized to CSS color #B22222
Source: Core/Color.js, line 1125

staticconstantColor.FLORALWHITE :Color

An immutable Color instance initialized to CSS color #FFFAF0
Source: Core/Color.js, line 1134

staticconstantColor.FORESTGREEN :Color

An immutable Color instance initialized to CSS color #228B22
Source: Core/Color.js, line 1143

staticconstantColor.FUSCHIA :Color

An immutable Color instance initialized to CSS color #FF00FF
Source: Core/Color.js, line 1152

staticconstantColor.GAINSBORO :Color

An immutable Color instance initialized to CSS color #DCDCDC
Source: Core/Color.js, line 1161

staticconstantColor.GHOSTWHITE :Color

An immutable Color instance initialized to CSS color #F8F8FF
Source: Core/Color.js, line 1170

staticconstantColor.GOLD :Color

An immutable Color instance initialized to CSS color #FFD700
Source: Core/Color.js, line 1179

staticconstantColor.GOLDENROD :Color

An immutable Color instance initialized to CSS color #DAA520
Source: Core/Color.js, line 1188

staticconstantColor.GRAY :Color

An immutable Color instance initialized to CSS color #808080
Source: Core/Color.js, line 1197

staticconstantColor.GREEN :Color

An immutable Color instance initialized to CSS color #008000
Source: Core/Color.js, line 1206

staticconstantColor.GREENYELLOW :Color

An immutable Color instance initialized to CSS color #ADFF2F
Source: Core/Color.js, line 1215

staticconstantColor.GREY :Color

An immutable Color instance initialized to CSS color #808080
Source: Core/Color.js, line 1224

staticconstantColor.HONEYDEW :Color

An immutable Color instance initialized to CSS color #F0FFF0
Source: Core/Color.js, line 1233

staticconstantColor.HOTPINK :Color

An immutable Color instance initialized to CSS color #FF69B4
Source: Core/Color.js, line 1242

staticconstantColor.INDIANRED :Color

An immutable Color instance initialized to CSS color #CD5C5C
Source: Core/Color.js, line 1251

staticconstantColor.INDIGO :Color

An immutable Color instance initialized to CSS color #4B0082
Source: Core/Color.js, line 1260

staticconstantColor.IVORY :Color

An immutable Color instance initialized to CSS color #FFFFF0
Source: Core/Color.js, line 1269

staticconstantColor.KHAKI :Color

An immutable Color instance initialized to CSS color #F0E68C
Source: Core/Color.js, line 1278

staticconstantColor.LAVENDAR_BLUSH :Color

An immutable Color instance initialized to CSS color #FFF0F5
Source: Core/Color.js, line 1296

staticconstantColor.LAVENDER :Color

An immutable Color instance initialized to CSS color #E6E6FA
Source: Core/Color.js, line 1287

staticconstantColor.LAWNGREEN :Color

An immutable Color instance initialized to CSS color #7CFC00
Source: Core/Color.js, line 1305

staticconstantColor.LEMONCHIFFON :Color

An immutable Color instance initialized to CSS color #FFFACD
Source: Core/Color.js, line 1314

staticconstantColor.LIGHTBLUE :Color

An immutable Color instance initialized to CSS color #ADD8E6
Source: Core/Color.js, line 1323

staticconstantColor.LIGHTCORAL :Color

An immutable Color instance initialized to CSS color #F08080
Source: Core/Color.js, line 1332

staticconstantColor.LIGHTCYAN :Color

An immutable Color instance initialized to CSS color #E0FFFF
Source: Core/Color.js, line 1341

staticconstantColor.LIGHTGOLDENRODYELLOW :Color

An immutable Color instance initialized to CSS color #FAFAD2
Source: Core/Color.js, line 1350

staticconstantColor.LIGHTGRAY :Color

An immutable Color instance initialized to CSS color #D3D3D3
Source: Core/Color.js, line 1359

staticconstantColor.LIGHTGREEN :Color

An immutable Color instance initialized to CSS color #90EE90
Source: Core/Color.js, line 1368

staticconstantColor.LIGHTGREY :Color

An immutable Color instance initialized to CSS color #D3D3D3
Source: Core/Color.js, line 1377

staticconstantColor.LIGHTPINK :Color

An immutable Color instance initialized to CSS color #FFB6C1
Source: Core/Color.js, line 1386

staticconstantColor.LIGHTSEAGREEN :Color

An immutable Color instance initialized to CSS color #20B2AA
Source: Core/Color.js, line 1395

staticconstantColor.LIGHTSKYBLUE :Color

An immutable Color instance initialized to CSS color #87CEFA
Source: Core/Color.js, line 1404

staticconstantColor.LIGHTSLATEGRAY :Color

An immutable Color instance initialized to CSS color #778899
Source: Core/Color.js, line 1413

staticconstantColor.LIGHTSLATEGREY :Color

An immutable Color instance initialized to CSS color #778899
Source: Core/Color.js, line 1422

staticconstantColor.LIGHTSTEELBLUE :Color

An immutable Color instance initialized to CSS color #B0C4DE
Source: Core/Color.js, line 1431

staticconstantColor.LIGHTYELLOW :Color

An immutable Color instance initialized to CSS color #FFFFE0
Source: Core/Color.js, line 1440

staticconstantColor.LIME :Color

An immutable Color instance initialized to CSS color #00FF00
Source: Core/Color.js, line 1449

staticconstantColor.LIMEGREEN :Color

An immutable Color instance initialized to CSS color #32CD32
Source: Core/Color.js, line 1458

staticconstantColor.LINEN :Color

An immutable Color instance initialized to CSS color #FAF0E6
Source: Core/Color.js, line 1467

staticconstantColor.MAGENTA :Color

An immutable Color instance initialized to CSS color #FF00FF
Source: Core/Color.js, line 1476

staticconstantColor.MAROON :Color

An immutable Color instance initialized to CSS color #800000
Source: Core/Color.js, line 1485

staticconstantColor.MEDIUMAQUAMARINE :Color

An immutable Color instance initialized to CSS color #66CDAA
Source: Core/Color.js, line 1494

staticconstantColor.MEDIUMBLUE :Color

An immutable Color instance initialized to CSS color #0000CD
Source: Core/Color.js, line 1503

staticconstantColor.MEDIUMORCHID :Color

An immutable Color instance initialized to CSS color #BA55D3
Source: Core/Color.js, line 1512

staticconstantColor.MEDIUMPURPLE :Color

An immutable Color instance initialized to CSS color #9370DB
Source: Core/Color.js, line 1521

staticconstantColor.MEDIUMSEAGREEN :Color

An immutable Color instance initialized to CSS color #3CB371
Source: Core/Color.js, line 1530

staticconstantColor.MEDIUMSLATEBLUE :Color

An immutable Color instance initialized to CSS color #7B68EE
Source: Core/Color.js, line 1539

staticconstantColor.MEDIUMSPRINGGREEN :Color

An immutable Color instance initialized to CSS color #00FA9A
Source: Core/Color.js, line 1548

staticconstantColor.MEDIUMTURQUOISE :Color

An immutable Color instance initialized to CSS color #48D1CC
Source: Core/Color.js, line 1557

staticconstantColor.MEDIUMVIOLETRED :Color

An immutable Color instance initialized to CSS color #C71585
Source: Core/Color.js, line 1566

staticconstantColor.MIDNIGHTBLUE :Color

An immutable Color instance initialized to CSS color #191970
Source: Core/Color.js, line 1575

staticconstantColor.MINTCREAM :Color

An immutable Color instance initialized to CSS color #F5FFFA
Source: Core/Color.js, line 1584

staticconstantColor.MISTYROSE :Color

An immutable Color instance initialized to CSS color #FFE4E1
Source: Core/Color.js, line 1593

staticconstantColor.MOCCASIN :Color

An immutable Color instance initialized to CSS color #FFE4B5
Source: Core/Color.js, line 1602

staticconstantColor.NAVAJOWHITE :Color

An immutable Color instance initialized to CSS color #FFDEAD
Source: Core/Color.js, line 1611

staticconstantColor.NAVY :Color

An immutable Color instance initialized to CSS color #000080
Source: Core/Color.js, line 1620

staticconstantColor.OLDLACE :Color

An immutable Color instance initialized to CSS color #FDF5E6
Source: Core/Color.js, line 1629

staticconstantColor.OLIVE :Color

An immutable Color instance initialized to CSS color #808000
Source: Core/Color.js, line 1638

staticconstantColor.OLIVEDRAB :Color

An immutable Color instance initialized to CSS color #6B8E23
Source: Core/Color.js, line 1647

staticconstantColor.ORANGE :Color

An immutable Color instance initialized to CSS color #FFA500
Source: Core/Color.js, line 1656

staticconstantColor.ORANGERED :Color

An immutable Color instance initialized to CSS color #FF4500
Source: Core/Color.js, line 1665

staticconstantColor.ORCHID :Color

An immutable Color instance initialized to CSS color #DA70D6
Source: Core/Color.js, line 1674

staticColor.packedLength :Number

The number of elements used to pack the object into an array.
Source: Core/Color.js, line 412

staticconstantColor.PALEGOLDENROD :Color

An immutable Color instance initialized to CSS color #EEE8AA
Source: Core/Color.js, line 1683

staticconstantColor.PALEGREEN :Color

An immutable Color instance initialized to CSS color #98FB98
Source: Core/Color.js, line 1692

staticconstantColor.PALETURQUOISE :Color

An immutable Color instance initialized to CSS color #AFEEEE
Source: Core/Color.js, line 1701

staticconstantColor.PALEVIOLETRED :Color

An immutable Color instance initialized to CSS color #DB7093
Source: Core/Color.js, line 1710

staticconstantColor.PAPAYAWHIP :Color

An immutable Color instance initialized to CSS color #FFEFD5
Source: Core/Color.js, line 1719

staticconstantColor.PEACHPUFF :Color

An immutable Color instance initialized to CSS color #FFDAB9
Source: Core/Color.js, line 1728

staticconstantColor.PERU :Color

An immutable Color instance initialized to CSS color #CD853F
Source: Core/Color.js, line 1737

staticconstantColor.PINK :Color

An immutable Color instance initialized to CSS color #FFC0CB
Source: Core/Color.js, line 1746

staticconstantColor.PLUM :Color

An immutable Color instance initialized to CSS color #DDA0DD
Source: Core/Color.js, line 1755

staticconstantColor.POWDERBLUE :Color

An immutable Color instance initialized to CSS color #B0E0E6
Source: Core/Color.js, line 1764

staticconstantColor.PURPLE :Color

An immutable Color instance initialized to CSS color #800080
Source: Core/Color.js, line 1773

staticconstantColor.RED :Color

An immutable Color instance initialized to CSS color #FF0000
Source: Core/Color.js, line 1782

staticconstantColor.ROSYBROWN :Color

An immutable Color instance initialized to CSS color #BC8F8F
Source: Core/Color.js, line 1791

staticconstantColor.ROYALBLUE :Color

An immutable Color instance initialized to CSS color #4169E1
Source: Core/Color.js, line 1800

staticconstantColor.SADDLEBROWN :Color

An immutable Color instance initialized to CSS color #8B4513
Source: Core/Color.js, line 1809

staticconstantColor.SALMON :Color

An immutable Color instance initialized to CSS color #FA8072
Source: Core/Color.js, line 1818

staticconstantColor.SANDYBROWN :Color

An immutable Color instance initialized to CSS color #F4A460
Source: Core/Color.js, line 1827

staticconstantColor.SEAGREEN :Color

An immutable Color instance initialized to CSS color #2E8B57
Source: Core/Color.js, line 1836

staticconstantColor.SEASHELL :Color

An immutable Color instance initialized to CSS color #FFF5EE
Source: Core/Color.js, line 1845

staticconstantColor.SIENNA :Color

An immutable Color instance initialized to CSS color #A0522D
Source: Core/Color.js, line 1854

staticconstantColor.SILVER :Color

An immutable Color instance initialized to CSS color #C0C0C0
Source: Core/Color.js, line 1863

staticconstantColor.SKYBLUE :Color

An immutable Color instance initialized to CSS color #87CEEB
Source: Core/Color.js, line 1872

staticconstantColor.SLATEBLUE :Color

An immutable Color instance initialized to CSS color #6A5ACD
Source: Core/Color.js, line 1881

staticconstantColor.SLATEGRAY :Color

An immutable Color instance initialized to CSS color #708090
Source: Core/Color.js, line 1890

staticconstantColor.SLATEGREY :Color

An immutable Color instance initialized to CSS color #708090
Source: Core/Color.js, line 1899

staticconstantColor.SNOW :Color

An immutable Color instance initialized to CSS color #FFFAFA
Source: Core/Color.js, line 1908

staticconstantColor.SPRINGGREEN :Color

An immutable Color instance initialized to CSS color #00FF7F
Source: Core/Color.js, line 1917

staticconstantColor.STEELBLUE :Color

An immutable Color instance initialized to CSS color #4682B4
Source: Core/Color.js, line 1926

staticconstantColor.TAN :Color

An immutable Color instance initialized to CSS color #D2B48C
Source: Core/Color.js, line 1935

staticconstantColor.TEAL :Color

An immutable Color instance initialized to CSS color #008080
Source: Core/Color.js, line 1944

staticconstantColor.THISTLE :Color

An immutable Color instance initialized to CSS color #D8BFD8
Source: Core/Color.js, line 1953

staticconstantColor.TOMATO :Color

An immutable Color instance initialized to CSS color #FF6347
Source: Core/Color.js, line 1962

staticconstantColor.TRANSPARENT :Color

An immutable Color instance initialized to CSS transparent.
Source: Core/Color.js, line 2034

staticconstantColor.TURQUOISE :Color

An immutable Color instance initialized to CSS color #40E0D0
Source: Core/Color.js, line 1971

staticconstantColor.VIOLET :Color

An immutable Color instance initialized to CSS color #EE82EE
Source: Core/Color.js, line 1980

staticconstantColor.WHEAT :Color

An immutable Color instance initialized to CSS color #F5DEB3
Source: Core/Color.js, line 1989

staticconstantColor.WHITE :Color

An immutable Color instance initialized to CSS color #FFFFFF
Source: Core/Color.js, line 1998

staticconstantColor.WHITESMOKE :Color

An immutable Color instance initialized to CSS color #F5F5F5
Source: Core/Color.js, line 2007

staticconstantColor.YELLOW :Color

An immutable Color instance initialized to CSS color #FFFF00
Source: Core/Color.js, line 2016

staticconstantColor.YELLOWGREEN :Color

An immutable Color instance initialized to CSS color #9ACD32
Source: Core/Color.js, line 2025

alpha :Number

The alpha component.
Default Value: 1.0
Source: Core/Color.js, line 74

blue :Number

The blue component.
Default Value: 1.0
Source: Core/Color.js, line 68

green :Number

The green component.
Default Value: 1.0
Source: Core/Color.js, line 62

red :Number

The red component.
Default Value: 1.0
Source: Core/Color.js, line 56

Methods

staticColor.byteToFloat(number) → Number

Converts a 'byte' color component in the range of 0 to 255 into a 'float' color component in the range of 0 to 1.0.
Name Type Description
number Number The number to be converted.
Returns:
The converted number.
Source: Core/Color.js, line 470

staticColor.clone(color, result) → Color

Duplicates a Color.
Name Type Description
color Color The Color to duplicate.
result Color optional The object to store the result in, if undefined a new instance will be created.
Returns:
The modified result parameter or a new instance if result was undefined. (Returns undefined if color is undefined)
Source: Core/Color.js, line 492

staticColor.equals(left, right) → Boolean

Returns true if the first Color equals the second color.
Name Type Description
left Color The first Color to compare for equality.
right Color The second Color to compare for equality.
Returns:
true if the Colors are equal; otherwise, false.
Source: Core/Color.js, line 513

staticColor.floatToByte(number) → Number

Converts a 'float' color component in the range of 0 to 1.0 into a 'byte' color component in the range of 0 to 255.
Name Type Description
number Number The number to be converted.
Returns:
The converted number.
Source: Core/Color.js, line 481

staticColor.fromAlpha(color, alpha, result) → Color

Creates a new Color that has the same red, green, and blue components of the specified color, but with the specified alpha value.
Name Type Description
color Color The base color
alpha Number The new alpha component.
result Color optional The object onto which to store the result.
Returns:
The modified result parameter or a new Color instance if one was not provided.
Example:
var translucentRed = Cesium.Color.fromColor(Cesium.Color.RED, 0.9);
Source: Core/Color.js, line 142

staticColor.fromBytes(red, green, blue, alpha, result) → Color

Creates a new Color specified using red, green, blue, and alpha values that are in the range of 0 to 255, converting them internally to a range of 0.0 to 1.0.
Name Type Default Description
red Number 255 optional The red component.
green Number 255 optional The green component.
blue Number 255 optional The blue component.
alpha Number 255 optional The alpha component.
result Color optional The object onto which to store the result.
Returns:
The modified result parameter or a new Color instance if one was not provided.
Source: Core/Color.js, line 114

staticColor.fromCartesian4(cartesian, result) → Color

Creates a Color instance from a Cartesian4. x, y, z, and w map to red, green, blue, and alpha, respectively.
Name Type Description
cartesian Cartesian4 The source cartesian.
result Color optional The object onto which to store the result.
Returns:
The modified result parameter or a new Color instance if one was not provided.
Source: Core/Color.js, line 85

staticColor.fromCssColorString(color) → Color

Creates a Color instance from a CSS color value.
Name Type Description
color String The CSS color value in #rgb, #rrggbb, rgb(), rgba(), hsl(), or hsla() format.
Returns:
The color object, or undefined if the string was not a valid CSS color.
Example:
var cesiumBlue = Cesium.Color.fromCssColorString('#67ADDF');
var green = Cesium.Color.fromCssColorString('green');
See:
Source: Core/Color.js, line 363

staticColor.fromHsl(hue, saturation, lightness, alpha) → Color

Creates a Color instance from hue, saturation, and lightness.
Name Type Default Description
hue Number 0 optional The hue angle 0...1
saturation Number 0 optional The saturation value 0...1
lightness Number 0 optional The lightness value 0...1
alpha Number 1.0 optional The alpha component 0...1
Returns:
The color object.
See:
Source: Core/Color.js, line 201

staticColor.fromRandom(options, result) → Color

Creates a random color using the provided options. For reproducible random colors, you should call CesiumMath#setRandomNumberSeed once at the beginning of your application.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
red Number optional If specified, the red component to use instead of a randomized value.
minimumRed Number 0.0 optional The maximum red value to generate if none was specified.
maximumRed Number 1.0 optional The minimum red value to generate if none was specified.
green Number optional If specified, the green component to use instead of a randomized value.
minimumGreen Number 0.0 optional The maximum green value to generate if none was specified.
maximumGreen Number 1.0 optional The minimum green value to generate if none was specified.
blue Number optional If specified, the blue component to use instead of a randomized value.
minimumBlue Number 0.0 optional The maximum blue value to generate if none was specified.
maximumBlue Number 1.0 optional The minimum blue value to generate if none was specified.
alpha Number optional If specified, the alpha component to use instead of a randomized value.
minimumAlpha Number 0.0 optional The maximum alpha value to generate if none was specified.
maximumAlpha Number 1.0 optional The minimum alpha value to generate if none was specified.
result Color optional The object to store the result in, if undefined a new instance will be created.
Returns:
The modified result parameter or a new instance if result was undefined.
Throws:
  • DeveloperError : minimumRed must be less than or equal to maximumRed.
  • DeveloperError : minimumGreen must be less than or equal to maximumGreen.
  • DeveloperError : minimumBlue must be less than or equal to maximumBlue.
  • DeveloperError : minimumAlpha must be less than or equal to maximumAlpha.
Example:
//Create a completely random color
var color = Cesium.Color.fromRandom();

//Create a random shade of yellow.
var color = Cesium.Color.fromRandom({
    red : 1.0,
    green : 1.0,
    alpha : 1.0
});

//Create a random bright color.
var color = Cesium.Color.fromRandom({
    minimumRed : 0.75,
    minimumGreen : 0.75,
    minimumBlue : 0.75,
    alpha : 1.0
});
Source: Core/Color.js, line 272

staticColor.fromRgba(rgba) → Color

Creates a new Color from a single numeric unsigned 32-bit RGBA value, using the endianness of the system.
Name Type Description
rgba Number A single numeric unsigned 32-bit RGBA value.
Returns:
A new color instance.
Example:
var color = Cesium.Color.fromRgba(0x67ADDFFF);
See:
Source: Core/Color.js, line 184

staticColor.pack(value, array, startingIndex)

Stores the provided instance into the provided array.
Name Type Default Description
value Color The value to pack.
array Array.<Number> The array to pack into.
startingIndex Number 0 optional The index into the array at which to start packing the elements.
Source: Core/Color.js, line 421

staticColor.unpack(array, startingIndex, result)

Retrieves an instance from a packed array.
Name Type Default Description
array Array.<Number> The packed array.
startingIndex Number 0 optional The starting index of the element to be unpacked.
result Color optional The object into which to store the result.
Source: Core/Color.js, line 445

brighten(magnitude, result) → Color

Brightens this color by the provided magnitude.
Name Type Description
magnitude Number A positive number indicating the amount to brighten.
result Color The object onto which to store the result.
Returns:
The modified result parameter.
Example:
var brightBlue = Cesium.Color.BLUE.brighten(0.5, new Color());
Source: Core/Color.js, line 648

clone(result) → Color

Returns a duplicate of a Color instance.
Name Type Description
result Color optional The object to store the result in, if undefined a new instance will be created.
Returns:
The modified result parameter or a new instance if result was undefined.
Source: Core/Color.js, line 539

darken(magnitude, result) → Color

Darkens this color by the provided magnitude.
Name Type Description
magnitude Number A positive number indicating the amount to darken.
result Color The object onto which to store the result.
Returns:
The modified result parameter.
Example:
var darkBlue = Cesium.Color.BLUE.darken(0.5, new Color());
Source: Core/Color.js, line 679

equals(other) → Boolean

Returns true if this Color equals other.
Name Type Description
other Color The Color to compare for equality.
Returns:
true if the Colors are equal; otherwise, false.
Source: Core/Color.js, line 549

equalsEpsilon(other, epsilon) → Boolean

Returns true if this Color equals other componentwise within the specified epsilon.
Name Type Default Description
other Color The Color to compare for equality.
epsilon Number 0.0 optional The epsilon to use for equality testing.
Returns:
true if the Colors are equal within the specified epsilon; otherwise, false.
Source: Core/Color.js, line 560

toBytes(result) → Array.<Number>

Converts this color to an array of red, green, blue, and alpha values that are in the range of 0 to 255.
Name Type Description
result Array.<Number> optional The array to store the result in, if undefined a new instance will be created.
Returns:
The modified result parameter or a new instance if result was undefined.
Source: Core/Color.js, line 602

toCssColorString() → String

Creates a string containing the CSS color value for this color.
Returns:
The CSS equivalent of this color.
See:
Source: Core/Color.js, line 585

toRgba() → Number

Converts this color to a single numeric unsigned 32-bit RGBA value, using the endianness of the system.
Returns:
A single numeric unsigned 32-bit RGBA value.
Example:
var rgba = Cesium.Color.BLUE.toRgba();
See:
Source: Core/Color.js, line 629

toString() → String

Creates a string representing this Color in the format '(red, green, blue, alpha)'.
Returns:
A string representing this Color in the format '(red, green, blue, alpha)'.
Source: Core/Color.js, line 574

withAlpha(alpha, result) → Color

Creates a new Color that has the same red, green, and blue components as this Color, but with the specified alpha value.
Name Type Description
alpha Number The new alpha component.
result Color optional The object onto which to store the result.
Returns:
The modified result parameter or a new Color instance if one was not provided.
Example:
var translucentRed = Cesium.Color.RED.withAlpha(0.9);
Source: Core/Color.js, line 710