Class vimdaloo.color.Color

Class Hierarchy

Details

Represents a color.

API

Synopsis

Functions
Color()

constructor

getNames()

names getter

getNumbers()

numbers getter

cmyk()

provides the CMYK color values

hex()

provides the HEX color formats

hsb()

provides the HSB color values

hsl()

provides the HSL color values

hsv()

provides the HSV color values

hwb()

provides the HWB color values

ncol()

provides the NCol color representation

rgb()

provides the RGB color values

toString()

full version string; overrides vimdaloo.lang.Object:toString()

Color(self, value, names, numbers)

constructor

Parameters
self ()
value (value)
names (names)

(optional)

numbers (numbers)

(optional)

Return Values
(vimdaloo.color.Color)
getNames(self)

names getter

Return Values
(table)

the color names, if known

getNumbers(self)

numbers getter

Return Values
(table)

the color numbers, if known

cmyk(self, exact)

provides the CMYK color values

Parameters
self ()
exact (boolean)
Return Values
(table)

the CMYK color table

hex(self)

provides the HEX color formats

Return Values
(table)

the HEX color formats

hsb(self, exact)

provides the HSB color values

Parameters
self ()
exact (boolean)

(optional, defaults to false)

Return Values
(table)

the HSB color table

hsl(self, exact)

provides the HSL color values

Parameters
self ()
exact (boolean)

(optional, defaults to false)

Return Values
(table)

the HSL color table

hsv(self, exact)

provides the HSV color values

Parameters
self ()
exact (boolean)

(optional, defaults to false)

Return Values
(table)

the HSV color table

hwb(self, exact)

provides the HWB color values

Parameters
self ()
exact (boolean)

(optional, defaults to false)

Return Values
(table)

the HWB color table

ncol(self)

provides the NCol color representation

Parameters
self ()
Return Values
(string)

the NCol color representation

rgb(self, exact, percent)

provides the RGB color values

Parameters
self ()
exact (boolean)

(optional, defaults to false)

percent (boolean)

(optional, defaults to false)

Return Values
(table)

the RGB color table

toString(self, exact, rgb_percent)

full version string; overrides vimdaloo.lang.Object:toString()

Parameters
self ()
exact (boolean)

(optional, defaults to false)

rgb_percent (boolean)

(optional defaults to false)

Return Values
(string)

the string form