git.roojs.org Git - roojs1/blob - docs/symbols/Number.json

   1 {
   2   "name" : "Number",
   3   "augments" : [
   4   ],
   5   "desc" : "",
   6   "isSingleton" : false,
   7   "isStatic" : false,
   8   "isBuiltin" : true,
   9   "memberOf" : "Number",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [
  15   ],
  16   "returns" : [
  17   ],
  18   "config" : [
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "constrain",
  23       "desc" : "Checks whether or not the current number is within a desired range.  If the number is already within the\nrange it is returned, otherwise the min or max value is returned depending on which side of the range is\nexceeded.  Note that this method returns the constrained value but does not change the current number.",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Number",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33         {
  34           "name" : "min",
  35           "type" : "Number",
  36           "desc" : "The minimum number in the range",
  37           "isOptional" : false
  38         },
  39         {
  40           "name" : "max",
  41           "type" : "Number",
  42           "desc" : "The maximum number in the range",
  43           "isOptional" : false
  44         }
  45       ],
  46       "returns" : [
  47         {
  48           "name" : "",
  49           "type" : "Number",
  50           "desc" : "The constrained value if outside the range, otherwise the current value"
  51         }
  52       ]
  53     }
  54   ],
  55   "events" : [
  56   ]
  57 }