setting.callback.onAsyncSuccess.html 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(event, treeId, treeNode, msg)</span><span class="path">setting.callback.</span>onAsyncSuccess
  4. </h2>
  5. <h3>Overview<span class="h3_info">[ depends on <span
  6. class="highlight_green">jquery.ztree.core</span> js ]</span></h3>
  7. <div class="desc">
  8. <p></p>
  9. <div class="longdesc">
  10. <p>Used to capture the complete success event when execute ajax.</p>
  11. <p class="highlight_red">If you set 'setting.callback.beforeAsync',and return false, zTree will not
  12. execute ajax, and will not trigger the 'onAsyncSuccess / onAsyncError' callback.</p>
  13. <p>Default: null</p>
  14. </div>
  15. </div>
  16. <h3>Function Parameter Descriptions</h3>
  17. <div class="desc">
  18. <h4><b>event</b><span>js event Object</span></h4>
  19. <p>event Object</p>
  20. <h4 class="topLine"><b>treeId</b><span>String</span></h4>
  21. <p>zTree unique identifier: <b class="highlight_red">treeId</b>.</p>
  22. <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>
  23. <p>JSON data object of the parent node</p>
  24. <p class="highlight_red">When load root nodes, treeNode = null</p>
  25. <h4 class="topLine"><b>msg</b><span>String / Object</span></h4>
  26. <p>The actualnode data which got by ajax. User-friendly debugging.</p>
  27. <p class="highlight_red">The actual data's type of msg is affected by 'setting.async.dataType', please refer
  28. to JQuery API documentation.</p>
  29. </div>
  30. <h3>Examples of setting & function</h3>
  31. <h4>1. When execute ajax complete success, alert message.</h4>
  32. <pre xmlns=""><code>function myOnAsyncSuccess(event, treeId, treeNode, msg) {
  33. alert(msg);
  34. };
  35. var setting = {
  36. callback: {
  37. onAsyncSuccess: myOnAsyncSuccess
  38. }
  39. };
  40. ......</code></pre>
  41. </div>
  42. </div>