Color | plotboilerplate

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

Hierarchy

Color

Index

Constructors

constructor

Properties

a
b
g
h
l
r
s

Methods

Object literals

Constructors

constructor

new Color(): Color

- Defined in src/ts/utils/datastructures/Color.ts:77
Construct a new color with r=0 g=0 b=0.

Consider using the makeHex, makeRGB or makeHSL functions.

instance

memberof

Color

Returns Color

Properties

a

a: number

member: {number}
memberof: Color
instance

b

b: number

member: {number}
memberof: Color
instance

g

g: number

member: {number}
memberof: Color
instance

h

h: number

member: {number}
memberof: Color
instance

l

l: number

member: {number}
memberof: Color
instance

r

r: number

member: {number}
memberof: Color
instance

s

s: number

member: {number}
memberof: Color
instance

Methods

alpha

alpha(): number

- Defined in src/ts/utils/datastructures/Color.ts:313
Get the alpha channel (transparency) of this color.

method

alpha

instance

memberof

Color

Returns number

A value between 0.0 and 1.0.

blue

blue(): number

- Defined in src/ts/utils/datastructures/Color.ts:155
Get the blue component of this RGB(A) color. This method just returns the b color attribute.

method

blue

instance

memberof

Color

Returns number

A value between 0.0 and 1.0.

clone

clone(): Color

- Defined in src/ts/utils/datastructures/Color.ts:718
Create a clone of this color (RGB).

method

clone

instance

memberof

Color

Returns Color

A clone of this color (in RGB mode).

cssHEX

cssHEX(): string

- Defined in src/ts/utils/datastructures/Color.ts:291
Get this color as a CSS-HEX string (non-alpha): #rrggbb

method

cssHEX

instance

memberof

Color

Returns string

This color as a CSS-HEX string.

cssHSL

cssHSL(): string

- Defined in src/ts/utils/datastructures/Color.ts:220
Get this color as a CSS hsl string.

method

cssHSL

instance

memberof

Color

Returns string

This color as a CSS hsl string.

cssHSLA

cssHSLA(): string

- Defined in src/ts/utils/datastructures/Color.ts:232
Get this color as a CSS hsla string.

method

cssHSLA

instance

memberof

Color

Returns string

This color as a CSS hsla string.

cssRGB

cssRGB(): string

- Defined in src/ts/utils/datastructures/Color.ts:105
Get this color as a CSS rgb string.

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

method

cssRGB

instance

memberof

Color

Returns string

This color as a CSS rgb string.

cssRGBA

cssRGBA(): string

- Defined in src/ts/utils/datastructures/Color.ts:119
Get this color as a CSS rgba string.

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

method

cssRGBA

instance

memberof

Color

Returns string

This color as a CSS rgba string.

darken

darken(v: string | number): Color

- Defined in src/ts/utils/datastructures/Color.ts:409
Parameters
- v: string | number
Returns Color

desaturate

desaturate(v: string | number): Color

- Defined in src/ts/utils/datastructures/Color.ts:352
Parameters
- v: string | number
Returns Color

fadein

fadein(v: string | number): Color

- Defined in src/ts/utils/datastructures/Color.ts:428
Parameters
- v: string | number
Returns Color

fadeout

fadeout(v: string | number): Color

- Defined in src/ts/utils/datastructures/Color.ts:448
Parameters
- v: string | number
Returns Color

green

green(): number

- Defined in src/ts/utils/datastructures/Color.ts:143
Get the green component of this RGB(A) color. This method just returns the g color attribute.

method

green

instance

memberof

Color

Returns number

A value between 0.0 and 1.0.

hue

hue(): number

- Defined in src/ts/utils/datastructures/Color.ts:254
Get the hue component of this HSL(A) color. This method just returns the h color attribute.

method

hue

instance

memberof

Color

Returns number

A value between 0.0 and 1.0.

interpolate

interpolate(c: Color, t: number): Color

- Defined in src/ts/utils/datastructures/Color.ts:741
Interpolate this color on the RGB scale.

method

interpolate

instance

memberof

Color

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).

lighten

lighten(v: string | number): Color

- Defined in src/ts/utils/datastructures/Color.ts:390
Parameters
- v: string | number
Returns Color

lightness

lightness(): number

