Class Color

Hierarchy

Color

Index

Constructors

constructor

Properties

_a
_b
_g
_r

Methods

Constructors

constructor

new Color(r?: number, g?: number, b?: number, a?: number): Color

- Defined in utils/Color.ts:14
Parameters
- Default value r: number = 0
- Default value g: number = 0
- Default value b: number = 0
- Default value a: number = 1
Returns Color

Properties

Private _a

_a: number

Private _b

_b: number

Private _g

_g: number

Private _r

_r: number

Methods

Private _toHexString

_toHexString(value: number): string

- Defined in utils/Color.ts:121
Parameters
- value: number
Returns string

getAlpha

getAlpha(): number

- Defined in utils/Color.ts:67
Returns number

getBlue

getBlue(): number

- Defined in utils/Color.ts:63
Returns number

getGreen

getGreen(): number

- Defined in utils/Color.ts:59
Returns number

getRed

getRed(): number

- Defined in utils/Color.ts:55
Returns number

setAlpha

setAlpha(a: number): void

- Defined in utils/Color.ts:51
Parameters
- a: number
  
  Number between 0-1
Returns void

setBlue

setBlue(b: number): void

- Defined in utils/Color.ts:43
Parameters
- b: number
  
  Number between 0-255
Returns void

setGreen

setGreen(g: number): void

- Defined in utils/Color.ts:35
Parameters
- g: number
  
  Number between 0-255
Returns void

setRed

setRed(r: number): void

- Defined in utils/Color.ts:27
Parameters
- r: number
  
  Number between 0-255
Returns void

toHex

toHex(): number

- Defined in utils/Color.ts:94
toRGB

Returns as integer/ColorCode. Note this does not return an alpha value.

Returns number

toHexString

toHexString(): string

- Defined in utils/Color.ts:103
toHexString

Returns a hex string in #RRGGBB format.

Returns string

toRGB

toRGB(): string

- Defined in utils/Color.ts:76
toRGB

Returns as string in rgb(red,green,blue) format. Note this does not return an alpha value.

Returns string

toRGBA

toRGBA(): string

- Defined in utils/Color.ts:85
toRGB

Returns as string in rgba(red,green,blue,alpha) format.

Returns string

toString

toString(): string

- Defined in utils/Color.ts:117
Returns string

valueOf

valueOf(): string

- Defined in utils/Color.ts:113
Returns string

Static Private _parseColorName

_parseColorName(color: string): Array<number>

- Defined in utils/Color.ts:206
Parameters
- color: string
Returns Array<number>

Static Private _parseHex

_parseHex(hex: number | ColorCode): RGB

- Defined in utils/Color.ts:269
Parameters
- hex: number | ColorCode
Returns RGB

Static Private _parseHexString

_parseHexString(color: string): Array<number>

- Defined in utils/Color.ts:131
Parameters
- color: string
Returns Array<number>

Static Private _parseRGB

_parseRGB(color: string): Array<number>

- Defined in utils/Color.ts:164
Parameters
- color: string
Returns Array<number>

Static fromColorCode

fromColorCode(code: ColorCode): Color

- Defined in utils/Color.ts:265
Parameters
- code: ColorCode
Returns Color

Static fromHex

fromHex(hex: number | ColorCode): Color

- Defined in utils/Color.ts:260
Parameters
- hex: number | ColorCode
  
  Should be a 6 digit hex: 0x00000000 - 0xFFFFFF ^^^^^^ | | | | | |>Blue | |>Green |>Red
Returns Color

Static fromString

fromString(color: string): Color

- Defined in utils/Color.ts:230
Parameters
- color: string
  
  Accepted formats:
  
  #FFF = rgba(255,255,255,1)
  
  #FFF0 = rgba(255,255,255,0)
  
  #FFFFFF = rgba(255,255,255,1)
  
  rgb(255,255,255) = rgba(255,255,255,1) rgba(255,255,255,1) = rgba(255,255,255,1)
  
  If all else fails, a color map will be used to map a color string to the appropriate color.
Returns Color

Generated using TypeDoc