zTreeObj.getNodesByParam.html 1.5 KB

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