zTreeObj.expandNode.html 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(treeNode, expandFlag, sonSign, focus, callbackFlag)</span><span class="path">zTreeObj.</span>expandNode</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>Expand or collapse single node.</p>
  9. <p class="highlight_red">Use expandNode() method of zTree v3.x can trigger 'beforeExpand / onExpand' or 'beforeCollapse / onCollapse' callback function. for reduce redundant code.</p>
  10. <p class="highlight_red">Please use zTree object to executing the method.</p>
  11. </div>
  12. </div>
  13. <h3>Function Parameter Descriptions</h3>
  14. <div class="desc">
  15. <h4><b>treeNode</b><span>JSON</span></h4>
  16. <p>JSON data object of the node which will be expanded or collapsed</p>
  17. <p class="highlight_red">Please ensure that this data object is an internal node data object in zTree.</p>
  18. <h4 class="topLine"><b>expandFlag</b><span>Boolean</span></h4>
  19. <p>expandFlag = true means: expand the node.</p>
  20. <p>expandFlag = false means: collapse the node.</p>
  21. <p class="highlight_red">If this parameter is omitted, then toggle expand or collapse depend this node's expanded state.</p>
  22. <h4 class="topLine"><b>sonSign</b><span>Boolean</span></h4>
  23. <p>sonSign = true means: expand or collapse all of the child nodes depend the 'expandFlag' parameter.</p>
  24. <p>sonSign = false means: only expand or collapse this node.</p>
  25. <p class="highlight_red">When sonSign = false and treeNode.open = expandFlag, will not trigger the callback.</p>
  26. <p class="highlight_red">If this parameter is omitted, it is same as 'sonSign = false'.</p>
  27. <h4 class="topLine"><b>focus</b><span>Boolean</span></h4>
  28. <p>focus = true means: after expand or collapse, set the focus of this node for view.</p>
  29. <p>focus = false means: after expand or coolapse, don't set the focus of this node.</p>
  30. <p class="highlight_red">If this parameter is omitted, it is same as 'focus = true'.</p>
  31. <h4 class="topLine"><b>callbackFlag</b><span>Boolean</span></h4>
  32. <p>callbackFlag = true means: call this method, will trigger 'beforeExpand / onExpand' or 'beforeCollapse / onCollapse' callback.</p>
  33. <p>callbackFlag = false means: call this method, will not trigger callback.</p>
  34. <p class="highlight_red">If this parameter is omitted, it is same as 'callbackFlag = false'</p>
  35. <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>
  36. <p>return the result of expand or collapse.</p>
  37. <p>true means: expand node</p>
  38. <p>false means: collapse node</p>
  39. <p>null means: the node is not parent node.</p>
  40. </div>
  41. <h3>Examples of function</h3>
  42. <h4>1. Expand the first selected node. (and expand this node's child nodes)</h4>
  43. <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");
  44. var nodes = treeObj.getSelectedNodes();
  45. if (nodes.length>0) {
  46. treeObj.expandNode(nodes[0], true, true, true);
  47. }
  48. </code></pre>
  49. </div>
  50. </div>