Class DHTMLSuite.colorUtil

Object
   |
   +--DHTMLSuite.colorUtil

class DHTMLSuite.colorUtil

This class provides some methods for working with colors.
Defined in dhtml-suite-for-applications.js

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

Constructor Detail

DHTMLSuite.colorUtil

DHTMLSuite.colorUtil()

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

baseConverter

String baseConverter(numberToConvert,oldBase,newBase)

converts numbers from different number systems(DHTMLSuite.colorUtil.prototype.example = Decimal;to octal)

Parameters:
mixed - numberToConvert - Number to convert
int - oldBase - Convert from which base(8 = octal, 10 = decimal, 16 = hexadecimal)
int - newBase - Convert to which base(8 = octal, 10 = decimal, 16 = hexadecimal)

Returns:
String number in new base.(DHTMLSuite.colorUtil.prototype.Example = decimal;"16" returns "F" when converted to hexadecimal)

findColorByBrightness

String findColorByBrightness(rgbColor,brightness)

Returns a new rgb color after change of brightness

Parameters:
String - rgbColor - RGB start color
Int - brightness - Change in brightness (value between -100 and 100)

Returns:
String RGBColor - new rgb color - example #FF00FF

getAllNamedColors

Array getAllNamedColors()

This method returns an array of all web colors

Returns:
Array Colors - Returns a multi dimensional array of colors, first index separate each color. Each item in the main array will then contain two DHTMLSuite.colorUtil.prototype.values = 1;) color name, 2) rgb code

getAllWebColors

String getAllWebColors()

This method returns an array of all web colors

Returns:
Array RGBColors - Numeric array of all web colors (216 colors)

getAnalogicColors

String getAnalogicColors(rgbCode,degrees)

Return getAnalogicColors colors of an rgb code. Analogic colors will return 4 colors, two evenly distanced on both sides of the input color. You can specify distance by sending in a second argument to this method. Default is 25.

Parameters:
String - inputRgb - Rgb code
Integer - degrees - Degrees on the color wheel between colors(value between 15 and 30)

Returns:
Array colors - Array of triade colors

getColorByDegrees

String getColorByDegrees(rgbColor,degrees)

Returns RGB color from a position on the color wheel

Parameters:
String - rgbColor - Rgb color to calculate degrees from
Float - degrees - How many degrees to move on the color wheel(clockwise)

Returns:
String RGBColor - new rgb color - example #FF00FF

getContrastColorByRgb

String getContrastColorByRgb(rgbCode)

Return the rgb code of a complementary color

Parameters:
String - inputRgb - Rgb code

Returns:
String rgbCode - Complementary color

getHsvByRgbCode

Array getHsvByRgbCode(rgbColor)

Converts a RGB color to HSV

Parameters:
String - rgbColor - Example: #FF12AB or FF12AB

Returns:
Array H,S,B = Hue, Saturation and Brightness

getRgbCodeByHsv

String getRgbCodeByHsv(hue,saturation,valueBrightness)

Converts a RGB color to HSV

Parameters:
Int - hue - Degrees - Position on color wheel. Value between 0 and 359
float - saturation - Intensity of color(value between 0 and 1)
float - valueBrightness - Brightness(value between 0 and 1)

Returns:
String RGBColor - example #FF00FF

getRgbCodeByRgbColors

String getRgbCodeByRgbColors(red,green,blue)

Return an rgb code from numeric red,green and blue

Parameters:
Int - red - (0 - 255)
int - green - ( 0 - 255)
int - blue - (0-255)

Returns:
Array RGB - Returns an associative array of the keys red,green,blue, example myColor['red'] or myColor.red)

getRgbColorsByHsv

String getRgbColorsByHsv(hue,saturation,valueBrightness)

Return an array of red,green and blue from hue,saturation and brightness

Parameters:
Int - hue - Degrees - Position on color wheel. Value between 0 and 359
float - saturation - Intensity of color(value between 0 and 1)
float - valueBrightness - Brightness(value between 0 and 1)

Returns:
Array RGB - Returns an associative array of the keys red,green,blue, example myColor['red'] or myColor.red)

getRgbColorsByRgbCode

Array getRgbColorsByRgbCode(rgbCode)

Return an rgb code from numeric red,green and blue

Parameters:
String - rgbCode in the format RRGGBB ( NO # as prefix)

Returns:
Array RGB - Returns an associative array of the keys red,green,blue, example myColor['red'] or myColor.red)

getRgbFromNumbers

String getRgbFromNumbers(red,green,blue)

Returns a color in RGB format(e.g.: #FFEECC from numeric values of red, green and blue)

Parameters:
Int - red - Amount of red(0-255)
Int - green - Amount of green(0-255)
Int - blue - Amount of blue(0-255)

Returns:
String RGBColor - new rgb color - example #FF00FF

getTetradeColorsByRgb

String getTetradeColorsByRgb(rgbCode)

Return tetrade colors of an rgb code. Triade colors are 4 colors located 90 degrees from each other on the color wheel. This method will return the 3 tetrade colors for the input color

Parameters:
String - inputRgb - Rgb code

Returns:
Array colors - Array of triade colors

getTriadeColorsByRgb

String getTriadeColorsByRgb(rgbCode)

Return triade colors of an rgb code. Triade colors are 3 colors located 120 degrees from each other on the color wheel. This method will return the 2 triade colors for the input color

Parameters:
String - inputRgb - Rgb code

Returns:
Array colors - Array of triade colors