openo-portal/portal-common/src/main/webapp/common/thirdparty/zTree/api/en/zTreeObj.getNodesByParam.html

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(key, value, parentNode)</span><span class="path">zTreeObj.</span>getNodesByParam</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>According to the node data attribute, search the nodes which exactly matches, and get the JSON objects collection of nodes.</p>\r
   9                         <p class="highlight_red">Please use zTree object to executing the method.</p>\r
  10                 </div>\r
  11         </div>\r
  12         <h3>Function Parameter Descriptions</h3>\r
  13         <div class="desc">\r
  14         <h4><b>key</b><span>String</span></h4>\r
  15         <p>The name of attribute which need to exactly match</p>\r
  16         <h4 class="topLine"><b>value</b><span>?</span></h4>\r
  17         <p>The value which need to exactly match, can be any type, please ensure its type consistent with the attribute values.</p>\r
  18         <h4 class="topLine"><b>parentNode</b><span>JSON</span></h4>\r
  19         <p>The search range, you can search node from a parent node's child nodes.</p>\r
  20         <p class="highlight_red">If this parameter is omitted, zTree will search node from all nodes.</p>\r
  21         <h4 class="topLine"><b>Return </b><span>Array(JSON)</span></h4>\r
  22         <p>The JSON data objects collection of the nodes which be searched.</p>\r
  23         <p class="highlight_red">If search none node, return [ ].</p>\r
  24         </div>\r
  25         <h3>Examples of function</h3>\r
  26         <h4>1. Search the nodes which their 'name' attribute is 'test'.</h4>\r
  27         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
  28 var nodes = treeObj.getNodesByParam("name", "test", null);\r
  29 </code></pre>\r
  30 </div>\r
  31 </div>