git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.MemoryProxy.json

   1 {
   2   "name" : "Roo.data.MemoryProxy",
   3   "augments" : [],
   4   "childClasses" : [],
   5   "desc" : "An implementation of Roo.data.DataProxy that simply passes the data specified in its constructor\nto the Reader when its load method is called.",
   6   "isSingleton" : false,
   7   "isStatic" : false,
   8   "isBuiltin" : false,
   9   "memberOf" : "MemoryProxy",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [
  15     {
  16       "name" : "data",
  17       "type" : "Object",
  18       "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
  19       "isOptional" : false
  20     }
  21   ],
  22   "returns" : [],
  23   "throws" : "",
  24   "requires" : "",
  25   "config" : [],
  26   "methods" : [
  27     {
  28       "name" : "load",
  29       "type" : "function",
  30       "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
  31       "sig" : "(params, reader, callback, scope, arg)",
  32       "static" : false,
  33       "memberOf" : "",
  34       "isStatic" : false,
  35       "isConstructor" : false,
  36       "isPrivate" : false,
  37       "example" : "",
  38       "deprecated" : "",
  39       "since" : "",
  40       "see" : "",
  41       "exceptions" : "",
  42       "requires" : "",
  43       "params" : [
  44         {
  45           "name" : "params",
  46           "type" : "Object",
  47           "desc" : "This parameter is not used by the MemoryProxy class.",
  48           "isOptional" : false
  49         },
  50         {
  51           "name" : "reader",
  52           "type" : "Roo.data.DataReader",
  53           "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
  54           "isOptional" : false
  55         },
  56         {
  57           "name" : "callback",
  58           "type" : "Function",
  59           "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
  60           "isOptional" : false
  61         },
  62         {
  63           "name" : "scope",
  64           "type" : "Object",
  65           "desc" : "The scope in which to call the callback",
  66           "isOptional" : false
  67         },
  68         {
  69           "name" : "arg",
  70           "type" : "Object",
  71           "desc" : "An optional argument which is passed to the callback as its second parameter.",
  72           "isOptional" : false
  73         }
  74       ],
  75       "returns" : []
  76     }
  77   ],
  78   "events" : []
  79 }