X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.draw.Color.js diff --git a/docs/output/Ext.draw.Color.js b/docs/output/Ext.draw.Color.js new file mode 100644 index 00000000..fd94c657 --- /dev/null +++ b/docs/output/Ext.draw.Color.js @@ -0,0 +1,376 @@ +Ext.data.JsonP.Ext_draw_Color({ + "tagname": "class", + "name": "Ext.draw.Color", + "doc": "

Represents an RGB color and provides helper functions get\ncolor components in HSL color space.

\n", + "extends": "Object", + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + { + "tagname": "cfg", + "name": "lightnessFactor", + "member": "Ext.draw.Color", + "type": "Number", + "doc": "

The default factor to compute the lighter or darker color. Defaults to 0.2.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 18, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-cfg-lightnessFactor" + } + ], + "method": [ + { + "tagname": "method", + "name": "Color", + "member": "Ext.draw.Color", + "doc": "\n", + "params": [ + { + "type": "Number", + "name": "red", + "doc": "

Red component (0..255)

\n", + "optional": false + }, + { + "type": "Number", + "name": "green", + "doc": "

Green component (0..255)

\n", + "optional": false + }, + { + "type": "Number", + "name": "blue", + "doc": "

Blue component (0..255)

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 25, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-constructor", + "shortDoc": "\n" + }, + { + "tagname": "method", + "name": "fromHSL", + "member": "Ext.draw.Color", + "doc": "

Create a new color based on the specified HSL values.

\n", + "params": [ + { + "type": "Number", + "name": "h", + "doc": "

Hue component (0..359)

\n", + "optional": false + }, + { + "type": "Number", + "name": "s", + "doc": "

Saturation component (0..1)

\n", + "optional": false + }, + { + "type": "Number", + "name": "l", + "doc": "

Lightness component (0..1)

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "

Ext.draw.Color

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 228, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-fromHSL", + "shortDoc": "

Create a new color based on the specified HSL values.

\n" + }, + { + "tagname": "method", + "name": "fromString", + "member": "Ext.draw.Color", + "doc": "

Parse the string and create a new color.

\n\n

Supported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'.

\n\n

If the string is not recognized, an undefined will be returned instead.

\n", + "params": [ + { + "type": "String", + "name": "str", + "doc": "

Color in string.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "

Ext.draw.Color

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 177, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-fromString", + "shortDoc": "Parse the string and create a new color.\n\nSupported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'.\n\nIf the string is n..." + }, + { + "tagname": "method", + "name": "getBlue", + "member": "Ext.draw.Color", + "doc": "

Get the blue component of the color, in the range 0..255.

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 55, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getBlue", + "shortDoc": "

Get the blue component of the color, in the range 0..255.

\n" + }, + { + "tagname": "method", + "name": "getDarker", + "member": "Ext.draw.Color", + "doc": "

Return a new color that is darker than this color.

\n", + "params": [ + { + "type": "Number", + "name": "factor", + "doc": "

Darker factor (0..1), default to 0.2

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "

Ext.draw.Color

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 120, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getDarker", + "shortDoc": "

Return a new color that is darker than this color.

\n" + }, + { + "tagname": "method", + "name": "getGrayscale", + "member": "Ext.draw.Color", + "doc": "

Returns the gray value (0 to 255) of the color.

\n\n

The gray value is calculated using the formula r0.3 + g0.59 + b*0.11.

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 216, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getGrayscale", + "shortDoc": "

Returns the gray value (0 to 255) of the color.

\n\n

The gray value is calculated using the formula r0.3 + g0.59 + b*0.11.

\n" + }, + { + "tagname": "method", + "name": "getGreen", + "member": "Ext.draw.Color", + "doc": "

Get the green component of the color, in the range 0..255.

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 47, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getGreen", + "shortDoc": "

Get the green component of the color, in the range 0..255.

\n" + }, + { + "tagname": "method", + "name": "getHSL", + "member": "Ext.draw.Color", + "doc": "

Get the equivalent HSL components of the color.

\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 72, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getHSL", + "shortDoc": "

Get the equivalent HSL components of the color.

\n" + }, + { + "tagname": "method", + "name": "getLighter", + "member": "Ext.draw.Color", + "doc": "

Return a new color that is lighter than this color.

\n", + "params": [ + { + "type": "Number", + "name": "factor", + "doc": "

Lighter factor (0..1), default to 0.2

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "

Ext.draw.Color

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 108, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getLighter", + "shortDoc": "

Return a new color that is lighter than this color.

\n" + }, + { + "tagname": "method", + "name": "getRGB", + "member": "Ext.draw.Color", + "doc": "

Get the RGB values.

\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 63, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getRGB", + "shortDoc": "

Get the RGB values.

\n" + }, + { + "tagname": "method", + "name": "getRed", + "member": "Ext.draw.Color", + "doc": "

Get the red component of the color, in the range 0..255.

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 39, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-getRed", + "shortDoc": "

Get the red component of the color, in the range 0..255.

\n" + }, + { + "tagname": "method", + "name": "toHex", + "member": "Ext.draw.Color", + "doc": "

Convert a color to hexadecimal format.

\n", + "params": [ + { + "type": "String|Array", + "name": "color", + "doc": "

The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff').\nCan also be an Array, in this case the function handles the first member.

\n", + "optional": false + } + ], + "return": { + "type": "String", + "doc": "

The color in hexadecimal format.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 146, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-toHex", + "shortDoc": "

Convert a color to hexadecimal format.

\n" + }, + { + "tagname": "method", + "name": "toString", + "member": "Ext.draw.Color", + "doc": "

Return the color in the hex format, i.e. '#rrggbb'.

\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 130, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color-method-toString", + "shortDoc": "

Return the color in the hex format, i.e. '#rrggbb'.

\n" + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js", + "linenr": 1, + "html_filename": "Color2.html", + "href": "Color2.html#Ext-draw-Color", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file