Class Color

Index

Constructors

Accessors

Methods

alpha clearer clone darken desaturate greyscale hexString hslString interpolate lighten mix negate oklchString 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:109

Accessors

rgb

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

valid

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

Returns boolean
- Defined in color.ts:130

Methods

alpha

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

clearer

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

clone

clone(): Color
Clone

Returns Color
- Defined in color.ts:227

darken

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

desaturate

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

greyscale

greyscale(): Color
Convert to grayscale

Returns Color
- Defined in color.ts:256

hexString

hexString(): string
hex string

Returns string
- Defined in color.ts:164

hslString

hslString(): string
hsl(a) string

Returns string
- Defined in color.ts:172

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:216

lighten

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

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:190

negate

negate(): Color
Negates the rgb value

Returns Color
- Defined in color.ts:279

oklchString

oklchString(): string
oklch string

Returns string
- Defined in color.ts:180

opaquer

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

rgbString

rgbString(): string
rgb(a) string

Returns string
- Defined in color.ts:156

rotate

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

saturate

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