Class Color

Hierarchy

Color

Constructors

constructor

new Color(hexval: string): Color
Parameters
- hexval: string
Returns Color
- Defined in packages/helpers/src/color.ts:189
new Color(rgbaval: RGB | RGBA): Color
Parameters
- rgbaval: RGB | RGBA
Returns Color
- Defined in packages/helpers/src/color.ts:190
new Color(hexval: string, rgbaval: RGBA, hslaval: HSLA): Color
Parameters
- hexval: string
- rgbaval: RGBA
- hslaval: HSLA
Returns Color
- Defined in packages/helpers/src/color.ts:191

Accessors

alpha

get alpha(): number
Returns number
- Defined in packages/helpers/src/color.ts:294

blackness

get blackness(): number
Returns number
- Defined in packages/helpers/src/color.ts:307

blue

get blue(): number
Returns number
- Defined in packages/helpers/src/color.ts:278

green

get green(): number
Returns number
- Defined in packages/helpers/src/color.ts:274

hex

get hex(): string
Returns string
- Defined in packages/helpers/src/color.ts:237

hsl

get hsl(): HSL
Returns HSL
- Defined in packages/helpers/src/color.ts:250

hslStr

get hslStr(): string
Returns string
- Defined in packages/helpers/src/color.ts:324

hsla

get hsla(): HSLA
Returns HSLA
- Defined in packages/helpers/src/color.ts:254

hslaStr

get hslaStr(): string
Returns string
- Defined in packages/helpers/src/color.ts:329

hue

get hue(): number
Returns number
- Defined in packages/helpers/src/color.ts:282

hwb

get hwb(): HWB
Returns HWB
- Defined in packages/helpers/src/color.ts:258

hwbStr

get hwbStr(): string
Returns string
- Defined in packages/helpers/src/color.ts:335

ieHexStr

get ieHexStr(): string
Returns string
- Defined in packages/helpers/src/color.ts:312

lightness

get lightness(): number
Returns number
- Defined in packages/helpers/src/color.ts:290

opacity

get opacity(): number
Returns number
- Defined in packages/helpers/src/color.ts:298

red

get red(): number
Returns number
- Defined in packages/helpers/src/color.ts:270

rgb

get rgb(): RGB
Returns RGB
- Defined in packages/helpers/src/color.ts:242

rgbStr

get rgbStr(): string
Returns string
- Defined in packages/helpers/src/color.ts:316

rgba

get rgba(): RGBA
Returns RGBA
- Defined in packages/helpers/src/color.ts:246

rgbaStr

get rgbaStr(): string
Returns string
- Defined in packages/helpers/src/color.ts:320

saturation

get saturation(): number
Returns number
- Defined in packages/helpers/src/color.ts:286

whiteness

get whiteness(): number
Returns number
- Defined in packages/helpers/src/color.ts:302

Methods

adjust

adjust(opt: Partial<Record<"hue" | "saturation" | "blue" | "green" | "red" | "lightness" | "alpha", number>>): Color
Parameters
- opt: Partial<Record<"hue" | "saturation" | "blue" | "green" | "red" | "lightness" | "alpha", number>>
Returns Color
- Defined in packages/helpers/src/color.ts:416

adjustAlpha

adjustAlpha(deg?: number, scale?: number): Color
Parameters
- Optional deg: number
- scale: number = 0
Returns Color
- Defined in packages/helpers/src/color.ts:372

adjustBlue

adjustBlue(deg?: number, scale?: number): Color
Parameters
- Optional deg: number
- scale: number = 0
Returns Color
- Defined in packages/helpers/src/color.ts:356

adjustGreen

adjustGreen(deg?: number, scale?: number): Color
Parameters
- Optional deg: number
- scale: number = 0
Returns Color
- Defined in packages/helpers/src/color.ts:352

adjustHue

adjustHue(deg: number): Color
Parameters
- deg: number
Returns Color
- Defined in packages/helpers/src/color.ts:360

adjustLightness

adjustLightness(deg?: number, scale?: number): Color
Parameters
- Optional deg: number
- scale: number = 0
Returns Color
- Defined in packages/helpers/src/color.ts:368

adjustRed

adjustRed(deg?: number, scale?: number): Color
Parameters
- Optional deg: number
- scale: number = 0
Returns Color
- Defined in packages/helpers/src/color.ts:348

adjustSaturation

adjustSaturation(deg?: number, scale?: number): Color
Parameters
- Optional deg: number
- scale: number = 0
Returns Color
- Defined in packages/helpers/src/color.ts:364

