-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-draw.Color'>/**
-</span> * @class Ext.draw.Color
- * @extends Object
- *
- * Represents an RGB color and provides helper functions get
+<!DOCTYPE html>
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title>The source code</title>
+ <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+ <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+ <style type="text/css">
+ .highlight { display: block; background-color: #ddd; }
+ </style>
+ <script type="text/javascript">
+ function highlight() {
+ document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+ }
+ </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+ <pre class="prettyprint lang-js"><span id='Ext-draw-Color'>/**
+</span> * Represents an RGB color and provides helper functions get
* color components in HSL color space.
*/
Ext.define('Ext.draw.Color', {
rgbRe: /\s*rgb\s*\(\s*([0-9]+)\s*,\s*([0-9]+)\s*,\s*([0-9]+)\s*\)\s*/,
hexRe: /\s*#([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)\s*/,
-<span id='Ext-draw.Color-cfg-lightnessFactor'> /**
+<span id='Ext-draw-Color-cfg-lightnessFactor'> /**
</span> * @cfg {Number} lightnessFactor
*
* The default factor to compute the lighter or darker color. Defaults to 0.2.
*/
lightnessFactor: 0.2,
-<span id='Ext-draw.Color-method-constructor'> /**
-</span> * @constructor
+<span id='Ext-draw-Color-method-constructor'> /**
+</span> * Creates new Color.
* @param {Number} red Red component (0..255)
* @param {Number} green Green component (0..255)
* @param {Number} blue Blue component (0..255)
me.b = clamp(blue, 0, 255);
},
-<span id='Ext-draw.Color-method-getRed'> /**
+<span id='Ext-draw-Color-method-getRed'> /**
</span> * Get the red component of the color, in the range 0..255.
* @return {Number}
*/
return this.r;
},
-<span id='Ext-draw.Color-method-getGreen'> /**
+<span id='Ext-draw-Color-method-getGreen'> /**
</span> * Get the green component of the color, in the range 0..255.
* @return {Number}
*/
return this.g;
},
-<span id='Ext-draw.Color-method-getBlue'> /**
+<span id='Ext-draw-Color-method-getBlue'> /**
</span> * Get the blue component of the color, in the range 0..255.
* @return {Number}
*/
return this.b;
},
-<span id='Ext-draw.Color-method-getRGB'> /**
+<span id='Ext-draw-Color-method-getRGB'> /**
</span> * Get the RGB values.
- * @return {Array}
+ * @return {Number[]}
*/
getRGB: function() {
var me = this;
return [me.r, me.g, me.b];
},
-<span id='Ext-draw.Color-method-getHSL'> /**
+<span id='Ext-draw-Color-method-getHSL'> /**
</span> * Get the equivalent HSL components of the color.
- * @return {Array}
+ * @return {Number[]}
*/
getHSL: function() {
var me = this,
return [h, s, l];
},
-<span id='Ext-draw.Color-method-getLighter'> /**
+<span id='Ext-draw-Color-method-getLighter'> /**
</span> * Return a new color that is lighter than this color.
* @param {Number} factor Lighter factor (0..1), default to 0.2
* @return Ext.draw.Color
return this.fromHSL(hsl[0], hsl[1], hsl[2]);
},
-<span id='Ext-draw.Color-method-getDarker'> /**
+<span id='Ext-draw-Color-method-getDarker'> /**
</span> * Return a new color that is darker than this color.
* @param {Number} factor Darker factor (0..1), default to 0.2
* @return Ext.draw.Color
return this.getLighter(-factor);
},
-<span id='Ext-draw.Color-method-toString'> /**
+<span id='Ext-draw-Color-method-toString'> /**
</span> * Return the color in the hex format, i.e. '#rrggbb'.
* @return {String}
*/
return ['#', r, g, b].join('');
},
-<span id='Ext-draw.Color-method-toHex'> /**
+<span id='Ext-draw-Color-static-method-toHex'> /**
</span> * Convert a color to hexadecimal format.
*
- * @param {String|Array} color The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff').
+ * **Note:** This method is both static and instance.
+ *
+ * @param {String/String[]} color The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff').
* Can also be an Array, in this case the function handles the first member.
* @returns {String} The color in hexadecimal format.
+ * @static
*/
toHex: function(color) {
if (Ext.isArray(color)) {
}
},
-<span id='Ext-draw.Color-method-fromString'> /**
+<span id='Ext-draw-Color-static-method-fromString'> /**
</span> * Parse the string and create a new color.
*
* Supported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'.
*
* If the string is not recognized, an undefined will be returned instead.
*
+ * **Note:** This method is both static and instance.
+ *
* @param {String} str Color in string.
* @returns Ext.draw.Color
+ * @static
*/
fromString: function(str) {
var values, r, g, b,
return (typeof r == 'undefined') ? undefined : Ext.create('Ext.draw.Color', r, g, b);
},
-<span id='Ext-draw.Color-method-getGrayscale'> /**
+<span id='Ext-draw-Color-method-getGrayscale'> /**
</span> * Returns the gray value (0 to 255) of the color.
*
* The gray value is calculated using the formula r*0.3 + g*0.59 + b*0.11.
return this.r * 0.3 + this.g * 0.59 + this.b * 0.11;
},
-<span id='Ext-draw.Color-method-fromHSL'> /**
+<span id='Ext-draw-Color-static-method-fromHSL'> /**
</span> * Create a new color based on the specified HSL values.
+ *
+ * **Note:** This method is both static and instance.
*
* @param {Number} h Hue component (0..359)
* @param {Number} s Saturation component (0..1)
* @param {Number} l Lightness component (0..1)
* @returns Ext.draw.Color
+ * @static
*/
fromHSL: function(h, s, l) {
var C, X, m, i, rgb = [],
}
});
});
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>
git.ithinksw.org / extjs.git / blobdiff