docs/output/Ext.util.Grouper.js

   1 Ext.data.JsonP.Ext_util_Grouper({
   2   "tagname": "class",
   3   "name": "Ext.util.Grouper",
   4   "doc": "\n",
   5   "extends": "Ext.util.Sorter",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "direction",
  21       "member": "Ext.util.Sorter",
  22       "type": "String",
  23       "doc": "<p>The direction to sort by. Defaults to ASC</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
  26       "linenr": 27,
  27       "html_filename": "Sorter.html",
  28       "href": "Sorter.html#Ext-util-Sorter-cfg-direction"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "property",
  33       "member": "Ext.util.Sorter",
  34       "type": "String",
  35       "doc": "<p>The property to sort by. Required unless <a href=\"#/api/Ext.util.Grouper--sorter\" rel=\"Ext.util.Grouper--sorter\" class=\"docClass\">sorter</a> is provided</p>\n",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
  38       "linenr": 8,
  39       "html_filename": "Sorter.html",
  40       "href": "Sorter.html#Ext-util-Sorter-cfg-property"
  41     },
  42     {
  43       "tagname": "cfg",
  44       "name": "root",
  45       "member": "Ext.util.Sorter",
  46       "type": "String",
  47       "doc": "<p>Optional root property. This is mostly useful when sorting a Store, in which case we set the\nroot to 'data' to make the filter pull the <a href=\"#/api/Ext.util.Grouper-cfg-property\" rel=\"Ext.util.Grouper-cfg-property\" class=\"docClass\">property</a> out of the data object of each item</p>\n",
  48       "private": false,
  49       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
  50       "linenr": 16,
  51       "html_filename": "Sorter.html",
  52       "href": "Sorter.html#Ext-util-Sorter-cfg-root",
  53       "shortDoc": "Optional root property. This is mostly useful when sorting a Store, in which case we set the\nroot to 'data' to make t..."
  54     },
  55     {
  56       "tagname": "cfg",
  57       "name": "sorterFn",
  58       "member": "Ext.util.Sorter",
  59       "type": "Function",
  60       "doc": "<p>A specific sorter function to execute. Can be passed instead of <a href=\"#/api/Ext.util.Grouper-cfg-property\" rel=\"Ext.util.Grouper-cfg-property\" class=\"docClass\">property</a></p>\n",
  61       "private": false,
  62       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
  63       "linenr": 12,
  64       "html_filename": "Sorter.html",
  65       "href": "Sorter.html#Ext-util-Sorter-cfg-sorterFn"
  66     },
  67     {
  68       "tagname": "cfg",
  69       "name": "transform",
  70       "member": "Ext.util.Sorter",
  71       "type": "Function",
  72       "doc": "<p>A function that will be run on each value before\nit is compared in the sorter. The function will receive a single argument,\nthe value.</p>\n",
  73       "private": false,
  74       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
  75       "linenr": 21,
  76       "html_filename": "Sorter.html",
  77       "href": "Sorter.html#Ext-util-Sorter-cfg-transform",
  78       "shortDoc": "A function that will be run on each value before\nit is compared in the sorter. The function will receive a single arg..."
  79     }
  80   ],
  81   "method": [
  82     {
  83       "tagname": "method",
  84       "name": "getGroupString",
  85       "member": "Ext.util.Grouper",
  86       "doc": "<p>Function description</p>\n",
  87       "params": [
  88         {
  89           "type": "Ext.data.Model",
  90           "name": "instance",
  91           "doc": "<p>The Model instance</p>\n",
  92           "optional": false
  93         }
  94       ],
  95       "return": {
  96         "type": "String",
  97         "doc": "<p>The group string for this model</p>\n"
  98       },
  99       "private": false,
 100       "static": false,
 101       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Grouper.js",
 102       "linenr": 14,
 103       "html_filename": "Grouper.html",
 104       "href": "Grouper.html#Ext-util-Grouper-method-getGroupString",
 105       "shortDoc": "<p>Function description</p>\n"
 106     }
 107   ],
 108   "property": [
 109
 110   ],
 111   "event": [
 112
 113   ],
 114   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Grouper.js",
 115   "linenr": 1,
 116   "html_filename": "Grouper.html",
 117   "href": "Grouper.html#Ext-util-Grouper",
 118   "cssVar": [
 119
 120   ],
 121   "cssMixin": [
 122
 123   ],
 124   "component": false,
 125   "superclasses": [
 126     "Ext.util.Sorter"
 127   ],
 128   "subclasses": [
 129
 130   ],
 131   "mixedInto": [
 132
 133   ],
 134   "allMixins": [
 135
 136   ]
 137 });