docs/api/Ext.util.Sorter.html

   1 <!DOCTYPE html><html><head><title>Ext.util.Sorter | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.util.Sorter',
  13         docClass: 'Ext.util.Sorter',
  14         docReq: 'Ext.util.Sorter',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'Sorter.html#Ext-util.Sorter';
  33     clsInfo = {"methods":[],"cfgs":["direction","property","root","sorterFn","transform"],"properties":[],"events":[],"subclasses":["Ext.util.Grouper"]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Sorter.html#Ext-util.Sorter" target="_blank">Ext.util.Sorter</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><p>Represents a single sorter that can be applied to a Store</p>
  38 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-direction" class="member f ni"><a href="Ext.util.Sorter.html#config-direction" rel="config-direction" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sorter.html" class="definedIn docClass">Ext.util.Sorter</a><br/><a href="../source/Sorter.html#Ext-util.Sorter-cfg-direction" class="viewSource">view source</a></div><a name="direction"></a><a name="config-direction"></a><a href="Ext.util.Sorter.html#" rel="config-direction" class="cls expand">direction</a><span> : String</span></div><div class="description"><div class="short"><p>The direction to sort by. Defaults to ASC</p>
  39 </div><div class="long"><p>The direction to sort by. Defaults to ASC</p>
  40 </div></div></div><div id="config-property" class="member ni"><a href="Ext.util.Sorter.html#config-property" rel="config-property" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sorter.html" class="definedIn docClass">Ext.util.Sorter</a><br/><a href="../source/Sorter.html#Ext-util.Sorter-cfg-property" class="viewSource">view source</a></div><a name="property"></a><a name="config-property"></a><a href="Ext.util.Sorter.html#" rel="config-property" class="cls expand">property</a><span> : String</span></div><div class="description"><div class="short"><p>The property to sort by. Required unless <a href="Ext.util.Sorter.html#sorter" rel="Ext.util.Sorter#sorter" class="docClass">sorter</a> is provided</p>
  41 </div><div class="long"><p>The property to sort by. Required unless <a href="Ext.util.Sorter.html#sorter" rel="Ext.util.Sorter#sorter" class="docClass">sorter</a> is provided</p>
  42 </div></div></div><div id="config-root" class="member ni"><a href="Ext.util.Sorter.html#config-root" rel="config-root" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sorter.html" class="definedIn docClass">Ext.util.Sorter</a><br/><a href="../source/Sorter.html#Ext-util.Sorter-cfg-root" class="viewSource">view source</a></div><a name="root"></a><a name="config-root"></a><a href="Ext.util.Sorter.html#" rel="config-root" class="cls expand">root</a><span> : String</span></div><div class="description"><div class="short">Optional root property. This is mostly useful when sorting a Store, in which case we set the
  43 root to 'data' to make t...</div><div class="long"><p>Optional root property. This is mostly useful when sorting a Store, in which case we set the
  44 root to 'data' to make the filter pull the <a href="Ext.util.Sorter.html#property" rel="Ext.util.Sorter#property" class="docClass">property</a> out of the data object of each item</p>
  45 </div></div></div><div id="config-sorterFn" class="member ni"><a href="Ext.util.Sorter.html#config-sorterFn" rel="config-sorterFn" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sorter.html" class="definedIn docClass">Ext.util.Sorter</a><br/><a href="../source/Sorter.html#Ext-util.Sorter-cfg-sorterFn" class="viewSource">view source</a></div><a name="sorterFn"></a><a name="config-sorterFn"></a><a href="Ext.util.Sorter.html#" rel="config-sorterFn" class="cls expand">sorterFn</a><span> : Function</span></div><div class="description"><div class="short"><p>A specific sorter function to execute. Can be passed instead of <a href="Ext.util.Sorter.html#property" rel="Ext.util.Sorter#property" class="docClass">property</a></p>
  46 </div><div class="long"><p>A specific sorter function to execute. Can be passed instead of <a href="Ext.util.Sorter.html#property" rel="Ext.util.Sorter#property" class="docClass">property</a></p>
  47 </div></div></div><div id="config-transform" class="member ni"><a href="Ext.util.Sorter.html#config-transform" rel="config-transform" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sorter.html" class="definedIn docClass">Ext.util.Sorter</a><br/><a href="../source/Sorter.html#Ext-util.Sorter-cfg-transform" class="viewSource">view source</a></div><a name="transform"></a><a name="config-transform"></a><a href="Ext.util.Sorter.html#" rel="config-transform" class="cls expand">transform</a><span> : Function</span></div><div class="description"><div class="short">A function that will be run on each value before
  48 it is compared in the sorter. The function will receive a single arg...</div><div class="long"><p>A function that will be run on each value before
  49 it is compared in the sorter. The function will receive a single argument,
  50 the value.</p>
  51 </div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>