Class Color

Hierarchy

Color

Index

Constructors

constructor

Properties

m_value BLACK NONE WHITE custom

Constructors

constructor

new Color(): Color

Example

let c = new Color( 255, 255, 255, 0.2 );
let d = new Color( "fff" );
let e = new Color( "css:selection-color" );
let f = new Color( "rgba(255,0,255,0.6)" );

Returns Color

new Color(value: string | number): Color
Parameters
- value: string | number
Returns Color
- Defined in src/color.ts:196
new Color(value: string | number, alpha: number): Color
Parameters
- value: string | number
- alpha: number
Returns Color
- Defined in src/color.ts:197
new Color(r: number, g: number, b: number): Color
Parameters
- r: number
- g: number
- b: number
Returns Color
- Defined in src/color.ts:198
new Color(r: number, g: number, b: number, a: number): Color
Parameters
- r: number
- g: number
- b: number
- a: number
Returns Color
- Defined in src/color.ts:199

Properties

`Private` m_value

m_value: number

`Static` BLACK

BLACK: Color = ...

`Static` NONE

NONE: Color = ...

`Static` WHITE

WHITE: Color = ...

`Static` `Private` custom

custom: Color[] = []

Methods

`Private` _getCustomColor

_getCustomColor(name: string): number
Parameters
- name: string
Returns number
- Defined in src/color.ts:678

`Private` _shade

_shade(percent: number): Color
Parameters
- percent: number
Returns Color
- Defined in src/color.ts:255

`Private` _split

_split(): {
    a: number;
    b: number;
    g: number;
    r: number;
}
split the color into it's base element r,g,b & a (!a 1-255)

Returns {
    a: number;
    b: number;
    g: number;
    r: number;
}
- a: number
- b: number
- g: number
- r: number
- Defined in src/color.ts:321

alpha

alpha(): number
get the alpha value of the color

Returns number
- Defined in src/color.ts:578

blue

blue(): number
get the blue value of the color

Returns number
- Defined in src/color.ts:570

darken

darken(percent: number): Color
return a color darken by percent
Parameters
- percent: number
Returns Color
- Defined in src/color.ts:274

fadeout

fadeout(percent: number): Color
change the alpha value
Parameters
- percent: number
Returns Color
- Defined in src/color.ts:336

green

green(): number
get the green value of the color

Returns number
- Defined in src/color.ts:562

lighten

lighten(percent: number): Color
return a color lighten by percent
Parameters
- percent: number
Returns Color
- Defined in src/color.ts:286

red

red(): number
get the red value of the color

Returns number
- Defined in src/color.ts:554

toHex

toHex(with_alpha?: boolean): string
Parameters
- with_alpha: boolean = true
Returns string
- Defined in src/color.ts:613

toString

toString(): string
convert the color into string value

Returns string
- Defined in src/color.ts:594

value

value(): number
Returns number
- Defined in src/color.ts:586

`Static` addCssColor

addCssColor(name: string): void
Parameters
- name: string
Returns void
- Defined in src/color.ts:633

`Static` addCustomColor

addCustomColor(name: string, value: Color): void
Parameters
- name: string
- value: Color
Returns void
- Defined in src/color.ts:629

`Static` contrastColor

contrastColor(color: Color): Color
Parameters
- color: Color
Returns Color
- Defined in src/color.ts:702

`Static` fromCssVar

fromCssVar(varName: string): string
Parameters
- varName: string
Returns string
- Defined in src/color.ts:743

`Static` fromHLS

fromHLS(h: number, l: number, s: number): Color
Parameters
- h: number
- l: number
- s: number
Returns Color
- Defined in src/color.ts:447

`Static` fromHSV

fromHSV(h: number, s: number, v: number, a?: number): Color
Parameters
- h: number
- s: number
- v: number
- a: number = 1
Returns Color
- Defined in src/color.ts:355

`Static` mix

mix(c1: Color, c2: Color, p: number): Color
mix 2 colors

Example
```
let clr = Color.mix( color1, color2, 0.5 );
```
Parameters
- c1: Color
  
  color 1
- c2: Color
  
  color 2
- p: number
Returns Color
- Defined in src/color.ts:305

`Static` parse

parse(str: string): Color
Parameters
- str: string
Returns Color
- Defined in src/color.ts:638

`Static` toHLS

toHLS(color: Color): {
    h: number;
    l: number;
    s: any;
}
Parameters
- color: Color
Returns {
    h: number;
    l: number;
    s: any;
}
- h: number
- l: number
- s: any
- Defined in src/color.ts:482

`Static` toHSV

toHSV(c: Color): {
    a: number;
    h: any;
    s: number;
    v: number;
}
Parameters
- c: Color
Returns {
    a: number;
    h: any;
    s: number;
    v: number;
}
- a: number
- h: any
- s: number
- v: number
- Defined in src/color.ts:405

`Static` valueFromColorName

valueFromColorName(name: string): Color
Parameters
- name: string
Returns Color
- Defined in src/color.ts:730

Class Color

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Example

Returns Color

Parameters

value: string | number

Returns Color

Parameters

value: string | number

alpha: number

Returns Color

Parameters

r: number

g: number

b: number

Returns Color

Parameters

r: number

g: number

b: number

a: number

Returns Color

Properties

Private m_value

Static BLACK

Static NONE

Static WHITE

Static Private custom

Methods

Private _getCustomColor

Parameters

name: string

Returns number

Private _shade

Parameters

percent: number

Returns Color

Private _split

Returns { a: number; b: number; g: number; r: number; }

a: number

b: number

g: number

r: number

alpha

Returns number

blue

Returns number

darken

Parameters

percent: number

Returns Color

fadeout

Parameters

percent: number

Returns Color

green

Returns number

lighten

Parameters

percent: number

Returns Color

red

Returns number

toHex

Parameters

with_alpha: boolean = true

Returns string

toString

Returns string

value

Returns number

Static addCssColor

Parameters

name: string

`Private` m_value

`Static` BLACK

`Static` NONE

`Static` WHITE

`Static` `Private` custom

`Private` _getCustomColor

`Private` _shade

`Private` _split

Returns {
a: number;
b: number;
g: number;
r: number;
}

`Static` addCssColor

`Static` addCustomColor

`Static` contrastColor

`Static` fromCssVar

`Static` fromHLS

`Static` fromHSV

`Static` mix

`Static` parse

`Static` toHLS

Returns {
h: number;
l: number;
s: any;
}

`Static` toHSV

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

`Static` valueFromColorName