Class Color

Hierarchy

Color

Index

Constructors

Accessors

Methods

alpha clearer clone darken desaturate greyscale hexString hslString lighten mix negate opaquer rgbString rotate saturate

Constructors

constructor

new Color(input: string | number[] | RGBA | Color): Color
constructor
Parameters
- input: string | number[] | RGBA | Color
Returns Color
- Defined in color.d.ts:139

Accessors

rgb

get rgb(): RGBA
Returns
- the color
Returns RGBA
- Defined in color.d.ts:162
set rgb(arg: RGBA): void
Parameters
- arg: RGBA
Returns void
- Defined in color.d.ts:158

valid

get valid(): boolean
true if this is a valid color

Returns

Returns boolean
- Defined in color.d.ts:154

Methods

alpha

alpha(a: number): Color
Set aplha
Parameters
- a: number
  
  the alpha [0..1]
Returns Color
- Defined in color.d.ts:189

clearer

clearer(ratio: number): Color
Make clearer
Parameters
- ratio: number
  
  ratio [0..1]
Returns Color
- Defined in color.d.ts:194

clone

clone(): Color
Clone

Returns Color
- Defined in color.d.ts:184

darken

darken(ratio: number): Color
Darken
Parameters
- ratio: number
  
  ratio [0..1]
Returns Color
- Defined in color.d.ts:214

desaturate

desaturate(ratio: number): Color
Desaturate
Parameters
- ratio: number
  
  ratio [0..1]
Returns Color
- Defined in color.d.ts:224

greyscale

greyscale(): Color
Convert to grayscale

Returns Color
- Defined in color.d.ts:198

hexString

hexString(): string | RGBA
hex string

Returns string | RGBA
- Defined in color.d.ts:170

hslString

hslString(): string
hsl(a) string

Returns string
- Defined in color.d.ts:174

lighten

lighten(ratio: number): Color
Lighten
Parameters
- ratio: number
  
  ratio [0..1]
Returns Color
- Defined in color.d.ts:209

mix

mix(color: Color, weight: number): Color
Mix another color to this color.
Parameters
- color: Color
  
  Color to mix in
- weight: number
  
  0..1
Returns Color
- Defined in color.d.ts:180

negate

negate(): Color
Returns Color
- Defined in color.d.ts:204

opaquer

opaquer(ratio: number): Color
Opaquer
Parameters
- ratio: number
  
  ratio [0..1]
Returns Color
- Defined in color.d.ts:203

rgbString

rgbString(): string
rgb(a) string

Returns string
- Defined in color.d.ts:166

rotate

rotate(deg: number): Color
Rotate
Parameters
- deg: number
  
  degrees to rotate
Returns Color
- Defined in color.d.ts:229

saturate

saturate(ratio: number): Color
Saturate
Parameters
- ratio: number
  
  ratio [0..1]
Returns Color
- Defined in color.d.ts:219

Generated using TypeDoc