Color

Defined in: color/index.d.ts:4

Represents a color object. Stores all color components (alpha (opacity), red, green, blue) in a [0..255] range.

Constructors ​

Constructor ​

new Color(knownColor: string): Color;

Defined in: color/index.d.ts:5

Parameters ​

Returns ​

Color

Constructor ​

new Color(hex: string): Color;

Defined in: color/index.d.ts:6

Parameters ​

Returns ​

Color

Constructor ​

new Color(argb: number): Color;

Defined in: color/index.d.ts:7

Parameters ​

Returns ​

Color

Constructor ​

new Color(
   alpha: number, 
   red: number, 
   green: number, 
   blue: number, 
   type?: "rgb" | "hsl" | "hsv"): Color;

Defined in: color/index.d.ts:8

Parameters ​

Returns ​

Color

Properties ​

a ​

a: number;

Defined in: color/index.d.ts:13

Gets the Alpha component (in the [0, 255] range) of this color. This is a read-only property.

android ​

android: number;

Defined in: color/index.d.ts:48

Gets the android-specific integer value representation. Same as the Argb one. This is a read-only property.

argb ​

argb: number;

Defined in: color/index.d.ts:38

Gets the Argb Number representation of this color where each 8 bits represent a single color component. This is a read-only property.

b ​

b: number;

Defined in: color/index.d.ts:28

Gets the Blue component (in the [0, 255] range) of this color. This is a read-only property.

g ​

g: number;

Defined in: color/index.d.ts:23

Gets the Green component (in the [0, 255] range) of this color. This is a read-only property.

hex ​

hex: string;

Defined in: color/index.d.ts:33

Gets the Hexadecimal string representation of this color. This is a read-only property.

ios ​

ios: any;

Defined in: color/index.d.ts:53

Gets the iOS-specific UIColor value representation. This is a read-only property.

name ​

name: string;

Defined in: color/index.d.ts:43

Gets the known name of this instance. Defined only if it has been constructed from a known color name - e.g. "red". This is a read-only property.

r ​

r: number;

Defined in: color/index.d.ts:18

Gets the Red component (in the [0, 255] range) of this color. This is a read-only property.

Methods ​

brighten() ​

brighten(amount: number): Color;

Defined in: color/index.d.ts:172

Brighten the color a given amount, from 0 to 100.

Parameters ​

Returns ​

Color

complement() ​

complement(): Color;

Defined in: color/index.d.ts:192

returns the color complement

Returns ​

Color

darken() ​

darken(amount: number): Color;

Defined in: color/index.d.ts:179

Darken the color a given amount, from 0 to 100. Providing 100 will always return black.

Parameters ​

Returns ​

Color

desaturate() ​

desaturate(amount: number): Color;

Defined in: color/index.d.ts:143

Desaturate the color a given amount, from 0 to 100. Providing 100 will is the same as calling greyscale.

Parameters ​

Returns ​

Color

equals() ​

equals(value: Color): boolean;

Defined in: color/index.d.ts:59

Specifies whether this Color is equal to the Color parameter.

Parameters ​

Returns ​

boolean

getBrightness() ​

getBrightness(): number;

Defined in: color/index.d.ts:95

return the brightness

Returns ​

number

getLuminance() ​

getLuminance(): number;

Defined in: color/index.d.ts:100

return the luminance

Returns ​

number

greyscale() ​

greyscale(): Color;

Defined in: color/index.d.ts:157

Completely desaturates a color into greyscale. Same as calling desaturate(100).

Returns ​

Color

isDark() ​

isDark(): boolean;

Defined in: color/index.d.ts:83

return true if brightenss < 128

Returns ​

boolean

isLight() ​

isLight(): boolean;

Defined in: color/index.d.ts:89

return true if brightenss >= 128

Returns ​

boolean

lighten() ​

lighten(amount: number): Color;

Defined in: color/index.d.ts:165

Lighten the color a given amount, from 0 to 100. Providing 100 will always return white.

Parameters ​

Returns ​

Color

olor : Color

saturate() ​

saturate(amount: number): Color;

Defined in: color/index.d.ts:150

Saturate the color a given amount, from 0 to 100.

Parameters ​

Returns ​

Color

setAlpha() ​

setAlpha(a: number): Color;

Defined in: color/index.d.ts:107

Return this color (as a new Color instance) with the provided alpha

Parameters ​

Returns ​

Color

spin() ​

spin(amount: number): Color;

Defined in: color/index.d.ts:186

Spin the hue a given amount, from -360 to 360. Calling with 0, 360, or -360 will do nothing (since it sets the hue back to what it was before).

Parameters ​

Returns ​

Color

toHsl() ​

toHsl(): {
  a: number;
  h: number;
  l: number;
  s: number;
};

Defined in: color/index.d.ts:112

return the hsl representation of the color

Returns ​

{
  a: number;
  h: number;
  l: number;
  s: number;
}

a ​

a: number;

h ​

h: number;

l ​

l: number;

s ​

s: number;

toHslString() ​

toHslString(): string;

Defined in: color/index.d.ts:118

return the CSS hsv representation of the color

Returns ​

string

toHsv() ​

toHsv(): {
  a: number;
  h: number;
  s: number;
  v: number;
};

Defined in: color/index.d.ts:124

return the hsv representation of the color

Returns ​

{
  a: number;
  h: number;
  s: number;
  v: number;
}

a ​

a: number;

h ​

h: number;

s ​

s: number;

v ​

v: number;

toHsvString() ​

toHsvString(): string;

Defined in: color/index.d.ts:130

return the CSS hsv representation of the color

Returns ​

string

toRgbString() ​

toRgbString(): string;

Defined in: color/index.d.ts:136

return the CSS rgb representation of the color

Returns ​

string

equals() ​

static equals(value1: Color, value2: Color): boolean;

Defined in: color/index.d.ts:66

Compares two Color instances.

Parameters ​

Returns ​

boolean

fromHSL() ​

static fromHSL(
   a: any, 
   h: any, 
   s: any, 
   l: any): Color;

Defined in: color/index.d.ts:204

returns a new Color from HSL

Parameters ​

Returns ​

Color

fromHSV() ​

static fromHSV(
   a: any, 
   h: any, 
   s: any, 
   l: any): Color;

Defined in: color/index.d.ts:205

Parameters ​

Returns ​

Color

fromIosColor() ​

static fromIosColor(value: any): Color;

Defined in: color/index.d.ts:77

Creates color from iOS-specific UIColor value representation.

Parameters ​

Returns ​

Color

isValid() ​

static isValid(value: any): boolean;

Defined in: color/index.d.ts:72

Validates if a value can be converted to color.

Parameters ​

Returns ​

boolean

mix() ​

static mix(
   color1: Color, 
   color2: Color, 
   amount: number): Color;

Defined in: color/index.d.ts:198

returns the color complement

Parameters ​

Returns ​

Color