API Docs for: v2.1.0
Show:

CGSGColor Class

Defined in: src\utils\util.color.js:26
Module: Util

Some utils methods extending the Array prototype

Methods

_toHex

(
  • n
)
String private

Defined in src\utils\util.color.js:67

Parameters:

  • n String

    String or Number representation of a number between 0 and 255

Returns:

String:

Example "A6"

darkenHex

(
  • hex
  • factor
)
String

Defined in src\utils\util.color.js:125

Parameters:

  • hex String

    Hexadecimal value of a color (with or without the started '#'

  • factor Number

    If >0 : lighten. If <0 : darken

Returns:

String:

darkenRGB

(
  • r
  • g
  • b
  • factor
)
Object

Defined in src\utils\util.color.js:142

Parameters:

  • r Number

    Red value between 0 and 255

  • g Number

    Green value between 0 and 255

  • b Number

    Blue value between 0 and 255

  • factor Number

    If >0 : lighten. If <0 : darken

Returns:

Object:

An {r, g, b} object

fromString

(
  • rgb
)

Defined in src\utils\util.color.js:83

Convert a String to an {r,g, b} object.

Parameters:

Returns:

:

Example:

CGSGColor.fromString("rgb(121, 333, 444)"); returns {r:121, b:333, c:444};

hex2rgb

(
  • hex
)
Object static

Defined in src\utils\util.color.js:48

Convert an hexadecimal code for color to R, G and B

Parameters:

  • hex String

    an hexadecimal code, with or without the starting sharp (#)

Returns:

Object:

an object encapsulating r, g and b values (from 0 to 255)

hsl2rgb

(
  • h
  • s
  • l
)
Object

Defined in src\utils\util.color.js:250

HSL to RGB converter. Adapted from http://en.wikipedia.org/wiki/HSL_color_space

Parameters:

Returns:

Object:

A {r, g, b} object

hsv2rgb

(
  • h
  • s
  • v
)
Object

Defined in src\utils\util.color.js:295

HSV to RGB converter. Adapted from http://en.wikipedia.org/wiki/HSV_color_space

Parameters:

Returns:

Object:

A {r, g, b} object

hue2rgb

(
  • p
  • q
  • t
)

Defined in src\utils\util.color.js:278

Parameters:

Returns:

:

lerp

(
  • colorFrom
  • colorTo
  • weight
)
String static

Defined in src\utils\util.color.js:104

Linear interpolation between 2 colors

Parameters:

Returns:

String:

a heh value for the interpolated color

multiplyComponent

(
  • c
  • factor
)
Number

Defined in src\utils\util.color.js:167

Parameters:

Returns:

Number:

The multiplied value, between 0 and 255

rgb2hex

(
  • r
  • g
  • b
)
String static

Defined in src\utils\util.color.js:35

Convert R, G and B value to an hexadecimal code

Parameters:

  • r String

    red value. from 0 to 255.

  • g String

    green value. from 0 to 255.

  • b String

    blue value. from 0 to 255.

Returns:

String:

an hexadecimal value for the color, starting with a sharp (#)

rgb2hsl

(
  • r
  • g
  • b
)
Object

Defined in src\utils\util.color.js:213

RGB to HSL converter. Adapted from http://en.wikipedia.org/wiki/HSL_color_space

Parameters:

Returns:

Object:

rgb2hsv

(
  • r
  • g
  • b
)
Object

Defined in src\utils\util.color.js:177

RGB to HSV converter. Adapted from http://en.wikipedia.org/wiki/HSV_color_space

Parameters:

Returns:

Object:

An {h, s, v} object