Class Color

Index

Constructors

Accessors

Methods

alpha clearer clone darken desaturate greyscale hexString hslString interpolate 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.ts:102

Accessors

rgb

get rgb(): RGBA
Returns RGBA
- the color
- Defined in color.ts:129
set rgb(obj: RGBA): void
Parameters
- obj: RGBA
  the color
Returns void
- Defined in color.ts:140

valid

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

Returns boolean
- Defined in color.ts:122

Methods

alpha

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

clearer

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

clone

clone(): Color
Clone

Returns Color
- Defined in color.ts:209

darken

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

desaturate

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

greyscale

greyscale(): Color
Convert to grayscale

Returns Color
- Defined in color.ts:238

hexString

hexString(): string
hex string

Returns string
- Defined in color.ts:156

hslString

hslString(): string
hsl(a) string

Returns string
- Defined in color.ts:164

interpolate

interpolate(color: Color, t: number): Color
Interpolate a color value between this and color
Parameters
- color: Color
- t: number
  0..1
Returns Color
- Defined in color.ts:198

lighten

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

mix

mix(color: Color, weight?: number): Color
Mix another color to this color.
Parameters
- color: Color
  Color to mix in
- weight: number = 0.5
  0..1
Returns Color
- Defined in color.ts:174

negate

negate(): Color
Negates the rgb value

Returns Color
- Defined in color.ts:261

opaquer

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

rgbString

rgbString(): string
rgb(a) string

Returns string
- Defined in color.ts:148

rotate

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

saturate

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