Class Color

Provides standard colors (e.g. Color.Black) but you can also create custom colors using RGB, HSL, or Hex. Also provides useful color operations like Color.lighten, Color.darken, and more.

Hierarchy

Color

Index

Constructors

constructor

new Color(r: number, g: number, b: number, a?: number): Color
Creates a new instance of Color from an r, g, b, a
Parameters
- r: number
  
  The red component of color (0-255)
- g: number
  
  The green component of color (0-255)
- b: number
  
  The blue component of color (0-255)
- Optional a: number
  
  The alpha component of color (0-1.0)
Returns Color
- Defined in Color.ts:46

Properties

a

a: number

Alpha channel (between 0 and 1)

b

b: number

Blue channel

g

g: number

Green channel

h

h: number

Hue

l

l: number

Lightness

r

r: number

Red channel

s

s: number

Saturation

Accessors

`Static` Azure

get Azure(): Color
Azure (#007FFF)

Returns Color
- Defined in Color.ts:375

`Static` Black

get Black(): Color
Black (#000000)

Returns Color
- Defined in Color.ts:284

`Static` Blue

get Blue(): Color
Blue (#0000FF)

Returns Color
- Defined in Color.ts:368

`Static` Chartreuse

get Chartreuse(): Color
Chartreuse (#7FFF00)

Returns Color
- Defined in Color.ts:403

`Static` Cyan

get Cyan(): Color
Cyan (#00FFFF)

Returns Color
- Defined in Color.ts:382

`Static` DarkGray

get DarkGray(): Color
Dark gray (#A9A9A9)

Returns Color
- Defined in Color.ts:312

`Static` ExcaliburBlue

get ExcaliburBlue(): Color
ExcaliburBlue (#176BAA)

Returns Color
- Defined in Color.ts:417

`Static` Gray

get Gray(): Color
Gray (#808080)

Returns Color
- Defined in Color.ts:298

`Static` Green

get Green(): Color
Green (#00FF00)

Returns Color
- Defined in Color.ts:396

`Static` LightGray

get LightGray(): Color
Light gray (#D3D3D3)

Returns Color
- Defined in Color.ts:305

`Static` Magenta

get Magenta(): Color
Magenta (#FF00FF)

Returns Color
- Defined in Color.ts:354

`Static` Orange

get Orange(): Color
Orange (#FFA500)

Returns Color
- Defined in Color.ts:326

`Static` Red

get Red(): Color
Red (#FF0000)

Returns Color
- Defined in Color.ts:333

`Static` Rose

get Rose(): Color
Rose (#FF007F)

Returns Color
- Defined in Color.ts:347

`Static` Transparent

get Transparent(): Color
Transparent (#FFFFFF00)

Returns Color
- Defined in Color.ts:410

`Static` Vermilion

get Vermilion(): Color
Vermilion (#FF5B31)

Returns Color
- Defined in Color.ts:340

`Static` Violet

get Violet(): Color
Violet (#7F00FF)

Returns Color
- Defined in Color.ts:361

`Static` Viridian

get Viridian(): Color
Viridian (#59978F)

Returns Color
- Defined in Color.ts:389

`Static` White

get White(): Color
White (#FFFFFF)

Returns Color
- Defined in Color.ts:291

`Static` Yellow

get Yellow(): Color
Yellow (#FFFF00)

Returns Color
- Defined in Color.ts:319

Methods

average

average(color: Color): Color
Averages the current color with another
Parameters
- color: Color
  
  The other color
Returns Color
- Defined in Color.ts:202

clone

clone(): Color
Returns a clone of the current color.

Returns Color
- Defined in Color.ts:277

darken

darken(factor?: number): Color
Darkens the current color by a specified amount
Parameters
- factor: number = 0.1
  
  The amount to darken by [0-1]
Returns Color
- Defined in Color.ts:138

desaturate

desaturate(factor?: number): Color
Desaturates the current color by a specified amount
Parameters
- factor: number = 0.1
  
  The amount to desaturate by [0-1]
Returns Color
- Defined in Color.ts:160

equal

equal(color: Color): boolean
Parameters
- color: Color
Returns boolean
- Defined in Color.ts:210

fillStyle

fillStyle(): string
Returns a CSS string representation of a color.

Returns string
- Defined in Color.ts:270

invert

invert(): Color
Inverts the current color

Returns Color
- Defined in Color.ts:193

lighten

lighten(factor?: number): Color
Lightens the current color by a specified amount
Parameters
- factor: number = 0.1
  
  The amount to lighten by [0-1]
Returns Color
- Defined in Color.ts:127

multiply

multiply(color: Color): Color
Multiplies a color by another, results in a darker color
Parameters
- color: Color
  
  The other color
Returns Color
- Defined in Color.ts:171

saturate

saturate(factor?: number): Color
Saturates the current color by a specified amount
Parameters
- factor: number = 0.1
  
  The amount to saturate by [0-1]
Returns Color
- Defined in Color.ts:149

screen

screen(color: Color): Color
Screens a color by another, results in a lighter color
Parameters
- color: Color
  
  The other color
Returns Color
- Defined in Color.ts:184

toHSLA

toHSLA(): string
Return HSLA representation of a color.

Returns string
- Defined in Color.ts:263

toHex

toHex(): string
Return Hex representation of a color.

Returns string
- Defined in Color.ts:245

toRGBA

toRGBA(): string
Return RGBA representation of a color.

Returns string
- Defined in Color.ts:252

toString

toString(format?: "rgb" | "hsl" | "hex"): string
Returns a CSS string representation of a color.
Parameters
- format: "rgb" | "hsl" | "hex" = 'rgb'
  
  Color representation, accepts: rgb, hsl, or hex
Returns string
- Defined in Color.ts:219

`Static` fromHSL

fromHSL(h: number, s: number, l: number, a?: number): Color
Creates a new instance of Color from hsla values
Parameters
- h: number
  
  Hue is represented [0-1]
- s: number
  
  Saturation is represented [0-1]
- l: number
  
  Luminance is represented [0-1]
- a: number = 1.0
  
  Alpha is represented [0-1]
Returns Color
- Defined in Color.ts:117

`Static` fromHex

fromHex(hex: string): Color
Creates a new instance of Color from a hex string
Parameters
- hex: string
  
  CSS color string of the form #ffffff, the alpha component is optional
Returns Color
- Defined in Color.ts:92

`Static` fromRGB

fromRGB(r: number, g: number, b: number, a?: number): Color
Creates a new instance of Color from an r, g, b, a
Parameters
- r: number
  
  The red component of color (0-255)
- g: number
  
  The green component of color (0-255)
- b: number
  
  The blue component of color (0-255)
- Optional a: number
  
  The alpha component of color (0-1.0)
Returns Color
- Defined in Color.ts:61

`Static` fromRGBString

fromRGBString(string: string): Color
Creates a new instance of Color from a rgb string
Parameters
- string: string
  
  CSS color string of the form rgba(255, 255, 255, 1) or rgb(255, 255, 255)
Returns Color
- Defined in Color.ts:70

Class Color

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

r: number

g: number

b: number

Optional a: number

Returns Color

Properties

a

b

g

h

l

r

s

Accessors

Static Azure

Returns Color

Static Black

Returns Color

Static Blue

Returns Color

Static Chartreuse

Returns Color

Static Cyan

Returns Color

Static DarkGray

Returns Color

Static ExcaliburBlue

Returns Color

Static Gray

Returns Color

Static Green

Returns Color

Static LightGray

Returns Color

Static Magenta

Returns Color

Static Orange

Returns Color

Static Red

Returns Color

Static Rose

Returns Color

Static Transparent

Returns Color

Static Vermilion

Returns Color

Static Violet

Returns Color

Static Viridian

Returns Color

Static White

Returns Color

Static Yellow

Returns Color

Methods

average

Parameters

color: Color

Returns Color

clone

Returns Color

darken

Parameters

factor: number = 0.1

Returns Color

desaturate

Parameters

factor: number = 0.1

Returns Color

equal

`Optional` a: number

`Static` Azure

`Static` Black

`Static` Blue

`Static` Chartreuse

`Static` Cyan

`Static` DarkGray

`Static` ExcaliburBlue

`Static` Gray

`Static` Green

`Static` LightGray

`Static` Magenta

`Static` Orange

`Static` Red

`Static` Rose

`Static` Transparent

`Static` Vermilion

`Static` Violet

`Static` Viridian

`Static` White

`Static` Yellow

`Static` fromHSL

`Static` fromHex

`Static` fromRGB

`Optional` a: number

`Static` fromRGBString