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

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