Class Color

Tutorial

Hierarchy

Color

Index

Constructors

Properties

Constructors

constructor

new Color(color?): Color
Parameters
- Optional color: TColorArg
  
  optional in hex or rgb(a) or hsl format or from known color list
Returns Color
- Defined in src/color/Color.ts:23

Properties

`Private` _source

_source: TRGBAColorSource

Methods

`Private` _tryParsingColor

_tryParsingColor(color?): TRGBAColorSource
Private
Parameters
- Optional color: string
  
  Color value to parse
Returns TRGBAColorSource
- Defined in src/color/Color.ts:42

getAlpha

getAlpha(): number
Gets value of alpha channel for this color

Returns number
0-1
- Defined in src/color/Color.ts:129

getSource

getSource(): TRGBAColorSource
Returns source of this color (where source is an array representation; ex: [200, 200, 100, 1])

Returns TRGBAColorSource
- Defined in src/color/Color.ts:60

overlayWith

overlayWith(otherColor): Color
Overlays color with another color
Parameters
- otherColor: string | Color
Returns Color
thisArg
- Defined in src/color/Color.ts:169

setAlpha

setAlpha(alpha): Color
Sets value of alpha channel for this color
Parameters
- alpha: number
  
  Alpha value 0-1
Returns Color
thisArg
- Defined in src/color/Color.ts:138

setSource

setSource(source): void
Sets source of this color (where source is an array representation; ex: [200, 200, 100, 1])
Parameters
- source: TRGBAColorSource
Returns void
- Defined in src/color/Color.ts:68

toBlackWhite

toBlackWhite(threshold): Color
Transforms color to its black and white representation
Parameters
- threshold: number
Returns Color
thisArg
- Defined in src/color/Color.ts:157

toGrayscale

toGrayscale(): Color
Transforms color to its grayscale representation

Returns Color
thisArg
- Defined in src/color/Color.ts:147

toHex

toHex(): string
Returns color representation in HEX format

Returns string
ex: FF5555
- Defined in src/color/Color.ts:111

toHexa

toHexa(): string
Returns color representation in HEXA format

Returns string
ex: FF5555CC
- Defined in src/color/Color.ts:120

toHsl

toHsl(): string
Returns color representation in HSL format

Returns string
ex: hsl(0-360,0%-100%,0%-100%)
- Defined in src/color/Color.ts:93

toHsla

toHsla(): string
Returns color representation in HSLA format

Returns string
ex: hsla(0-360,0%-100%,0%-100%,0-1)
- Defined in src/color/Color.ts:102

toRgb

toRgb(): string
Returns color representation in RGB format

Returns string
ex: rgb(0-255,0-255,0-255)
- Defined in src/color/Color.ts:76

toRgba

toRgba(): string
Returns color representation in RGBA format

Returns string
ex: rgba(0-255,0-255,0-255,0-1)
- Defined in src/color/Color.ts:85

`Static` fromHex

fromHex(color): Color
Returns new color object, when given a color in HEX format
Parameters
- color: string
  
  Color value ex: FF5555
Returns Color

Static

Member Of
Color
- Defined in src/color/Color.ts:293

`Static` fromHsl

fromHsl(color): Color
Returns new color object, when given a color in HSL format
Parameters
- color: string
  
  Color value ex: hsl(0-260,0%-100%,0%-100%)
Returns Color

Member Of
Color
- Defined in src/color/Color.ts:232

`Static` fromHsla

fromHsla(color): Color
Returns new color object, when given a color in HSLA format
Parameters
- color: string
Returns Color

Static

Function

Member Of
Color
- Defined in src/color/Color.ts:244

`Static` fromRgb

fromRgb(color): Color
Returns new color object, when given a color in RGB format
Parameters
- color: string
  
  Color value ex: rgb(0-255,0-255,0-255)
Returns Color

Member Of
Color
- Defined in src/color/Color.ts:191

`Static` fromRgba

fromRgba(color): Color
Returns new color object, when given a color in RGBA format
Parameters
- color: string
Returns Color

Static

Function

Member Of
Color
- Defined in src/color/Color.ts:203

`Static` sourceFromHex

sourceFromHex(color): undefined | TRGBAColorSource
Returns array representation (ex: [100, 100, 200, 1]) of a color that's in HEX format
Parameters
- color: string
  
  ex: FF5555 or FF5544CC (RGBa)
Returns undefined | TRGBAColorSource
source

Static

Member Of
Color
- Defined in src/color/Color.ts:304

`Static` sourceFromHsl

sourceFromHsl(color): undefined | TRGBAColorSource
Returns array representation (ex: [100, 100, 200, 1]) of a color that's in HSL or HSLA format. Adapted from https://github.com/mjijackson
Parameters
- color: string
  
  Color value ex: hsl(0-360,0%-100%,0%-100%) or hsla(0-360,0%-100%,0%-100%, 0-1)
Returns undefined | TRGBAColorSource
source

Member Of
Color

See
http://http://www.w3.org/TR/css3-color/#hsl-color
- Defined in src/color/Color.ts:256

`Static` sourceFromRgb

sourceFromRgb(color): undefined | TRGBAColorSource
Returns array representation (ex: [100, 100, 200, 1]) of a color that's in RGB or RGBA format
Parameters
- color: string
  
  Color value ex: rgb(0-255,0-255,0-255), rgb(0%-100%,0%-100%,0%-100%)
Returns undefined | TRGBAColorSource
source

Member Of
Color
- Defined in src/color/Color.ts:213

Generated using TypeDoc