docs/output/Ext.draw.Color.js

   1 Ext.data.JsonP.Ext_draw_Color({
   2   "tagname": "class",
   3   "name": "Ext.draw.Color",
   4   "doc": "<p>Represents an RGB color and provides helper functions get\ncolor components in HSL color space.</p>\n",
   5   "extends": "Object",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "lightnessFactor",
  21       "member": "Ext.draw.Color",
  22       "type": "Number",
  23       "doc": "<p>The default factor to compute the lighter or darker color. Defaults to 0.2.</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
  26       "linenr": 18,
  27       "html_filename": "Color2.html",
  28       "href": "Color2.html#Ext-draw-Color-cfg-lightnessFactor"
  29     }
  30   ],
  31   "method": [
  32     {
  33       "tagname": "method",
  34       "name": "Color",
  35       "member": "Ext.draw.Color",
  36       "doc": "\n",
  37       "params": [
  38         {
  39           "type": "Number",
  40           "name": "red",
  41           "doc": "<p>Red component (0..255)</p>\n",
  42           "optional": false
  43         },
  44         {
  45           "type": "Number",
  46           "name": "green",
  47           "doc": "<p>Green component (0..255)</p>\n",
  48           "optional": false
  49         },
  50         {
  51           "type": "Number",
  52           "name": "blue",
  53           "doc": "<p>Blue component (0..255)</p>\n",
  54           "optional": false
  55         }
  56       ],
  57       "return": {
  58         "type": "void",
  59         "doc": "\n"
  60       },
  61       "private": false,
  62       "static": false,
  63       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
  64       "linenr": 25,
  65       "html_filename": "Color2.html",
  66       "href": "Color2.html#Ext-draw-Color-method-constructor",
  67       "shortDoc": "\n"
  68     },
  69     {
  70       "tagname": "method",
  71       "name": "fromHSL",
  72       "member": "Ext.draw.Color",
  73       "doc": "<p>Create a new color based on the specified HSL values.</p>\n",
  74       "params": [
  75         {
  76           "type": "Number",
  77           "name": "h",
  78           "doc": "<p>Hue component (0..359)</p>\n",
  79           "optional": false
  80         },
  81         {
  82           "type": "Number",
  83           "name": "s",
  84           "doc": "<p>Saturation component (0..1)</p>\n",
  85           "optional": false
  86         },
  87         {
  88           "type": "Number",
  89           "name": "l",
  90           "doc": "<p>Lightness component (0..1)</p>\n",
  91           "optional": false
  92         }
  93       ],
  94       "return": {
  95         "type": "void",
  96         "doc": "<p>Ext.draw.Color</p>\n"
  97       },
  98       "private": false,
  99       "static": false,
 100       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 101       "linenr": 228,
 102       "html_filename": "Color2.html",
 103       "href": "Color2.html#Ext-draw-Color-method-fromHSL",
 104       "shortDoc": "<p>Create a new color based on the specified HSL values.</p>\n"
 105     },
 106     {
 107       "tagname": "method",
 108       "name": "fromString",
 109       "member": "Ext.draw.Color",
 110       "doc": "<p>Parse the string and create a new color.</p>\n\n<p>Supported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'.</p>\n\n<p>If the string is not recognized, an undefined will be returned instead.</p>\n",
 111       "params": [
 112         {
 113           "type": "String",
 114           "name": "str",
 115           "doc": "<p>Color in string.</p>\n",
 116           "optional": false
 117         }
 118       ],
 119       "return": {
 120         "type": "void",
 121         "doc": "<p>Ext.draw.Color</p>\n"
 122       },
 123       "private": false,
 124       "static": false,
 125       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 126       "linenr": 177,
 127       "html_filename": "Color2.html",
 128       "href": "Color2.html#Ext-draw-Color-method-fromString",
 129       "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..."
 130     },
 131     {
 132       "tagname": "method",
 133       "name": "getBlue",
 134       "member": "Ext.draw.Color",
 135       "doc": "<p>Get the blue component of the color, in the range 0..255.</p>\n",
 136       "params": [
 137
 138       ],
 139       "return": {
 140         "type": "Number",
 141         "doc": "\n"
 142       },
 143       "private": false,
 144       "static": false,
 145       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 146       "linenr": 55,
 147       "html_filename": "Color2.html",
 148       "href": "Color2.html#Ext-draw-Color-method-getBlue",
 149       "shortDoc": "<p>Get the blue component of the color, in the range 0..255.</p>\n"
 150     },
 151     {
 152       "tagname": "method",
 153       "name": "getDarker",
 154       "member": "Ext.draw.Color",
 155       "doc": "<p>Return a new color that is darker than this color.</p>\n",
 156       "params": [
 157         {
 158           "type": "Number",
 159           "name": "factor",
 160           "doc": "<p>Darker factor (0..1), default to 0.2</p>\n",
 161           "optional": false
 162         }
 163       ],
 164       "return": {
 165         "type": "void",
 166         "doc": "<p>Ext.draw.Color</p>\n"
 167       },
 168       "private": false,
 169       "static": false,
 170       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 171       "linenr": 120,
 172       "html_filename": "Color2.html",
 173       "href": "Color2.html#Ext-draw-Color-method-getDarker",
 174       "shortDoc": "<p>Return a new color that is darker than this color.</p>\n"
 175     },
 176     {
 177       "tagname": "method",
 178       "name": "getGrayscale",
 179       "member": "Ext.draw.Color",
 180       "doc": "<p>Returns the gray value (0 to 255) of the color.</p>\n\n<p>The gray value is calculated using the formula r<em>0.3 + g</em>0.59 + b*0.11.</p>\n",
 181       "params": [
 182
 183       ],
 184       "return": {
 185         "type": "Number",
 186         "doc": "\n"
 187       },
 188       "private": false,
 189       "static": false,
 190       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 191       "linenr": 216,
 192       "html_filename": "Color2.html",
 193       "href": "Color2.html#Ext-draw-Color-method-getGrayscale",
 194       "shortDoc": "<p>Returns the gray value (0 to 255) of the color.</p>\n\n<p>The gray value is calculated using the formula r<em>0.3 + g</em>0.59 + b*0.11.</p>\n"
 195     },
 196     {
 197       "tagname": "method",
 198       "name": "getGreen",
 199       "member": "Ext.draw.Color",
 200       "doc": "<p>Get the green component of the color, in the range 0..255.</p>\n",
 201       "params": [
 202
 203       ],
 204       "return": {
 205         "type": "Number",
 206         "doc": "\n"
 207       },
 208       "private": false,
 209       "static": false,
 210       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 211       "linenr": 47,
 212       "html_filename": "Color2.html",
 213       "href": "Color2.html#Ext-draw-Color-method-getGreen",
 214       "shortDoc": "<p>Get the green component of the color, in the range 0..255.</p>\n"
 215     },
 216     {
 217       "tagname": "method",
 218       "name": "getHSL",
 219       "member": "Ext.draw.Color",
 220       "doc": "<p>Get the equivalent HSL components of the color.</p>\n",
 221       "params": [
 222
 223       ],
 224       "return": {
 225         "type": "Array",
 226         "doc": "\n"
 227       },
 228       "private": false,
 229       "static": false,
 230       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 231       "linenr": 72,
 232       "html_filename": "Color2.html",
 233       "href": "Color2.html#Ext-draw-Color-method-getHSL",
 234       "shortDoc": "<p>Get the equivalent HSL components of the color.</p>\n"
 235     },
 236     {
 237       "tagname": "method",
 238       "name": "getLighter",
 239       "member": "Ext.draw.Color",
 240       "doc": "<p>Return a new color that is lighter than this color.</p>\n",
 241       "params": [
 242         {
 243           "type": "Number",
 244           "name": "factor",
 245           "doc": "<p>Lighter factor (0..1), default to 0.2</p>\n",
 246           "optional": false
 247         }
 248       ],
 249       "return": {
 250         "type": "void",
 251         "doc": "<p>Ext.draw.Color</p>\n"
 252       },
 253       "private": false,
 254       "static": false,
 255       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 256       "linenr": 108,
 257       "html_filename": "Color2.html",
 258       "href": "Color2.html#Ext-draw-Color-method-getLighter",
 259       "shortDoc": "<p>Return a new color that is lighter than this color.</p>\n"
 260     },
 261     {
 262       "tagname": "method",
 263       "name": "getRGB",
 264       "member": "Ext.draw.Color",
 265       "doc": "<p>Get the RGB values.</p>\n",
 266       "params": [
 267
 268       ],
 269       "return": {
 270         "type": "Array",
 271         "doc": "\n"
 272       },
 273       "private": false,
 274       "static": false,
 275       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 276       "linenr": 63,
 277       "html_filename": "Color2.html",
 278       "href": "Color2.html#Ext-draw-Color-method-getRGB",
 279       "shortDoc": "<p>Get the RGB values.</p>\n"
 280     },
 281     {
 282       "tagname": "method",
 283       "name": "getRed",
 284       "member": "Ext.draw.Color",
 285       "doc": "<p>Get the red component of the color, in the range 0..255.</p>\n",
 286       "params": [
 287
 288       ],
 289       "return": {
 290         "type": "Number",
 291         "doc": "\n"
 292       },
 293       "private": false,
 294       "static": false,
 295       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 296       "linenr": 39,
 297       "html_filename": "Color2.html",
 298       "href": "Color2.html#Ext-draw-Color-method-getRed",
 299       "shortDoc": "<p>Get the red component of the color, in the range 0..255.</p>\n"
 300     },
 301     {
 302       "tagname": "method",
 303       "name": "toHex",
 304       "member": "Ext.draw.Color",
 305       "doc": "<p>Convert a color to hexadecimal format.</p>\n",
 306       "params": [
 307         {
 308           "type": "String|Array",
 309           "name": "color",
 310           "doc": "<p>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.</p>\n",
 311           "optional": false
 312         }
 313       ],
 314       "return": {
 315         "type": "String",
 316         "doc": "<p>The color in hexadecimal format.</p>\n"
 317       },
 318       "private": false,
 319       "static": false,
 320       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 321       "linenr": 146,
 322       "html_filename": "Color2.html",
 323       "href": "Color2.html#Ext-draw-Color-method-toHex",
 324       "shortDoc": "<p>Convert a color to hexadecimal format.</p>\n"
 325     },
 326     {
 327       "tagname": "method",
 328       "name": "toString",
 329       "member": "Ext.draw.Color",
 330       "doc": "<p>Return the color in the hex format, i.e. '#rrggbb'.</p>\n",
 331       "params": [
 332
 333       ],
 334       "return": {
 335         "type": "String",
 336         "doc": "\n"
 337       },
 338       "private": false,
 339       "static": false,
 340       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 341       "linenr": 130,
 342       "html_filename": "Color2.html",
 343       "href": "Color2.html#Ext-draw-Color-method-toString",
 344       "shortDoc": "<p>Return the color in the hex format, i.e. '#rrggbb'.</p>\n"
 345     }
 346   ],
 347   "property": [
 348
 349   ],
 350   "event": [
 351
 352   ],
 353   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Color.js",
 354   "linenr": 1,
 355   "html_filename": "Color2.html",
 356   "href": "Color2.html#Ext-draw-Color",
 357   "cssVar": [
 358
 359   ],
 360   "cssMixin": [
 361
 362   ],
 363   "component": false,
 364   "superclasses": [
 365
 366   ],
 367   "subclasses": [
 368
 369   ],
 370   "mixedInto": [
 371
 372   ],
 373   "allMixins": [
 374
 375   ]
 376 });