User:Harthur/ColorConversion: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(delete page, doesn't belong at wiki.mozilla.org)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
= About =
download: [http://colorplay.googlecode.com/files/colorCommon.js colorCommon.js]


This is a javascript library for converting colors between different color formats. It supports rgb, hsl, and hsv. To call a method of the library simply say <tt>colorCommon.methodName()</tt>. Valid color strings can take one of the following formats: <tt>#00FF00</tt>, <tt>rgb(0, 255, 0)</tt>, <tt>rgb(0%, 100%, 0%)</tt>, <tt>hsl(120, 100%, 50%)</tt>, <tt>hsv(120, 100%, 100%)</tt>
= API =
=== toHex ===
gets a Hex string for a color
parameter:
* any valid color string
return:
* a string of the color in hex format
example:
<pre>colorCommon.toHex("hsl(142, 45%, 10%)")</pre>
=== toRgb ===
gets an Rgb string for a color
parameter:
* any valid color string
return:
* a string of the color in rgb format
example:
<pre>colorCommon.toRgb("hsv(230, 100%, 10%)")</pre>
=== toPercent ===
gets an Rgb string in percentile format for a color
parameter:
* any valid color string
return:
* a string of the color in rgb percentile format
example:
<pre>colorCommon.toRgb("#66CCE4")</pre>
=== toHsl ===
gets an hsl string for a color
parameter:
* any valid color string
return:
* a string of the color in hsl format
example:
<pre>colorCommon.toHsl("#66CCE4")</pre>
=== toHsv ===
gets an hsv string for a color
parameter:
* any valid color string
return:
* a string of the color in hsv format
example:
<pre>colorCommon.toHsv("#66CCE4")</pre>
=== rgbValues ===
gets the individual red, green, and blue values for a color string
parameter:
* any valid color string
return:
* an object with properties <tt>red</tt>, <tt>green</tt>, and <tt>blue</tt>
example:
<pre>colorCommon.rgbValues("#66CCE4")["red"]</pre>
=== hslValues ===
gets the individual hue, saturation, and lightness values for a color string
parameter:
* any valid color string
return:
* an object with properties <tt>hue</tt>, <tt>sat</tt>, and <tt>light</tt>
example:
<pre>colorCommon.hslValues("#66CCE4")["light"]</pre>
=== hsvValues ===
gets the individual hue, saturation, and value values for a color string
parameter:
* any valid color string
return:
* an object with properties <tt>hue</tt>, <tt>satv</tt>, and <tt>val</tt>
example:
<pre>colorCommon.hsvValues("#66CCE4")["satv"]</pre>
=== isValid ===
reports whether a color string is a valid color
parameter:
* any color string
return:
* <tt>true</tt> if it is a valid color, <tt>false</tt> otherwise
example:
<pre>colorCommon.isValid("rgb(4000,,)")</pre>
=== isValid ===
reports whether a color string is a valid color
parameter:
* any color string
return:
* <tt>true</tt> if it is a valid color, <tt>false</tt> otherwise
example:
<pre>colorCommon.isValid("rgb(4000,,)")</pre>
=== luminosity ===
gets the WCAG luminosity for a color.
parameter:
* any valid color string
return:
* a decimal number from 0 to 1 (0 is black, 1 is white)
example:
<pre>colorCommon.luminosity("#445590")</pre>
=== contrast ===
gets the WCAG luminosity contrast ratio for a color.
parameter:
* any valid color string
return:
* a decimal number from 0 to 21 (4.5 is considered minimum for text/background ratio, 7 is good, and 10+ is excellent)
example:
<pre>colorCommon.contrast("hsl(46, 100%, 34%)", "#445590")</pre>

Latest revision as of 22:39, 28 July 2010

Retrieved from "https://dev.wikimo.nonprod.webservices.mozgcp.net/index.php?title=User:Harthur/ColorConversion&oldid=241877"