git.roojs.org Git - roojs1/blob - docs/symbols/Roo.lib.HSVColor.json

   1 {
   2   "name" : "Roo.lib.HSVColor",
   3   "augments" : [
   4     "Roo.lib.Color"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [],
   8   "tree_parent" : [],
   9   "desc" : "Creates a Color specified in the HSV Color space, with an optional alpha\ncomponent. The parameters are:",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "isAbstract" : false,
  14   "isBuilderTop" : false,
  15   "memberOf" : "HSVColor",
  16   "example" : "",
  17   "deprecated" : "",
  18   "since" : "",
  19   "see" : "",
  20   "params" : [
  21     {
  22       "name" : "h",
  23       "type" : "Number",
  24       "desc" : "- the hue component, wrapped to the range [0,360)",
  25       "isOptional" : false
  26     },
  27     {
  28       "name" : "s",
  29       "type" : "Number",
  30       "desc" : "- the saturation component, clipped to the range [0,100]",
  31       "isOptional" : false
  32     },
  33     {
  34       "name" : "v",
  35       "type" : "Number",
  36       "desc" : "- the value component, clipped to the range [0,100]",
  37       "isOptional" : false
  38     },
  39     {
  40       "name" : "a",
  41       "type" : "Number",
  42       "desc" : "- the alpha component, clipped to the range [0,1] - this parameter is\n    optional and defaults to 1",
  43       "isOptional" : false
  44     }
  45   ],
  46   "returns" : [],
  47   "throws" : "",
  48   "requires" : "",
  49   "config" : [],
  50   "methods" : [
  51     {
  52       "name" : "getPercentageRGB",
  53       "type" : "function",
  54       "desc" : "getPercentageRGB",
  55       "sig" : "()\n{\n\n}",
  56       "static" : false,
  57       "memberOf" : "Roo.lib.Color",
  58       "isStatic" : false,
  59       "isConstructor" : false,
  60       "isPrivate" : false,
  61       "example" : "",
  62       "deprecated" : "",
  63       "since" : "",
  64       "see" : "",
  65       "exceptions" : "",
  66       "requires" : "",
  67       "params" : [],
  68       "returns" : [
  69         {
  70           "name" : "",
  71           "type" : "Object",
  72           "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
  73         }
  74       ]
  75     },
  76     {
  77       "name" : "getRGB",
  78       "type" : "function",
  79       "desc" : "getRGB",
  80       "sig" : "()\n{\n\n}",
  81       "static" : false,
  82       "memberOf" : "Roo.lib.Color",
  83       "isStatic" : false,
  84       "isConstructor" : false,
  85       "isPrivate" : false,
  86       "example" : "",
  87       "deprecated" : "",
  88       "since" : "",
  89       "see" : "",
  90       "exceptions" : "",
  91       "requires" : "",
  92       "params" : [],
  93       "returns" : [
  94         {
  95           "name" : "",
  96           "type" : "Object",
  97           "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
  98         }
  99       ]
 100     },
 101     {
 102       "name" : "getIntegerRGB",
 103       "type" : "function",
 104       "desc" : "getIntegerRGB",
 105       "sig" : "()\n{\n\n}",
 106       "static" : false,
 107       "memberOf" : "Roo.lib.Color",
 108       "isStatic" : false,
 109       "isConstructor" : false,
 110       "isPrivate" : false,
 111       "example" : "",
 112       "deprecated" : "",
 113       "since" : "",
 114       "see" : "",
 115       "exceptions" : "",
 116       "requires" : "",
 117       "params" : [],
 118       "returns" : [
 119         {
 120           "name" : "",
 121           "type" : "Object",
 122           "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
 123         }
 124       ]
 125     },
 126     {
 127       "name" : "getCSSIntegerRGBA",
 128       "type" : "function",
 129       "desc" : "getCSSIntegerRGBA",
 130       "sig" : "()\n{\n\n}",
 131       "static" : false,
 132       "memberOf" : "Roo.lib.Color",
 133       "isStatic" : false,
 134       "isConstructor" : false,
 135       "isPrivate" : false,
 136       "example" : "",
 137       "deprecated" : "",
 138       "since" : "",
 139       "see" : "",
 140       "exceptions" : "",
 141       "requires" : "",
 142       "params" : [],
 143       "returns" : [
 144         {
 145           "name" : "",
 146           "type" : "String",
 147           "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
 148         }
 149       ]
 150     },
 151     {
 152       "name" : "getCSSHSL",
 153       "type" : "function",
 154       "desc" : "getCSSHSL",
 155       "sig" : "()\n{\n\n}",
 156       "static" : false,
 157       "memberOf" : "Roo.lib.Color",
 158       "isStatic" : false,
 159       "isConstructor" : false,
 160       "isPrivate" : false,
 161       "example" : "",
 162       "deprecated" : "",
 163       "since" : "",
 164       "see" : "",
 165       "exceptions" : "",
 166       "requires" : "",
 167       "params" : [],
 168       "returns" : [
 169         {
 170           "name" : "",
 171           "type" : "String",
 172           "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
 173         }
 174       ]
 175     },
 176     {
 177       "name" : "getCSSHexadecimalRGB",
 178       "type" : "function",
 179       "desc" : "getCSSHexadecimalRGB",
 180       "sig" : "()\n{\n\n}",
 181       "static" : false,
 182       "memberOf" : "Roo.lib.Color",
 183       "isStatic" : false,
 184       "isConstructor" : false,
 185       "isPrivate" : false,
 186       "example" : "",
 187       "deprecated" : "",
 188       "since" : "",
 189       "see" : "",
 190       "exceptions" : "",
 191       "requires" : "",
 192       "params" : [],
 193       "returns" : [
 194         {
 195           "name" : "",
 196           "type" : "String",
 197           "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
 198         }
 199       ]
 200     },
 201     {
 202       "name" : "setNodeBackgroundColor",
 203       "type" : "function",
 204       "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
 205       "sig" : "(node)",
 206       "static" : false,
 207       "memberOf" : "Roo.lib.Color",
 208       "isStatic" : false,
 209       "isConstructor" : false,
 210       "isPrivate" : false,
 211       "example" : "",
 212       "deprecated" : "",
 213       "since" : "",
 214       "see" : "",
 215       "exceptions" : "",
 216       "requires" : "",
 217       "params" : [
 218         {
 219           "name" : "node",
 220           "type" : "DomElement",
 221           "desc" : "- the node whose background Color should be set",
 222           "isOptional" : false
 223         }
 224       ],
 225       "returns" : []
 226     },
 227     {
 228       "name" : "getHSL",
 229       "type" : "function",
 230       "desc" : "getHSL",
 231       "sig" : "()\n{\n\n}",
 232       "static" : false,
 233       "memberOf" : "Roo.lib.Color",
 234       "isStatic" : false,
 235       "isConstructor" : false,
 236       "isPrivate" : false,
 237       "example" : "",
 238       "deprecated" : "",
 239       "since" : "",
 240       "see" : "",
 241       "exceptions" : "",
 242       "requires" : "",
 243       "params" : [],
 244       "returns" : [
 245         {
 246           "name" : "",
 247           "type" : "Object",
 248           "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
 249         }
 250       ]
 251     },
 252     {
 253       "name" : "getHSV",
 254       "type" : "function",
 255       "desc" : "getHSV",
 256       "sig" : "()\n{\n\n}",
 257       "static" : false,
 258       "memberOf" : "Roo.lib.Color",
 259       "isStatic" : false,
 260       "isConstructor" : false,
 261       "isPrivate" : false,
 262       "example" : "",
 263       "deprecated" : "",
 264       "since" : "",
 265       "see" : "",
 266       "exceptions" : "",
 267       "requires" : "",
 268       "params" : [],
 269       "returns" : [
 270         {
 271           "name" : "",
 272           "type" : "Object",
 273           "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
 274         }
 275       ]
 276     },
 277     {
 278       "name" : "getCSSPercentageRGB",
 279       "type" : "function",
 280       "desc" : "getCSSPercentageRGB",
 281       "sig" : "()\n{\n\n}",
 282       "static" : false,
 283       "memberOf" : "Roo.lib.Color",
 284       "isStatic" : false,
 285       "isConstructor" : false,
 286       "isPrivate" : false,
 287       "example" : "",
 288       "deprecated" : "",
 289       "since" : "",
 290       "see" : "",
 291       "exceptions" : "",
 292       "requires" : "",
 293       "params" : [],
 294       "returns" : [
 295         {
 296           "name" : "",
 297           "type" : "String",
 298           "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
 299         }
 300       ]
 301     },
 302     {
 303       "name" : "setNodeColor",
 304       "type" : "function",
 305       "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
 306       "sig" : "(node)",
 307       "static" : false,
 308       "memberOf" : "Roo.lib.Color",
 309       "isStatic" : false,
 310       "isConstructor" : false,
 311       "isPrivate" : false,
 312       "example" : "",
 313       "deprecated" : "",
 314       "since" : "",
 315       "see" : "",
 316       "exceptions" : "",
 317       "requires" : "",
 318       "params" : [
 319         {
 320           "name" : "node",
 321           "type" : "DomElement",
 322           "desc" : "- the node whose Color should be set",
 323           "isOptional" : false
 324         }
 325       ],
 326       "returns" : []
 327     },
 328     {
 329       "name" : "getCSSIntegerRGB",
 330       "type" : "function",
 331       "desc" : "getCSSIntegerRGB",
 332       "sig" : "()\n{\n\n}",
 333       "static" : false,
 334       "memberOf" : "Roo.lib.Color",
 335       "isStatic" : false,
 336       "isConstructor" : false,
 337       "isPrivate" : false,
 338       "example" : "",
 339       "deprecated" : "",
 340       "since" : "",
 341       "see" : "",
 342       "exceptions" : "",
 343       "requires" : "",
 344       "params" : [],
 345       "returns" : [
 346         {
 347           "name" : "",
 348           "type" : "String",
 349           "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
 350         }
 351       ]
 352     },
 353     {
 354       "name" : "getCSSHSLA",
 355       "type" : "function",
 356       "desc" : "getCSSHSLA",
 357       "sig" : "()\n{\n\n}",
 358       "static" : false,
 359       "memberOf" : "Roo.lib.Color",
 360       "isStatic" : false,
 361       "isConstructor" : false,
 362       "isPrivate" : false,
 363       "example" : "",
 364       "deprecated" : "",
 365       "since" : "",
 366       "see" : "",
 367       "exceptions" : "",
 368       "requires" : "",
 369       "params" : [],
 370       "returns" : [
 371         {
 372           "name" : "",
 373           "type" : "String",
 374           "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
 375         }
 376       ]
 377     },
 378     {
 379       "name" : "getCSSPercentageRGBA",
 380       "type" : "function",
 381       "desc" : "getCSSPercentageRGBA",
 382       "sig" : "()\n{\n\n}",
 383       "static" : false,
 384       "memberOf" : "Roo.lib.Color",
 385       "isStatic" : false,
 386       "isConstructor" : false,
 387       "isPrivate" : false,
 388       "example" : "",
 389       "deprecated" : "",
 390       "since" : "",
 391       "see" : "",
 392       "exceptions" : "",
 393       "requires" : "",
 394       "params" : [],
 395       "returns" : [
 396         {
 397           "name" : "",
 398           "type" : "String",
 399           "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
 400         }
 401       ]
 402     }
 403   ],
 404   "events" : []
 405 }