CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / cn / zTreeObj.getNodesByFilter.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(filter, isSingle, parentNode, invokeParam)</span><span class="path">zTreeObj.</span>getNodesByFilter</h2>\r
4         <h3>概述<span class="h3_info">[ 依赖 <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>根据自定义规则搜索节点数据 JSON 对象集合 或 单个节点数据</p>\r
9                         <p class="highlight_red">可自定义复杂的搜索规则</p>\r
10                         <p class="highlight_red">请通过 zTree 对象执行此方法。</p>\r
11                 </div>\r
12         </div>\r
13         <h3>Function 参数说明</h3>\r
14         <div class="desc">\r
15         <h4><b>filter</b><span>Function</span></h4>\r
16         <p>自定义过滤器函数 function filter(node) {...}</p>\r
17         <p>filter 参数:node (节点数据 JSON)</p>\r
18         <p>filter 返回值:boolean (true 表示符合搜索条件;false 表示不符合搜索条件)</p>\r
19         <h4 class="topLine"><b>isSingle</b><span>Boolean</span></h4>\r
20         <p>isSingle = true 表示只查找单个节点</p>\r
21         <p>isSingle = false 表示查找节点集合</p>\r
22         <p class="highlight_red">忽略此参数,表示查找节点集合</p>\r
23         <h4 class="topLine"><b>parentNode</b><span>JSON</span></h4>\r
24         <p>可以指定在某个父节点下的子节点中搜索</p>\r
25         <p class="highlight_red">忽略此参数,表示在全部节点中搜索</p>\r
26         <h4 class="topLine"><b>invokeParam</b><span>任意类型</span></h4>\r
27         <p>用户自定义的数据对象,用于 filter 中进行计算</p>\r
28         <h4 class="topLine"><b>返回值</b><span>Array(JSON) / JSON</span></h4>\r
29         <p>isSingle = true 返回 第一个找到的节点数据 JSON,无结果时返回 null</p>\r
30         <p>isSingle = false 返回 节点数据集合 Array(JSON),无结果时返回 [ ]</p>\r
31         </div>\r
32         <h3>function 举例</h3>\r
33         <h4>1. 查找 level = 2 & name 中包含 "test" 的节点数据</h4>\r
34         <pre xmlns=""><code>function filter(node) {\r
35     return (node.level == 2 && node.name.indexOf("test")>-1);\r
36 }\r
37 ......\r
38 var treeObj = $.fn.zTree.getZTreeObj("tree");\r
39 var node = treeObj.getNodesByFilter(filter, true); // 仅查找一个节点\r
40 var nodes = treeObj.getNodesByFilter(filter); // 查找节点集合\r
41 </code></pre>\r
42 </div>\r
43 </div>