change

change(opt: Partial<Record<"hue" | "saturation" | "blue" | "green" | "red" | "lightness" | "alpha", number>>): Color
Parameters
- opt: Partial<Record<"hue" | "saturation" | "blue" | "green" | "red" | "lightness" | "alpha", number>>
Returns Color
- Defined in packages/helpers/src/color.ts:432

complement

complement(): Color
Returns Color
- Defined in packages/helpers/src/color.ts:376

complementSet

complementSet(n: number): Color[]
Parameters
- n: number
Returns Color[]
- Defined in packages/helpers/src/color.ts:484

darken

darken(amount: number): Color
Parameters
- amount: number
Returns Color
- Defined in packages/helpers/src/color.ts:396

darkenSet

darkenSet(n: number): Color[]
Parameters
- n: number
Returns Color[]
- Defined in packages/helpers/src/color.ts:476

desaturate

desaturate(deg: number): Color
Parameters
- deg: number
Returns Color
- Defined in packages/helpers/src/color.ts:384

desaturateSet

desaturateSet(n: number): Color[]
Parameters
- n: number
Returns Color[]
- Defined in packages/helpers/src/color.ts:480

fadeIn

fadeIn(deg: number): Color
Parameters
- deg: number
Returns Color
- Defined in packages/helpers/src/color.ts:408

fadeOut

fadeOut(deg: number): Color
Parameters
- deg: number
Returns Color
- Defined in packages/helpers/src/color.ts:412

grayscale

grayscale(): Color
Returns Color
- Defined in packages/helpers/src/color.ts:388

invert

invert(weight?: number): Color
Parameters
- weight: number = 100
Returns Color
- Defined in packages/helpers/src/color.ts:342

invertSet

invertSet(n: number): Color[]
Parameters
- n: number
Returns Color[]
- Defined in packages/helpers/src/color.ts:491

lighten

lighten(amount: number): Color
Parameters
- amount: number
Returns Color
- Defined in packages/helpers/src/color.ts:392

lightenSet

lightenSet(n: number): Color[]
Parameters
- n: number
Returns Color[]
- Defined in packages/helpers/src/color.ts:472

opacify

opacify(deg: number): Color
Parameters
- deg: number
Returns Color
- Defined in packages/helpers/src/color.ts:400

saturate

saturate(deg: number): Color
Parameters
- deg: number
Returns Color
- Defined in packages/helpers/src/color.ts:380

scale

scale(opt: internal.ScaleColorOptions): Color
Parameters
- opt: internal.ScaleColorOptions
Returns Color
- Defined in packages/helpers/src/color.ts:424

transparentize

transparentize(deg: number): Color
Parameters
- deg: number
Returns Color
- Defined in packages/helpers/src/color.ts:404

`Static` hex

hex(str: string): Color
Parameters
- str: string
Returns Color
- Defined in packages/helpers/src/color.ts:204

`Static` hsl

hsl(h: number, s: number, l: number, a?: number): Color
Parameters
- h: number
- s: number
- l: number
- a: number = 1
Returns Color
- Defined in packages/helpers/src/color.ts:222

`Static` hsla

hsla(h: number, s: number, l: number, a: number): Color
Parameters
- h: number
- s: number
- l: number
- a: number
Returns Color
- Defined in packages/helpers/src/color.ts:226

`Static` hwb

hwb(hue: number, whiteness: number, blackness: number, alpha?: number): Color
Parameters
- hue: number
- whiteness: number
- blackness: number
- alpha: number = 1
Returns Color
- Defined in packages/helpers/src/color.ts:233

`Static` mix

mix(c1: Color, c2: Color, w?: number): Color
Parameters
- c1: Color
- c2: Color
- w: number = 50
Returns Color
- Defined in packages/helpers/src/color.ts:262

`Static` rgb

rgb(r: number, g: number, b: number, a?: number): Color
Parameters
- r: number
- g: number
- b: number
- a: number = 1
Returns Color
- Defined in packages/helpers/src/color.ts:211

`Static` rgba

rgba(r: number, g: number, b: number, a: number): Color
Parameters
- r: number
- g: number
- b: number
- a: number
Returns Color
- Defined in packages/helpers/src/color.ts:215

`Static` subcolormix

subcolormix(c1: Color, c2: Color, w?: number): Color
Parameters
- c1: Color
- c2: Color
- w: number = 50
Returns Color
- Defined in packages/helpers/src/color.ts:266