- Defined in src/ts/utils/datastructures/Color.ts:278
Get the lightness component of this HSL(A) color. This method just returns the l color attribute.

method

lightness

instance

memberof

Color

Returns number

A value between 0.0 and 1.0.

red

red(): number

- Defined in src/ts/utils/datastructures/Color.ts:131
Get the red component of this RGB(A)color. This method just returns the r color attribute.

method

red

instance

memberof

Color

Returns number

A value between 0.0 and 1.0.

saturate

saturate(v: string | number): Color

- Defined in src/ts/utils/datastructures/Color.ts:333
Parameters
- v: string | number
Returns Color

saturation

saturation(): number

- Defined in src/ts/utils/datastructures/Color.ts:266
Get the saturation component of this HSL(A) color. This method just returns the s color attribute.

method

saturation

instance

memberof

Color

Returns number

A value between 0.0 and 1.0.

set

set(color: Color): Color

- Defined in src/ts/utils/datastructures/Color.ts:159
Parameters
- color: Color
Returns Color

setAlpha

setAlpha(a: number): this

- Defined in src/ts/utils/datastructures/Color.ts:181
Parameters
- a: number
Returns this

setBlue

setBlue(b: number): this

- Defined in src/ts/utils/datastructures/Color.ts:175
Parameters
- b: number
Returns this

setGreen

setGreen(g: number): this

- Defined in src/ts/utils/datastructures/Color.ts:187
Parameters
- g: number
Returns this

setHue

setHue(h: number): this

- Defined in src/ts/utils/datastructures/Color.ts:193
Parameters
- h: number
Returns this

setLuminance

setLuminance(l: number): this

- Defined in src/ts/utils/datastructures/Color.ts:205
Parameters
- l: number
Returns this

setRed

setRed(r: number): this

- Defined in src/ts/utils/datastructures/Color.ts:170
Parameters
- r: number
Returns this

setSaturation

setSaturation(s: number): this

- Defined in src/ts/utils/datastructures/Color.ts:199
Parameters
- s: number
Returns this

spin

spin(v: string | number): Color

- Defined in src/ts/utils/datastructures/Color.ts:467
Parameters
- v: string | number
Returns Color

Static makeHEX

makeHEX(value: string): Color

- Defined in src/ts/utils/datastructures/Color.ts:510
Parameters
- value: string
Returns Color

Static makeHSL

makeHSL(...args: Array<number | string>): Color

- Defined in src/ts/utils/datastructures/Color.ts:496
Parameters
- Rest ...args: Array<number | string>
Returns Color

Static makeRGB

makeRGB(...args: any[]): Color

- Defined in src/ts/utils/datastructures/Color.ts:479
Parameters
- Rest ...args: any[]
Returns Color

Static parse

parse(str: string): Color | null

- Defined in src/ts/utils/datastructures/Color.ts:547
Parse the given color string. Currently only these formate are recognized: hex, rgb, rgba.

method

parse

static

memberof

Color

Parameters
- str: string
  
  The string representation to parse.
Returns Color | null

The color instance that's represented by the given string.

Object literals

Static Private Converter

Converter: object

HSLToRGB

HSLToRGB(color: Color): void

- Defined in src/ts/utils/datastructures/Color.ts:685
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

Parameters
- color: Color
Returns void

RGBToHSL

RGBToHSL(color: Color): void

- Defined in src/ts/utils/datastructures/Color.ts:652
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

Parameters
- color: Color
Returns void

hue2rgb

hue2rgb(p: number, q: number, t: number): number

- Defined in src/ts/utils/datastructures/Color.ts:700
Parameters
- p: number
- q: number
- t: number
Returns number

Static Private Sanitizer

Sanitizer: object

HSL

HSL(...args: Array<string | number>): Array<number>

- Defined in src/ts/utils/datastructures/Color.ts:608
Parameters
- Rest ...args: Array<string | number>
Returns Array<number>

RGB

RGB(...args: any[]): number[]

- Defined in src/ts/utils/datastructures/Color.ts:573
Parameters
- Rest ...args: any[]
Returns number[]

Static Private Validator

Validator: object

checkHEX

checkHEX(value: string): void

- Defined in src/ts/utils/datastructures/Color.ts:634
Check a hexa color (without #)

Parameters
- value: string
Returns void

Generated using TypeDoc