JSDoc: Class: ColorConverter

Constructor

new ColorConverter()

Source:

ColorConverter.js, line 13

Methods

AddReferenceColorByCIELAB(system, name, description, L, a, b)

Add a reference color

Parameters:

Name	Type	Description
`system`	string
`name`	string
`description`	string
`L`	number
`a`	number
`b`	number

Source:

ColorConverter.js, line 191

AddReferenceColorByCMYK(system, name, description, c, m, y, k)

Add a reference color

Parameters:

Name	Type	Description
`system`	string
`name`	string
`description`	string
`c`	number
`m`	number
`y`	number
`k`	number

Source:

ColorConverter.js, line 207

AddReferenceColorByHEX(system, name, description, hex)

Add a reference color

Parameters:

Name	Type	Description
`system`	string
`name`	string
`description`	string
`hex`	string

Source:

ColorConverter.js, line 220

AddReferenceColorByRGB(system, name, description, r, g, b)

Add a reference color

Parameters:

Name	Type	Description
`system`	string
`name`	string
`description`	string
`r`	number
`g`	number
`b`	number

Source:

ColorConverter.js, line 176

AddReferenceColorByXYZ(system, name, description, x, y, z)

Add a reference color

Parameters:

Name	Type	Description
`system`	string
`name`	string
`description`	string
`x`	number
`y`	number
`z`	number

Source:

ColorConverter.js, line 235

ConvertCIELAB(L, a, b, observer1, observer2) → {Promise}

Convert from CIELAB using illumination and observer angles

Parameters:

Name	Type	Description
`L`	number
`a`	number
`b`	number
`observer1`	string
`observer2`	string

Source:

ColorConverter.js, line 113

Returns:

Promise will resolve to type array.

Type: Promise

ConvertCMYK(c, m, y, k, observer1, observer2) → {Promise}

Convert from CMYK using illumination and observer angles

Parameters:

Name	Type	Description
`c`	number
`m`	number
`y`	number
`k`	number
`observer1`	string
`observer2`	string

Source:

ColorConverter.js, line 130

Returns:

Promise will resolve to type array.

Type: Promise

ConvertHEX(hex, observer1, observer2) → {Promise}

Convert from HEX using illumination and observer angles

Parameters:

Name	Type	Description
`hex`	string
`observer1`	string
`observer2`	string

Source:

ColorConverter.js, line 144

Returns:

Promise will resolve to type array.

Type: Promise

ConvertRGB(r, g, b, observer1, observer2) → {Promise}

Convert from RGB using illumination and observer angles

Parameters:

Name	Type	Description
`r`	number
`g`	number
`b`	number
`observer1`	string
`observer2`	string

Source:

ColorConverter.js, line 97

Returns:

Promise will resolve to type array.

Type: Promise

ConvertXYZ(x, y, z, observer1, observer2) → {Promise}

Convert from XYZ using illumination and observer angles

Parameters:

Name	Type	Description
`x`	number
`y`	number
`z`	number
`observer1`	string
`observer2`	string

Source:

ColorConverter.js, line 160

Returns:

Promise will resolve to type array.

Type: Promise

FindReferenceColor(system, name) → {Promise}

Parameters:

Name	Type	Description
`system`	string
`name`	string

Source:

ColorConverter.js, line 316

Returns:

Promise will resolve to type array.

Type: Promise

FindReferenceColorByCIELAB(L, a, b) → {Promise}

Parameters:

Name	Type	Description
`L`	number
`a`	number
`b`	number

Source:

ColorConverter.js, line 262

Returns:

Promise will resolve to type array.

Type: Promise

FindReferenceColorByCMYK(c, m, y, k) → {Promise}

Parameters:

Name	Type	Description
`c`	number
`m`	number
`y`	number
`k`	number

Source:

ColorConverter.js, line 277

Returns:

Promise will resolve to type array.

Type: Promise

FindReferenceColorByHEX(hex) → {Promise}

Parameters:

Name	Type	Description
`hex`	string

Source:

ColorConverter.js, line 289

Returns:

Promise will resolve to type array.

Type: Promise

FindReferenceColorByRGB(r, g, b) → {Promise}

Parameters:

Name	Type	Description
`r`	number
`g`	number
`b`	number

Source:

ColorConverter.js, line 248

Returns:

Promise will resolve to type array.

Type: Promise

FindReferenceColorByXYZ(x, y, z) → {Promise}

Parameters:

Name	Type	Description
`x`	number
`y`	number
`z`	number

Source:

ColorConverter.js, line 303

Returns:

Promise will resolve to type array.

Type: Promise

FromCIELAB(L, a, b) → {Promise}

Convert from CIELAB

Parameters:

Name	Type	Description
`L`	number
`a`	number
`b`	number

Source:

ColorConverter.js, line 40

Returns:

Promise will resolve to type array.

Type: Promise

FromCMYK(c, m, y, k) → {Promise}

Convert from CMYK

Parameters:

Name	Type	Description
`c`	number
`m`	number
`y`	number
`k`	number

Source:

ColorConverter.js, line 55

Returns:

Promise will resolve to type array.

Type: Promise

FromHEX(hex) → {Promise}

Convert from HEX

Parameters:

Name	Type	Description
`hex`	string

Source:

ColorConverter.js, line 67

Returns:

Promise will resolve to type array.

Type: Promise

FromRGB(r, g, b) → {Promise}

Convert from RGB

Parameters:

Name	Type	Description
`r`	number
`g`	number
`b`	number

Source:

ColorConverter.js, line 26

Returns:

Promise will resolve to type array.

Type: Promise

FromXYZ(x, y, z) → {Promise}

Convert from XYZ

Parameters:

Name	Type	Description
`x`	number
`y`	number
`z`	number

Source:

ColorConverter.js, line 81

Returns:

Promise will resolve to type array.

Type: Promise

GetIlluminationObserverAngles() → {Promise}

Get supported illumination and observer angles

Source:

ColorConverter.js, line 360

Returns:

Promise will resolve to type array.

Type: Promise

GetReferenceColors(system) → {Promise}

Get all reference colors in a color reference system

Parameters:

Name	Type	Description
`system`	string

Source:

ColorConverter.js, line 349

Returns:

Promise will resolve to type array.

Type: Promise

GetReferenceColorSystems() → {Promise}

Get all reference color systems

Source:

ColorConverter.js, line 337

Returns:

Promise will resolve to type array.

Type: Promise

LoadReferenceColors(id)

Load reference colors

Parameters:

Name	Type	Description
`id`	string

Source:

ColorConverter.js, line 381

RemoveReferenceColorSystem(system)

Remove reference color system and all reference colors

Parameters:

Name	Type	Description
`system`	string

Source:

ColorConverter.js, line 327

SaveReferenceColors(id)

Save reference colors

Parameters:

Name	Type	Description
`id`	string

Source:

ColorConverter.js, line 371