portal-common/src/main/webapp/common/thirdparty/zTree/api/en/setting.async.dataFilter.html

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(treeId, parentNode, responseData)</span><span class="path">setting.async.</span>dataFilter</h2>\r
   4         <h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.core</span> js ]</span></h3>\r
   5         <div class="desc">\r
   6                 <p></p>\r
   7                 <div class="longdesc">\r
   8                         <p>Function used to pre-process for the return data of Ajax. It is valid when <span class="highlight_red">[setting.async.enable = true]</span></p>\r
   9                         <p>Default: null</p>\r
  10                 </div>\r
  11         </div>\r
  12         <h3>Function Parameter Descriptions</h3>\r
  13         <div class="desc">\r
  14         <h4><b>treeId</b><span>String</span></h4>\r
  15         <p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>\r
  16         <h4 class="topLine"><b>parentNode</b><span>JSON</span></h4>\r
  17         <p>Parent node's JSON data object</p>\r
  18         <p class="highlight_red">When asynchronously loading the root, the parentNode = null</p>\r
  19         <h4 class="topLine"><b>responseData</b><span>Array(JSON) / JSON / String</span></h4>\r
  20         <p>Ajax got Array (JSON) / JSON / String data objects</p>\r
  21         <p class="highlight_red">From v3.4, support the string with XML format.</p>\r
  22         <h4 class="topLine"><b>Return </b><span>Array(JSON) / JSON</span></h4>\r
  23         <p>The return value should be the JSON data structure which is supported by the zTree.</p>\r
  24         <p class="highlight_red">v3.x supports to load single node JSON data object.</p>\r
  25         </div>\r
  26         <h3>Examples of setting & function</h3>\r
  27         <h4>1. Modify the node name attribute which is ajax got.</h4>\r
  28         <pre xmlns=""><code>function ajaxDataFilter(treeId, parentNode, responseData) {\r
  29     if (responseData) {\r
  30       for(var i =0; i < responseData.length; i++) {\r
  31         responseData[i].name += "_filter";\r
  32       }\r
  33     }\r
  34     return responseData;\r
  35 };\r
  36 var setting = {\r
  37         async: {\r
  38                 enable: true,\r
  39                 url: "http://host/getNode.php",\r
  40                 dataFilter: ajaxDataFilter\r
  41         }\r
  42 };\r
  43 ......</code></pre>\r
  44 </div>\r
  45 </div>