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

   1 {
   2   "name" : "Roo.data.MemoryProxy",
   3   "augments" : [],
   4   "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.",
   5   "isSingleton" : false,
   6   "isStatic" : false,
   7   "isBuiltin" : false,
   8   "memberOf" : "MemoryProxy",
   9   "example" : "",
  10   "deprecated" : "",
  11   "since" : "",
  12   "see" : "",
  13   "params" : [
  14     {
  15       "name" : "data",
  16       "type" : "Object",
  17       "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
  18       "isOptional" : false
  19     }
  20   ],
  21   "returns" : [],
  22   "throws" : "",
  23   "requires" : "",
  24   "config" : [],
  25   "methods" : [
  26     {
  27       "name" : "load",
  28       "type" : "function",
  29       "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.",
  30       "sig" : "(params, reader, callback, scope, arg)",
  31       "static" : false,
  32       "memberOf" : "",
  33       "isStatic" : false,
  34       "isConstructor" : false,
  35       "isPrivate" : false,
  36       "example" : "",
  37       "deprecated" : "",
  38       "since" : "",
  39       "see" : "",
  40       "exceptions" : "",
  41       "requires" : "",
  42       "params" : [
  43         {
  44           "name" : "params",
  45           "type" : "Object",
  46           "desc" : "This parameter is not used by the MemoryProxy class.",
  47           "isOptional" : false
  48         },
  49         {
  50           "name" : "reader",
  51           "type" : "Roo.data.DataReader",
  52           "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
  53           "isOptional" : false
  54         },
  55         {
  56           "name" : "callback",
  57           "type" : "Function",
  58           "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>",
  59           "isOptional" : false
  60         },
  61         {
  62           "name" : "scope",
  63           "type" : "Object",
  64           "desc" : "The scope in which to call the callback",
  65           "isOptional" : false
  66         },
  67         {
  68           "name" : "arg",
  69           "type" : "Object",
  70           "desc" : "An optional argument which is passed to the callback as its second parameter.",
  71           "isOptional" : false
  72         }
  73       ],
  74       "returns" : []
  75     }
  76   ],
  77   "events" : []
  78 }