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