Preview 2.0 is now in Public Beta!
Read the Announcement
Color

Summary

Constructors

constructor

new Color(knownColor: string): Color
Parameter Default Description
knownColor
string

Returns Color
new Color(hex: string): Color
Parameter Default Description
hex
string

Returns Color
new Color(argb: number): Color
Parameter Default Description
argb
number

Returns Color
new Color(alpha: number, red: number, green: number, blue: number, type?: "rgb" | "hsl" | "hsv"): Color
Parameter Default Description
alpha
number

red
number

green
number

blue
number

type
"rgb" | "hsl" | "hsv"

Returns Color

Properties

android

android: number

argb

name

Methods

brighten

brighten(amount: number): Color
Parameter Default Description
amount
number

Returns Color

complement

complement(): Color

darken

darken(amount: number): Color
Parameter Default Description
amount
number

Returns Color

desaturate

desaturate(amount: number): Color
Parameter Default Description
amount
number

Returns Color

equals

equals(value: Color): boolean
Parameter Default Description
value

Returns boolean

getBrightness

getBrightness(): number
Returns number

getLuminance

getLuminance(): number

greyscale

greyscale(): Color

isDark

isDark(): boolean
Returns boolean

isLight

isLight(): boolean
Returns boolean

lighten

lighten(amount: number): Color
Parameter Default Description
amount
number

Returns Color

saturate

saturate(amount: number): Color
Parameter Default Description
amount
number

Returns Color

setAlpha

setAlpha(a: number): Color
Parameter Default Description
a
number

Returns Color

spin

spin(amount: number): Color
Parameter Default Description
amount
number

Returns Color

toHsl

toHsl(): {
  a: number
  h: number
  l: number
}
Returns { a: number h: number l: number }

toHslString

toHslString(): string

toHsv

toHsv(): {
  a: number
  h: number
  s: number
}
Returns { a: number h: number s: number }

toHsvString

toHsvString(): string

toRgbString

toRgbString(): string

equals

Static
equals(value1: Color, value2: Color): boolean
Parameter Default Description
value1

value2

Returns boolean

fromHSL

Static
fromHSL(a: any, h: any, s: any, l: any): Color
Parameter Default Description
a
any

h
any

s
any

l
any

Returns Color

fromHSV

Static
fromHSV(a: any, h: any, s: any, l: any): Color
Parameter Default Description
a
any

h
any

s
any

l
any

Returns Color

fromIosColor

Static
fromIosColor(value: any): Color
Parameter Default Description
value
any

Returns Color

isValid

Static
isValid(value: any): boolean
Parameter Default Description
value
any

Returns boolean

mix

Static
mix(color1: Color, color2: Color, amount: number): Color
Parameter Default Description
color1

color2

amount
number

Returns Color