Class Color

Classdesc

A color class, inspired by neolitec's Javascript class. Original found at https://gist.github.com/neolitec/1344610 Thanks to neolitec

Index

Constructors

Properties

a b g h l r s Converter Sanitizer Validator

Constructors

constructor

new Color(): Color
Construct a new color with r=0 g=0 b=0.

Consider using the makeHex, makeRGB or makeHSL functions.

Returns Color
Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:89

Properties

a

a: number

Member

Memberof

Color

Instance

b

b: number

Member

Memberof

Color

Instance

g

g: number

Member

Memberof

Color

Instance

h

h: number

Member

Memberof

Color

Instance

l

l: number

Member

Memberof

Color

Instance

r

r: number

Member

Memberof

Color

Instance

s

s: number

Member

Memberof

Color

Instance

`Static` `Private` Converter

Converter: {
    HSLToRGB: ((color) => void);
    RGBToHSL: ((color) => void);
    hue2rgb: ((p, q, t) => number);
} = ...

Type declaration

HSLToRGB: ((color) => void)
Calculates RGB color (nomalized). HSL must be normalized.

http://mjijackson.com/2008/02/rgb-to-hsl-and-rgb-to-hsv-color-model-conversion-algorithms-in-javascript
- - (color): void
  - Parameters
    - color: Color
    Returns void
RGBToHSL: ((color) => void)
Calculates HSL Color. RGB must be normalized. http://mjijackson.com/2008/02/rgb-to-hsl-and-rgb-to-hsv-color-model-conversion-algorithms-in-javascript
- - (color): void
  - Parameters
    - color: Color
    Returns void
hue2rgb: ((p, q, t) => number)
- - (p, q, t): number
  - Parameters
    - p: number
    - q: number
    - t: number
    Returns number

`Static` `Private` Sanitizer

Sanitizer: {
HSL: ((...args) => number[]);
RGB: ((...args) => number[]);
} = ...

Type declaration

HSL: ((...args) => number[])
- - (...args): number[]
  - Parameters
    - Rest ...args: (string | number)[]
    Returns number[]
RGB: ((...args) => number[])
- - (...args): number[]
  - Parameters
    - Rest ...args: any[]
    Returns number[]

`Static` `Private` Validator

Validator: {
checkHEX: ((value) => void);
} = ...

Type declaration

checkHEX: ((value) => void)
Check a hexa color (without #)
- - (value): void
  - Parameters
    - value: string
    Returns void

Methods

alpha

alpha(): number
Get the alpha channel (transparency) of this color.

Returns number
A value between 0.0 and 1.0.

Method
alpha

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:314

blue

blue(): number
Get the blue component of this RGB(A) color. This method just returns the b color attribute.

Returns number
A value between 0.0 and 1.0.

Method
blue

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:156

clone

clone(): Color
Create a clone of this color (RGB).

Returns Color
A clone of this color (in RGB mode).

Method
clone

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:742

cssHEX

cssHEX(): string
Get this color as a CSS-HEX string (non-alpha): #rrggbb

Returns string
This color as a CSS-HEX string.

Method
cssHEX

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:292

cssHSL

cssHSL(): string
Get this color as a CSS hsl string.

Returns string
This color as a CSS hsl string.

Method
cssHSL

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:221

cssHSLA

cssHSLA(): string
Get this color as a CSS hsla string.

Returns string
This color as a CSS hsla string.

Method
cssHSLA

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:233

cssRGB

cssRGB(): string
Get this color as a CSS rgb string.

Consult this for details: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

Returns string
This color as a CSS rgb string.

Method
cssRGB

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:106

cssRGBA

cssRGBA(): string
Get this color as a CSS rgba string.

Consult this for details: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

Returns string
This color as a CSS rgba string.

Method
cssRGBA

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:120

darken

darken(v): Color
Parameters
- v: string | number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:414

desaturate

desaturate(v): Color
Parameters
- v: string | number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:354

fadein

fadein(v): Color
Parameters
- v: string | number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:434

fadeout

fadeout(v): Color
Parameters
- v: string | number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:455

green

green(): number
Get the green component of this RGB(A) color. This method just returns the g color attribute.

Returns number
A value between 0.0 and 1.0.

Method
green

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:144

hue

hue(): number
Get the hue component of this HSL(A) color. This method just returns the h color attribute.

Returns number
A value between 0.0 and 1.0.

Method
hue

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:255

interpolate

interpolate(c, t): Color
Interpolate this color on the RGB scale.
Parameters
- c: Color
  The color to interpolate to.
- t: number
  An interpolation value between 0.0 and 1.0.
Returns Color
A clone of this color (in RGB mode).

Method
interpolate

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:765

lighten

lighten(v): Color
Parameters
- v: string | number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:393

lightness

lightness(): number
Get the lightness component of this HSL(A) color. This method just returns the l color attribute.

Returns number
A value between 0.0 and 1.0.

Method
lightness

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:279

red

red(): number
Get the red component of this RGB(A)color. This method just returns the r color attribute.

Returns number
A value between 0.0 and 1.0.

Method
red

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:132

saturate

saturate(v): Color
Parameters
- v: string | number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:334

saturation

saturation(): number
Get the saturation component of this HSL(A) color. This method just returns the s color attribute.

Returns number
A value between 0.0 and 1.0.

Method
saturation

Instance
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:267

set

set(color): Color
Parameters
- color: Color
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:160

setAlpha

setAlpha(a): Color
Parameters
- a: number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:182

setBlue

setBlue(b): Color
Parameters
- b: number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:176

setGreen

setGreen(g): Color
Parameters
- g: number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:188

setHue

setHue(h): Color
Parameters
- h: number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:194

setLuminance

setLuminance(l): Color
Parameters
- l: number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:206

setRed

setRed(r): Color
Parameters
- r: number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:171

setSaturation

setSaturation(s): Color
Parameters
- s: number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:200

spin

spin(v): Color
Parameters
- v: string | number
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:475

`Static` makeHEX

makeHEX(value): Color
Parameters
- value: string
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:520

`Static` makeHSL

makeHSL(...args): Color
Parameters
- Rest ...args: (string | number)[]
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:506

`Static` makeRGB

makeRGB(...args): Color
Parameters
- Rest ...args: any[]
Returns Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:489

`Static` parse

parse(str): Color
Parse the given color string. Currently only these formate are recognized: hex, rgb, rgba.
Parameters
- str: string
  The string representation to parse.
Returns Color
The color instance that's represented by the given string.

Method
parse

Static
Memberof
Color
- Defined in plotboilerplate/src/ts/utils/datastructures/Color.ts:557