zTree 容器的 jQuery 对象，主要功能：便于操作。
9 |请勿进行初始化 或 修改，属于内部参数。
10 |zTree 的唯一标识，初始化后，等于 用户定义的 zTree 容器的 id 属性值。
9 |请勿进行初始化 或 修改，属于内部参数。
10 |zTree v3.x 内部的全部方法都可以通过 $.fn.zTree._z 进行调用，开放出来是为了更便于大家开发制作自己的 zTree 插件。
9 |如无特殊需求请勿使用此对象，以及修改此对象内部的各个函数。
10 |zTree DOM's jQuery object, the main function: easy to internal operations.
9 |Do not initialize or modify it, it is an internal argument.
10 |zTree 对象使用的 setting 配置数据，详细请参考 “setting 配置详解”中的各个属性详细说明
9 |v3.x 取消了原先操作 setting 的方法，让用户可以较自由的修改参数，但请注意，对于 zTree 初始化有影响的参数后期修改是不会起作用的，请对各个属性有较深入的了解以后再考虑进行修改。
10 |用于保存节点的其他自定义数据信息，不要与 zTree 使用的属性相同即可，用户可随意设定。
9 |var node = { "id":1, "name":"test1", "ename":"test eName"};zTree unique identifier. After the initialization, it equals to the id attribute value of the user-defined zTree container.
9 |Do not initialize or modify it, it is an internal argument.
10 |[setting.async.enable = true 时生效]
9 |默认值："{}"
10 |v3.5.36+
11 |请参考 jQuery ajax 中的 headers 参数
16 |[setting.async.enable = true 时生效]
9 |默认值："{}"
10 |v3.5.36+
11 |请参考 jQuery ajax 中的 xhrFields 参数
16 |zTree 节点数据保存节点名称的属性名称。
9 |默认值："name"
10 |var setting = {
15 | data: {
16 | key: {
17 | name: "ename"
18 | }
19 | }
20 | };
21 | ......记录节点 的 hover 状态，主要用于 setting.view.addHoverDom / removeHoverDom 。
9 |zTree 内部使用，请勿进行初始化 或 随意修改
10 |默认值：false
11 |true 表示节点处于 hover 状态
16 |false 表示节点未处于 hover 状态
17 |zTree 节点数据中保存子节点数据的属性名称。
9 |默认值："children"
10 |var setting = {
15 | data: {
16 | key: {
17 | children: "nodes"
18 | }
19 | }
20 | };
21 | ......Used to save other custom data of node, do not use the same attribute name with ztree used, the user can freely set.
9 |var node = { "id":1, "name":"test1", "ename":"test eName"};用于记录节点是否处于编辑名称状态。[setting.edit.enable = true 时有效]
9 |zTree 内部使用，请勿进行初始化 或 随意修改
10 |默认值：false
11 |true 表示节点处于编辑名称状态
16 |false 表示节点未处于编辑名称状态
17 |用于设置节点的 checkBox / radio 的 focus 状态。[setting.check.enable = true 时有效]
9 |zTree 内部使用，请勿进行初始化 或 随意修改
10 |默认值：false
11 |true 表示当前鼠标移动到输入框内
16 |false 表示当前鼠标移动到输入框外
17 |It is valid when [setting.async.enable = true]
9 |Default："{}"
10 |v3.5.36+
11 |The 'headers' in zTree and jQuery's ajax requests is same.
16 |It is valid when [setting.async.enable = true]
9 |Default："{}"
10 |v3.5.36+
11 |The 'xhrFields' in zTree and jQuery's ajax requests is same.
16 |The node data's attribute to save the node name.
9 |Default: "name"
10 |var setting = {
15 | data: {
16 | key: {
17 | name: "ename"
18 | }
19 | }
20 | };
21 | ......设置 zTree 是否显示节点之间的连线。
9 |默认值：true
10 |true / false 分别表示 显示 / 不显示 连线
15 |var setting = {
19 | view: {
20 | showLine: false
21 | }
22 | };
23 | ......All of the internal methods in zTree v3.x are available through '$. fn.zTree._z', 9 | use this if you want to develop your own zTree plug-ins.
10 |Unless you are writing a plugin, 11 | you should not use this object.
12 |zTree 节点数据保存节点是否隐藏的属性名称。
9 |默认值："isHidden"
10 |v3.5.32+
11 |var setting = {
16 | data: {
17 | key: {
18 | isHidden: "hidden"
19 | }
20 | }
21 | };
22 | ......设置 zTree 的节点上是否显示 checkbox / radio
9 |默认值: false
10 |true / false 分别表示 显示 / 不显示 复选框或单选框
15 |var setting = {
19 | check: {
20 | enable: true
21 | }
22 | };
23 | ......zTree 节点数据保存节点是否为父节点的属性名称。
9 |默认值："isParent"
10 |v3.5.32+
11 |var setting = {
16 | data: {
17 | key: {
18 | isParent: "parent"
19 | }
20 | }
21 | };
22 | ......The node data's attribute to save the child nodes.
9 |Default: "children"
10 |var setting = {
15 | data: {
16 | key: {
17 | children: "nodes"
18 | }
19 | }
20 | };
21 | ......The configuration data of zTree, refer to "setting details"
9 |zTree v3.x to cancel the original operation setting method, so users can modify.
10 |Note: Modify the parameters which affect zTree initialization will not work, please first understand the different attributes.
11 |zTree 节点数据中保存 check 状态的属性名称。
9 |默认值："checked"
10 |请勿与 zTree 节点数据的其他参数冲突，例如：checkedOld
11 |var setting = {
16 | data: {
17 | key: {
18 | checked: "isChecked"
19 | }
20 | }
21 | };
22 | ......zTree 节点数据保存节点链接的目标 URL 的属性名称。
9 |特殊用途：当后台数据只能生成 url 属性，又不想实现点击节点跳转的功能时，可以直接修改此属性为其他不存在的属性名称
10 |默认值："url"
11 |var setting = {
16 | data: {
17 | key: {
18 | url: "xUrl"
19 | }
20 | }
21 | };
22 | ......Set to show or hide line.
9 |Default: true
10 |true means: show line.
15 |false means: hide line.
16 |var setting = {
20 | view: {
21 | showLine: false
22 | }
23 | };
24 | ......设置 zTree 是否允许可以选择 zTree DOM 内的文本。
9 |默认值：false
10 |true / false 分别表示 允许 / 不允许 选择 zTree Dom 内的文本
15 |var setting = {
19 | view: {
20 | txtSelectedEnable: true
21 | }
22 | };
23 | ......Used to record the hover status of node's DOM. For 'setting.view.addHoverDom / removeHoverDom'.
9 |Do not initialize or modify it, it is an internal argument.
10 |Default: false
11 |true means: the node's DOM is in hover.
16 |false means: the node's DOM is not in hover.
17 |拖拽时父节点自动展开的延时间隔。 (单位：ms)[setting.edit.enable = true 时生效]
9 |默认值：500
10 |请根据自己的需求适当调整此值
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | autoOpenTime: 0
20 | }
21 | }
22 | };
23 | ......拖拽节点成为根节点时的 Tree 内边界范围 (单位：px)。[setting.edit.enable = true 时生效]
9 |默认值：10
10 |请根据自己的需求适当调整此值
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | borderMax: 20
20 | }
21 | }
22 | };
23 | ......拖拽节点成为根节点时的 Tree 外边界范围 (单位：px)。[setting.edit.enable = true 时生效]
9 |默认值：-5
10 |请根据自己的需求适当调整此值
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | borderMin: -10
20 | }
21 | }
22 | };
23 | ......拖拽多个兄弟节点时，浮动图层中显示的最大节点数。 多余的节点用...代替。[setting.edit.enable = true 时生效]
9 |默认值：5
10 |请根据自己的需求适当调整此值
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | maxShowNodeNum: 10
20 | }
21 | }
22 | };
23 | ......判定是否拖拽操作的最小位移值 (单位：px)。[setting.edit.enable = true 时生效]
9 |根据自己的需求可适当调整此值，如果太小容易导致点击鼠标时误操作进行拖拽
10 |默认值：5
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | minMoveSize: 10
20 | }
21 | }
22 | };
23 | ......获取 zTree 当前被选中的节点数据集合
9 |请通过 zTree 对象执行此方法。
10 |当前被选中的节点数据集合
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var nodes = treeObj.getSelectedNodes();
21 | Used to save the node editing name status. It is valid when [setting.edit.enable = true]
9 |Do not initialize or modify it, it is an internal argument.
10 |Default: false
11 |true means: node is being edited.
16 |false means: node is not being edited.
17 |zTree 节点数据保存节点提示信息的属性名称。[setting.view.showTitle = true 时生效]
9 |如果设置为 "" ，则自动与 setting.data.key.name 保持一致，避免用户反复设置
10 |默认值：""
11 |var setting = {
16 | data: {
17 | key: {
18 | title: "fullName"
19 | }
20 | }
21 | };
22 | ......节点名称。
9 |1、如果不使用 name 属性保存节点名称，请修改 setting.data.key.name
10 |默认值：无
11 |节点显示的名称字符串，标准 String 即可，所有特殊字符都会被自动转义
16 |var nodes = [
20 | { "id":1, "name":"test1"},
21 | { "id":2, "name":"test2"},
22 | { "id":3, "name":"test3"}
23 | ]The node data's attribute to save whether the node is the parent node.
9 |Default: "isHidden"
10 |v3.5.32+
11 |var setting = {
16 | data: {
17 | key: {
18 | isHidden: "hidden"
19 | }
20 | }
21 | };
22 | ......The node data's attribute to save whether the node is the parent node.
9 |Default: "isParent"
10 |v3.5.32+
11 |var setting = {
16 | data: {
17 | key: {
18 | isParent: "parent"
19 | }
20 | }
21 | };
22 | ......记录节点的层级
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |根节点 level = 0，依次递增
15 |var treeObj = $.fn.zTree.getZTreeObj("tree");
19 | var sNodes = treeObj.getSelectedNodes();
20 | if (sNodes.length > 0) {
21 | var level = sNodes[0].level;
22 | }
23 | treeNode 节点的唯一标识 tId。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |生成规则：setting.treeId + "_" + 内部计数
15 |var treeObj = $.fn.zTree.getZTreeObj("tree");
19 | var sNodes = treeObj.getSelectedNodes();
20 | if (sNodes.length > 0) {
21 | var tId = sNodes[0].tId;
22 | }
23 | 设置点击节点后在何处打开 url。[treeNode.url 存在时有效]
9 |默认值：无
10 |同超链接 target 属性: "_blank", "_self" 或 其他指定窗口名称
15 |省略此属性，则默认为 "_blank"
16 |var nodes = [
20 | { "id":1, "name":"test1", "url":"http://myTest.com", "target":"_blank"},
21 | ......
22 | ]Set to use checkbox or radio in zTree
9 |Default: false
10 |true means: use the checkbox or radio
15 |false means: don't use the checkbox or radio
16 |var setting = {
20 | check: {
21 | enable: true
22 | }
23 | };
24 | ......zTree 的节点叶子节点属性锁，是否始终保持 isParent = false
9 |默认值：false
10 |true / false 分别表示 锁定 / 不锁定 叶子节点属性
15 |如果设置为 true，则所有 isParent = false 的节点，都无法添加子节点。
16 |var setting = {
20 | data: {
21 | keep: {
22 | leaf: true
23 | }
24 | }
25 | };
26 | ......Used to record the status which the checkbox or radio get focus. It is valid when [setting.check.enable = true]
9 |Do not initialize or modify it, it is an internal argument.
10 |Default: false
11 |true means: mouse move over the checkbox
16 |false means: mouse move out the checkbox
17 |刷新 zTree 。
9 |没有特殊必要，尽量不要使用此方法。单个节点更新请使用 updateNode 方法，异步加载模式下请使用 reAsyncChildNodes 方法。
10 |请通过 zTree 对象执行此方法。
11 |目前无任何返回值
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | treeObj.refresh();
22 | 点击节点时，按下 Ctrl 或 Cmd 键是否允许取消选择操作。
9 |如果不需要此功能，请设置为 false。
10 |默认值: true
11 |true / false 分别表示 支持 / 不支持 配合 Ctrl 或 Cmd 键进行取消节点选择的操作
16 |var setting = {
20 | view: {
21 | autoCancelSelected: false
22 | }
23 | };
24 | ......zTree 的节点父节点属性锁，是否始终保持 isParent = true
9 |默认值：false
10 |true / false 分别表示 锁定 / 不锁定 父节点属性
15 |如果设置为 true，则所有 isParent = true 的节点，即使该节点的子节点被全部删除或移走，依旧保持父节点状态。
16 |var setting = {
20 | data: {
21 | keep: {
22 | parent: true
23 | }
24 | }
25 | };
26 | ......The node data's attribute to save the checked state.
9 |Default: "checked"
10 |Please don't set the other node attribute which zTree used. (e.g., checkedOld)
11 |var setting = {
16 | data: {
17 | key: {
18 | checked: "isChecked"
19 | }
20 | }
21 | };
22 | ......设置 name 属性是否支持 HTML 脚本
9 |如果允许 HTML 脚本，请根据自己的需求做校验，避免出现 js 注入等安全问题。
10 |默认值: false
11 |true / false 分别表示 支持 / 不支持 HTML 脚本
16 |var setting = {
20 | view: {
21 | nameIsHTML: true
22 | }
23 | };
24 | var node = {"name":"<font color='red'>test</font>"};
25 | ......记录 treeNode 节点是否正在进行异步加载。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |true 表示节点正在进行异步加载
15 |false 表示节点没有进行异步加载
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var sNodes = treeObj.getSelectedNodes();
21 | if (sNodes.length > 0) {
22 | var isAjaxing = sNodes[0].isAjaxing;
23 | }
24 | 节点编辑名称 input 初次显示时,设置 txt 内容是否为全选状态。 [setting.edit.enable = true 时生效]
9 |默认值: false
10 |true 表示 全选状态
15 |false 表示 不是全选状态，光标默认在最后
16 |var setting = {
20 | edit: {
21 | enable: true,
22 | editNameSelectAll: true
23 | }
24 | };
25 | ......节点链接的目标 URL
9 |1、编辑模式 (setting.edit.enable = true) 下此属性功能失效，如果必须使用类似功能，请利用 onClick 事件回调函数自行控制。
10 |2、如果需要在 onClick 事件回调函数中进行跳转控制，那么请将 URL 地址保存在其他自定义的属性内，请勿使用 url
11 |默认值：无
12 |同超链接 href 属性
17 |var nodes = [
21 | { "id":1, "name":"Google CN", "url":"http://g.cn"},
22 | ......
23 | ]获取 treeNode 节点在同级节点中的位置。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |treeNode 节点在同级节点中的位置。(从 0 开始)
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var sNodes = treeObj.getSelectedNodes();
21 | if (sNodes.length > 0) {
22 | var node = sNodes[0].getIndex();
23 | }
24 | 获取 treeNode 节点的所有父节点（包括自己）。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |treeNode 节点的所有父节点的数据集合（包括自己）
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var sNodes = treeObj.getSelectedNodes();
21 | if (sNodes.length > 0) {
22 | var node = sNodes[0].getPath();
23 | }
24 | 拖拽时父节点自动展开是否触发 onExpand 事件回调函数。[setting.edit.enable = true 时生效]
9 |默认值：false
10 |true / false 分别表示 触发 / 不触发 onExpand 事件回调函数。
15 |var setting = {
19 | edit: {
20 | enable: true,
21 | drag: {
22 | autoExpandTrigger: true
23 | }
24 | }
25 | };
26 | ......The node data's attribute to save the node link's url.
9 |Special: If the nodes's data can only use the 'url' attribute, and don't use the link to jump feature, you can modify this attribute to any nonexistent attribute.
10 |Default: "url"
11 |var setting = {
16 | data: {
17 | key: {
18 | url: "xUrl"
19 | }
20 | }
21 | };
22 | ......When drag a node to root, the zTree's inner border width. (Unit: px) It is valid when [setting.edit.enable = true]
9 |Default: 10
10 |Please adjust the value according to needs.
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | borderMax: 20
20 | }
21 | }
22 | };
23 | ......When drag a node to root, the zTree's outer border width. (Unit: px) It is valid when [setting.edit.enable = true]
9 |Default: -5
10 |Please adjust the value according to needs.
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | borderMin: -10
20 | }
21 | }
22 | };
23 | ......The unique identifier of node.
9 |Do not initialize or modify it, it is created by the zTree.
10 |tId rules: setting.treeId + "_" + zTree counter
15 |var treeObj = $.fn.zTree.getZTreeObj("tree");
19 | var sNodes = treeObj.getSelectedNodes();
20 | if (sNodes.length > 0) {
21 | var tId = sNodes[0].tId;
22 | }
23 | 设置是否允许同时选中多个节点。
9 |默认值: true
10 |true / false 分别表示 支持 / 不支持 同时选中多个节点
15 |1、设置为 true时，按下 Ctrl 或 Cmd 键可以选中多个节点
16 |2、设置为 true / false 都不影响按下 Ctrl 或 Cmd 键可以让已选中的节点取消选中状态（ 取消选中状态可以参考 setting.view.autoCancelSelected ）
17 |var setting = {
21 | view: {
22 | selectedMulti: false
23 | }
24 | };
25 | ......The level of node
9 |Do not initialize or modify it, it is created by the zTree.
10 |The root node's level = 0, and next level = 1, ...
15 |var treeObj = $.fn.zTree.getZTreeObj("tree");
19 | var sNodes = treeObj.getSelectedNodes();
20 | if (sNodes.length > 0) {
21 | var level = sNodes[0].level;
22 | }
23 | The node's name
9 |1. If you want to change 'name' attribute, please modify the 'setting.data.key.name' attribute.
10 |Default: undenfined
11 |String object. The HTML special characters are escaped
16 |var nodes = [
20 | { "id":1, "name":"test1"},
21 | { "id":2, "name":"test2"},
22 | { "id":3, "name":"test3"}
23 | ]设置 zTree 是否开启异步加载模式
9 |默认值：false
10 |true 表示 开启 异步加载模式
15 |false 表示 关闭 异步加载模式
16 |如果设置为 true，请务必设置 setting.async 内的其它参数。
17 |如果需要根节点也异步加载，初始化时 treeNodes 参数设置为 null 即可。
18 |var setting = {
22 | async: {
23 | enable: true,
24 | url: "http://host/getNode.php",
25 | autoParam: ["id", "name"]
26 | }
27 | };
28 | ......Drag to the parent node, the parent node auto expand time interval. (Unit: ms) It is valid when [setting.edit.enable = true]
9 |Default: 500
10 |Please adjust the value according to needs.
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | autoOpenTime: 0
20 | }
21 | }
22 | };
23 | ......Ajax 获取的数据类型。[setting.async.enable = true 时生效]
9 |默认值："text"
10 |dataType = "text" 可以满足绝大部分请求
15 |其余 dataType 类型请参考 jQuery ajax 中的 dataType 参数
16 |var setting = {
20 | async: {
21 | enable: true,
22 | dataType: "text",
23 | url: "http://host/getNode.php",
24 | autoParam: ["id", "name"]
25 | }
26 | };
27 | ......获取与 treeNode 节点相邻的前一个节点。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |与 treeNode 节点相邻的前一个节点。
16 |如果 treeNode 是第一个节点，返回 null 。
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getSelectedNodes();
22 | if (sNodes.length > 0) {
23 | var node = sNodes[0].getPreNode();
24 | }
25 | 从 zTree v3.4 开始提供销毁 zTree 的方法。
9 |1、用此方法可以销毁 zTreeObj 代表的 zTree。
10 |2、销毁当前页面全部的 zTree，也可以使用 $.fn.zTree.destroy() 方法。
11 |3、重新使用已经被销毁的树，必须要使用 init 方法进行初始化。
12 |目前无任何返回值
18 |var zTreeObj = $.fn.zTree.getZTreeObj("treeDemo");
22 | zTreeObj.destroy();
23 | The node data's attribute to save the 'title' attribute of node DOM. It is valid when [setting.view.showTitle = true]
9 |If set it to "", the title of node DOM will be same as 'setting.data.key.name' attribute.
10 |Default: ""
11 |var setting = {
16 | data: {
17 | key: {
18 | title: "fullName"
19 | }
20 | }
21 | };
22 | ......获取与 treeNode 节点相邻的后一个节点。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |与 treeNode 节点相邻的后一个节点。
16 |如果 treeNode 是最后一个节点，返回 null 。
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getSelectedNodes();
22 | if (sNodes.length > 0) {
23 | var node = sNodes[0].getNextNode();
24 | }
25 | 获取 treeNode 节点的父节点。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |treeNode 节点的父节点 JSON 数据对象。
16 |如果 treeNode 是根节点，返回 null 。
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getSelectedNodes();
22 | if (sNodes.length > 0) {
23 | var node = sNodes[0].getParentNode();
24 | }
25 | Set to allow or don't allow to select the text which in zTree's DOM.
9 |Default: false
10 |true means: Allow to select the txt which in zTree's DOM.
15 |false means: Don't allow to select the txt which in zTree's DOM.
16 |var setting = {
20 | view: {
21 | txtSelectedEnable: true
22 | }
23 | };
24 | ......radio 的分组范围。[setting.check.enable = true 且 setting.check.chkStyle = "radio" 时生效]
9 |默认值："level"
10 |radioType = "level" 时，在每一级节点范围内当做一个分组。
15 |
radioType = "all" 时，在整棵树范围内当做一个分组。
请注意大小写，不要改变
17 |var setting = {
21 | check: {
22 | enable: true,
23 | chkStyle: "radio",
24 | radioType: "all"
25 | }
26 | };
27 | ......最简单的 click 事件操作。相当于 onclick="..." 的内容。 如果操作较复杂，请使用 onClick 事件回调函数。
9 |由于 IE 对于 onclick 和 click事件共存时的处理与其他浏览器不同，所以请不要利用此参数控制是否允许跳转的操作（例如：treeNode.click = "return false;"）。如有类似需求，请不要使用 url 属性设置网址，同时利用 onClick 回调函数控制跳转。
10 |默认值：无
11 |标准 javascript 语法， 例如：alert("test"); 等
16 |var nodes = [
20 | { "id":1, "name":"Google CN", "url":"http://g.cn", "click":"alert('test');"},
21 | ......
22 | ]Ajax 的 http 请求模式。[setting.async.enable = true 时生效]
9 |默认值："post"
10 |type = "post" 表示异步加载采用 post 方法请求
15 |type = "get" 表示异步加载采用 get 方法请求
16 |对应于 jQuery ajax 中的 type 参数
17 |var setting = {
21 | async: {
22 | enable: true,
23 | type: "get",
24 | url: "http://host/getNode.php",
25 | autoParam: ["id", "name"]
26 | }
27 | };
28 | ......判断 treeNode 节点是否被隐藏。
9 |1、初始化 zTree 时，如果节点设置 isHidden = true，会被自动隐藏
10 |2、请勿对已加载的节点修改此属性，隐藏 / 显示 请使用 hideNode() / hideNodes() / showNode() / showNodes() 方法
11 |true 表示被隐藏
16 |false 表示被显示
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getNodes();
22 | if (sNodes.length > 0) {
23 | var isHidden = sNodes[0].isHidden;
24 | }
25 | 设置 zTree 进入 / 取消 编辑状态。
9 |对于编辑状态的各种功能需要提前设置对应 setting 中的不同属性
10 |请通过 zTree 对象执行此方法。
11 |true 表示进入 编辑状态
17 |false 表示取消 编辑状态
18 |目前无任何返回值
20 |var treeObj = $.fn.zTree.getZTreeObj("tree");
24 | treeObj.setEditable(true);
25 | Get the JSON data objects collection of the selected nodes in zTree.
9 |Please use zTree object to executing the method.
10 |The JSON data objects collection of the selected nodes.
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var nodes = treeObj.getSelectedNodes();
21 | zTree 节点展开、折叠时的动画速度，设置方法同 JQuery 动画效果中 speed 参数。
9 |IE6 下会自动关闭动画效果，以保证 zTree 的操作速度
10 |默认值："fast"
11 |三种预定速度之一的字符串("slow", "normal", or "fast")
16 |设置为 "" 时，不显示动画效果
17 |表示动画时长的毫秒数值 (如：1000)
21 |var setting = {
25 | view: {
26 | expandSpeed: "slow"
27 | }
28 | };
29 | ......When dragging more than one sibling node, the floating layer shows the maximum number of nodes. zTree using '...' instead of redundant nodes. It is valid when [setting.edit.enable = true]
9 |Default: 5
10 |Please adjust the value according to needs.
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | maxShowNodeNum: 10
20 | }
21 | }
22 | };
23 | ......节点数据中保存唯一标识的属性名称。[setting.data.simpleData.enable = true 时生效]
9 |默认值："id"
10 |var setting = {
15 | data: {
16 | simpleData: {
17 | enable: true,
18 | idKey: "id",
19 | pIdKey: "pId",
20 | rootPId: 0
21 | }
22 | }
23 | };
24 | var treeNodes = [
25 | {"id":1, "pId":0, "name":"test1"},
26 | {"id":11, "pId":1, "name":"test11"},
27 | {"id":12, "pId":1, "name":"test12"},
28 | {"id":111, "pId":11, "name":"test111"}
29 | ];
30 | ......节点数据中保存其父节点唯一标识的属性名称。[setting.data.simpleData.enable = true 时生效]
9 |默认值："pId"
10 |var setting = {
15 | data: {
16 | simpleData: {
17 | enable: true,
18 | idKey: "id",
19 | pIdKey: "pId",
20 | rootPId: 0
21 | }
22 | }
23 | };
24 | var treeNodes = [
25 | {"id":1, "pId":0, "name":"test1"},
26 | {"id":11, "pId":1, "name":"test11"},
27 | {"id":12, "pId":1, "name":"test12"},
28 | {"id":111, "pId":11, "name":"test111"}
29 | ];
30 | ......获取 zTree 的全部节点数据
9 |请通过 zTree 对象执行此方法。
10 |全部节点数据
16 |1、Array 仅仅是根节点的集合（默认情况子节点都处于 children 属性下）；
17 |2、如需遍历全部节点需要利用递归，或利用 transformToArray 方法 将数据变成简单的 Array 集合
18 |3、对于异步加载模式下，尚未加载的子节点是无法通过此方法获取的。
19 |var treeObj = $.fn.zTree.getZTreeObj("tree");
23 | var nodes = treeObj.getNodes();
24 | The minimum offset which used to determine the drag operator start. (Unit: px) It is valid when [setting.edit.enable = true]
9 |Please adjust the value according to needs. Note: If it is too small, will easily lead to misoperation when you click mouse.
10 |Default: 5
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | minMoveSize: 10
20 | }
21 | }
22 | };
23 | ......将 zTree 使用的标准 JSON 嵌套格式的数据转换为简单 Array 格式。(免去用户自行编写递归遍历全部节点的麻烦)
9 |请通过 zTree 对象执行此方法。
10 |需要被转换的 zTree 节点数据对象集合 或 某个单独节点的数据对象
16 |转换后的简单 Array 数据格式
18 |var treeObj = $.fn.zTree.getZTreeObj("tree");
22 | var nodes = treeObj.transformToArray(treeObj.getNodes());
23 | 当父节点设置 nocheck = true 时，设置子节点是否自动继承 nocheck = true 。[setting.check.enable = true 时生效]
9 |1、只使用于初始化节点时，便于批量操作。 对于已存在的节点请利用 updateNode 方法单个节点设置。
10 |默认值: false
11 |true 表示 新加入子节点时，自动继承父节点 nocheck = true 的属性。
16 |false 表示 新加入子节点时，不继承父节点 nocheck 的属性。
17 |var setting = {
21 | check: {
22 | enable: true,
23 | nocheckInherit: true
24 | }
25 | };
26 | ......Used to set the target where the node is clicked to open url. It is valid when [treeNode.url exists]
9 |Default: undefined
10 |As same as <a> tag's 'target' attribute. e.g. '_blank', '_self' or other window name.
15 |if this attribute is omitted, zTree default set it to '_blank'
16 |var nodes = [
20 | { "id":1, "name":"test1", "url":"http://myTest.com", "target":"_blank"},
21 | ......
22 | ]用于修正根节点父节点数据，即 pIdKey 指定的属性值。[setting.data.simpleData.enable = true 时生效]
9 |默认值：null
10 |var setting = {
15 | data: {
16 | simpleData: {
17 | enable: true,
18 | idKey: "id",
19 | pIdKey: "pId",
20 | rootPId: 0
21 | }
22 | }
23 | };
24 | var treeNodes = [
25 | {"id":1, "pId":0, "name":"test1"},
26 | {"id":11, "pId":1, "name":"test11"},
27 | {"id":12, "pId":1, "name":"test12"},
28 | {"id":111, "pId":11, "name":"test111"}
29 | ];
30 | ......记录 treeNode 节点是否为同级节点中的第一个节点。
9 |使用 exhide 扩展后，只针对显示的节点设置此属性
10 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
11 |true 表示是同级节点中的第一个节点
16 |false 表示不是同级节点中的第一个节点
17 |节点被隐藏后，isFirstNode = false
18 |var treeObj = $.fn.zTree.getZTreeObj("tree");
22 | var sNodes = treeObj.getSelectedNodes();
23 | if (sNodes.length > 0) {
24 | var isFirstNode = sNodes[0].isFirstNode;
25 | }
26 | 记录 treeNode 节点是否为同级节点中的最后一个节点。
9 |使用 exhide 扩展后，只针对显示的节点设置此属性
10 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
11 |true 表示是同级节点中的最后一个节点
16 |false 表示不是同级节点中的最后一个节点
17 |节点被隐藏后，isLastNode = false
18 |var treeObj = $.fn.zTree.getZTreeObj("tree");
22 | var sNodes = treeObj.getSelectedNodes();
23 | if (sNodes.length > 0) {
24 | var isLastNode = sNodes[0].isLastNode;
25 | }
26 | Set to use HTML in 'name' attribute.
9 |If allow HTML, please do check to avoid security issues, e.g. JavaScript Injection...
10 |Default: false
11 |true means: 'name' attribute can be HTML.
16 |false means: 'name' attribute is only TEXT.
17 |var setting = {
21 | view: {
22 | nameIsHTML: true
23 | }
24 | };
25 | var node = {"name":"<font color='red'>test</font>"};
26 | ......zTree v3.x 专门提供的根据 treeId 获取 zTree 对象的方法。
9 |必须在初始化 zTree 以后才可以使用此方法。
10 |有了这个方法，用户不再需要自己设定全局变量来保存 zTree 初始化后得到的对象了，而且在所有回调函数中全都会返回 treeId 属性，用户可以随时使用此方法获取需要进行操作的 zTree 对象
11 |zTree 的 DOM 容器的 id
17 |zTree 对象，提供操作 zTree 的各种方法，对于通过 js 操作 zTree 来说必须通过此对象
19 |var treeObj = $.fn.zTree.getZTreeObj("tree");根据 zTree 的唯一标识 tId 快速获取节点 JSON 数据对象
9 |通过内部的 cache 获取，不需要遍历节点。
10 |请通过 zTree 对象执行此方法。
11 |节点在 zTree 内的唯一标识 tId
17 |tId 对应的节点 JSON 数据对象
19 |如无结果，返回 null
20 |var treeObj = $.fn.zTree.getZTreeObj("tree");
24 | var node = treeObj.getNodeByTId("tree_10");
25 | 1、设置节点是否隐藏 checkbox / radio [setting.check.enable = true 时有效]
9 |2、为了解决部分朋友生成 json 数据出现的兼容问题, 支持 "false","true" 字符串格式的数据
10 |默认值：false
11 |true 表示此节点不显示 checkbox / radio，不影响勾选的关联关系，不影响父节点的半选状态。
16 |false 表示节点具有正常的勾选功能
17 |var nodes = [
21 | { "id":1, "name":"test1", "nocheck":true},
22 | { "id":2, "name":"test2"},
23 | { "id":3, "name":"test3"}
24 | ]获取输入框勾选状态被改变的节点集合（与原始数据 checkedOld 对比）。[setting.check.enable = true 时有效]
9 |请通过 zTree 对象执行此方法。
10 |返回全部勾选状态被改变的节点集合 Array
16 |如果需要获取每次操作后全部被改变勾选状态的节点数据，请在每次勾选操作后，遍历所有被改变勾选状态的节点数据，让其 checkedOld = checked 就可以了。
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var nodes = treeObj.getChangeCheckedNodes();
22 | 记录 treeNode 节点是否已经进行过异步加载，避免父节点反复异步加载数据。
9 |初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
10 |默认值：false （无子节点的父节点）； true （有子节点的父节点 & 叶子节点）
11 |true 表示父节点展开时不需要自动异步加载
16 |false 表示父节点展开时需要自动异步加载
17 |此参数不会对 reAsyncChildNodes 方法造成任何影响
18 |var treeObj = $.fn.zTree.getZTreeObj("tree");
22 | var sNodes = treeObj.getSelectedNodes();
23 | if (sNodes.length > 0) {
24 | var zAsync = sNodes[0].zAsync;
25 | }
26 | Get the treeNode's index in its parent node's children.
9 |Do not initialize or modify it, it is created by the zTree.
10 |the treeNode's index in its parent node's children. ( start at 0 )
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var sNodes = treeObj.getSelectedNodes();
21 | if (sNodes.length > 0) {
22 | var node = sNodes[0].getIndex();
23 | }
24 | Get the treeNode's all parent nodes. (Include itself)
9 |Do not initialize or modify it, it is created by the zTree.
10 |Array of treeNode's all parent nodes. (Include itself)
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var sNodes = treeObj.getSelectedNodes();
21 | if (sNodes.length > 0) {
22 | var node = sNodes[0].getPath();
23 | }
24 | 拖拽时, 设置是否允许复制节点。[setting.edit.enable = true 时生效]
9 |默认值：true
10 |1、isCopy = true; isMove = true 时，拖拽节点按下 Ctrl 或 Cmd 键表示 copy; 否则为 move
15 |2、isCopy = true; isMove = false 时，所有拖拽操作都是 copy
16 |3、isCopy = false; isMove = true 时，所有拖拽操作都是 move
17 |4、isCopy = false; isMove = false 时，禁止拖拽操作
18 |var setting = {
22 | edit: {
23 | enable: true,
24 | drag: {
25 | isCopy: true,
26 | isMove: false
27 | }
28 | }
29 | };
30 | ......拖拽时, 设置是否允许移动节点。[setting.edit.enable = true 时生效]
9 |默认值：true
10 |1、isCopy = true; isMove = true 时，拖拽节点按下 Ctrl 或 Cmd 键表示 copy; 否则为 move
15 |2、isCopy = true; isMove = false 时，所有拖拽操作都是 copy
16 |3、isCopy = false; isMove = true 时，所有拖拽操作都是 move
17 |4、isCopy = false; isMove = false 时，禁止拖拽操作
18 |var setting = {
22 | edit: {
23 | enable: true,
24 | drag: {
25 | isCopy: false,
26 | isMove: true
27 | }
28 | }
29 | };
30 | ......Http request tyoe in ajax. It is valid when [setting.async.enable = true]
9 |Default: "post"
10 |"post" - http request mode
15 |"get" - http request mode
16 |Both zTree and jQuery's this 'type' for ajax requests.
17 |var setting = {
21 | async: {
22 | enable: true,
23 | type: "get",
24 | url: "http://host/getNode.php",
25 | autoParam: ["id", "name"]
26 | }
27 | };
28 | ......Ajax 提交参数的数据类型。[setting.async.enable = true 时生效]
9 |默认值："application/x-www-form-urlencoded"
10 |contentType = "application/x-www-form-urlencoded" 可以满足绝大部分请求，按照标准的 Form 格式提交参数
15 |contentType = "application/json" 可以满足 .Net 的编程需要，按照 JSON 格式提交参数
16 |var setting = {
20 | async: {
21 | enable: true,
22 | contentType: "application/json",
23 | url: "http://host/getNode.php",
24 | autoParam: ["id", "name"]
25 | }
26 | };
27 | ......当父节点设置 chkDisabled = true 时，设置子节点是否自动继承 chkDisabled = true 。[setting.check.enable = true 时生效]
9 |1、只使用于初始化节点时，便于批量操作。 对于已存在的节点请利用 setChkDisabled 方法单个节点设置。
10 |默认值: false
11 |true 表示 新加入子节点时，自动继承父节点 chkDisabled = true 的属性。
16 |false 表示 新加入子节点时，不继承父节点 chkDisabled 的属性。
17 |var setting = {
21 | check: {
22 | enable: true,
23 | chkDisabledInherit: true
24 | }
25 | };
26 | ......勾选 checkbox 对于父子节点的关联关系。[setting.check.enable = true 且 setting.check.chkStyle = "checkbox" 时生效]
9 |默认值：{ "Y": "ps", "N": "ps" }
10 |Y 属性定义 checkbox 被勾选后的情况；
15 |
N 属性定义 checkbox 取消勾选后的情况；
16 |
"p" 表示操作会影响父级节点；
17 |
"s" 表示操作会影响子级节点。
请注意大小写，不要改变
19 |var setting = {
23 | check: {
24 | enable: true,
25 | chkStyle: "checkbox",
26 | chkboxType: { "Y": "p", "N": "s" }
27 | }
28 | };
29 | ......节点的 checkBox / radio 在初始化时的 勾选状态。[setting.check.enable = true & treeNode.nocheck = false 时有效]
9 |1、zTree 初始化节点数据时会对此属性进行赋值，因此请勿对此属性初始化
10 |2、如需配合 zTreeObj.getChangeCheckedNodes 方法实现特殊功能，可以根据需求在使用中自行修改 checkedOld 数据
11 |默认值：checked的初始化值
12 |true 表示节点初始化时 输入框被勾选
17 |false 表示节点初始化时 输入框未勾选
18 |var treeObj = $.fn.zTree.getZTreeObj("tree");
22 | var checkedOld = treeObj.getNodes()[0].checkedOld;
23 | treeNode 节点的父节点唯一标识 tId。
9 |1、v3.x 用 parentTId 替换了原先的 parentNode 属性，同时增加了 getParentNode 方法，以避免原先 parentNode 造成的 clone 死循环
10 |2、初始化节点数据时，由 zTree 增加此属性，请勿提前赋值
11 |zTree 内部生成的节点唯一标识，请参考 treeNode.tId 的说明
16 |如果 treeNode 是根节点，则 parentTId = null
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getSelectedNodes();
22 | if (sNodes.length > 0) {
23 | var parentTId = sNodes[0].parentTId;
24 | }
25 | Refresh zTree
9 |If you have no special need, try not to use this method. If you refresh single node, please use updateNode() method. If you refresh child nodes in dynamic mode, please use the reAsyncChildNodes() method.
10 |Please use zTree object to executing the method.
11 |no return value
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | treeObj.refresh();
22 | When edit node's name, the text in input is selected or unselected. It is valid when [setting.edit.enable = true]
9 |Default: false
10 |true means: when show the input, the text in input is selected
15 |false means: when show the input, the text in input is not selected
16 |var setting = {
20 | edit: {
21 | enable: true,
22 | editNameSelectAll: true
23 | }
24 | };
25 | ......记录 treeNode 节点是否为父节点。
9 |1、初始化节点数据时，根据 treeNode.children 属性判断，有子节点则设置为 true，否则为 false
10 |2、初始化节点数据时，如果设定 treeNode.isParent = true，即使无子节点数据，也会设置为父节点
11 |3、为了解决部分朋友生成 json 数据出现的兼容问题, 支持 "false","true" 字符串格式的数据
12 |true 表示是父节点
17 |false 表示不是父节点
18 |var treeObj = $.fn.zTree.getZTreeObj("tree");
22 | var sNodes = treeObj.getSelectedNodes();
23 | if (sNodes.length > 0) {
24 | var isParent = sNodes[0].isParent;
25 | }
26 | The data type of Ajax requests. It is valid when [setting.async.enable = true]
9 |Default："text"
10 |dataType = "text", There is probably no need to change this.
15 |The 'dataType' in zTree and jQuery's ajax requests is same.
16 |var setting = {
20 | async: {
21 | enable: true,
22 | dataType: "text",
23 | url: "http://host/getNode.php",
24 | autoParam: ["id", "name"]
25 | }
26 | };
27 | ......The leaf node's lock, the leaf node will lock the 'isParent' attribute to false.
9 |Default: false
10 |true means: lock the leaf node, and the node which 'isParent' attribute is false can't add child nodes.
15 |false means: don't lock the leaf node, and the node which 'isParent' attribute is false can add child nodes.
16 |var setting = {
20 | data: {
21 | keep: {
22 | leaf: true
23 | }
24 | }
25 | };
26 | ......The node data's attribute to save node data's unique identifier. It is valid when [setting.data.simpleData.enable = true]
9 |Default: "id"
10 |var setting = {
15 | data: {
16 | simpleData: {
17 | enable: true,
18 | idKey: "id",
19 | pIdKey: "pId",
20 | rootPId: 0
21 | }
22 | }
23 | };
24 | var treeNodes = [
25 | {"id":1, "pId":0, "name":"test1"},
26 | {"id":11, "pId":1, "name":"test11"},
27 | {"id":12, "pId":1, "name":"test12"},
28 | {"id":111, "pId":11, "name":"test111"}
29 | ];
30 | ......Set whether to allow select multiple nodes.
9 |Default: true
10 |true mean: you can select multiple nodes.
15 |false mean: you can only select one node.
16 |1. Press Ctrl-key or Cmd-key, you can select multiple nodes.
17 |2、This attribute don't affect the feature of cancel select node. ( please see setting.view.autoCancelSelected )
18 |var setting = {
22 | view: {
23 | selectedMulti: false
24 | }
25 | };
26 | ......Get the treeNode's parent node.
9 |Do not initialize or modify it, it is created by the zTree.
10 |JSON data object of treeNode's parent node.
16 |If treeNode is root, return null.
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getSelectedNodes();
22 | if (sNodes.length > 0) {
23 | var node = sNodes[0].getParentNode();
24 | }
25 | 设置自动关联勾选时是否触发 beforeCheck / onCheck 事件回调函数。[setting.check.enable = true 且 setting.check.chkStyle = "checkbox" 时生效]
9 |1、如果设置 setting.check.chkboxType = { "Y": "", "N": "" }，将不会有任何自动关联勾选的操作。
10 |2、如果开启触发，对于节点较多的树将会影响性能，因为所有被联动勾选的操作都会触发事件回调函数，请根据需要决定是否使用此功能。
11 |默认值: false
12 |true / false 分别表示 触发 / 不触发 事件回调函数
17 |var setting = {
21 | check: {
22 | enable: true,
23 | autoCheckTrigger: true
24 | }
25 | };
26 | ......隐藏某个节点。
9 |1、此功能不支持 exedit 扩展，因此不要在编辑状态时使用隐藏节点的方法。
10 |2、隐藏/显示节点，会影响节点的 isFirstNode 和 isLastNode 属性。
11 |3、请通过 zTree 对象执行此方法。
12 |指定被隐藏的节点 JSON 数据
18 |请务必保证此节点数据对象 是 zTree 内部的数据对象
19 |目前无任何返回值
21 |var treeObj = $.fn.zTree.getZTreeObj("tree");
25 | var nodes = treeObj.getNodes();
26 | treeObj.hideNode(nodes[0]);
27 | The node data's attribute to save its parent node data's unique identifier. It is valid when [setting.data.simpleData.enable = true]
9 |Default: "pId"
10 |var setting = {
15 | data: {
16 | simpleData: {
17 | enable: true,
18 | idKey: "id",
19 | pIdKey: "pId",
20 | rootPId: 0
21 | }
22 | }
23 | };
24 | var treeNodes = [
25 | {"id":1, "pId":0, "name":"test1"},
26 | {"id":11, "pId":1, "name":"test11"},
27 | {"id":12, "pId":1, "name":"test12"},
28 | {"id":111, "pId":11, "name":"test111"}
29 | ];
30 | ......When click the selected node while pressing the Ctrl-key or Cmd-key, allow to cancel selected the node.
9 |If you don't need this function, please set to false.
10 |Default: true
11 |true means: press the Ctrl-key or Cmd-key, can cancel selected node.
16 |false means: press the Ctrl-key or Cmd-key, can't cancel selected node.
17 |var setting = {
21 | view: {
22 | autoCancelSelected: false
23 | }
24 | };
25 | ......Set the default value of root's 'pIdKey' specified attribute values. It is valid when [setting.data.simpleData.enable = true]
9 |Default: null
10 |var setting = {
15 | data: {
16 | simpleData: {
17 | enable: true,
18 | idKey: "id",
19 | pIdKey: "pId",
20 | rootPId: 0
21 | }
22 | }
23 | };
24 | var treeNodes = [
25 | {"id":1, "pId":0, "name":"test1"},
26 | {"id":11, "pId":1, "name":"test11"},
27 | {"id":12, "pId":1, "name":"test12"},
28 | {"id":111, "pId":11, "name":"test111"}
29 | ];
30 | ......When drag node cause the parent node is automatically expanded, set whether to allow to trigger the 'onExpand' callback. It is valid when [setting.edit.enable = true]
9 |Default: false
10 |true means: trigger the 'onExpand' callback.
15 |false means: don't trigger the 'onExpand' callback.
16 |var setting = {
20 | edit: {
21 | enable: true,
22 | drag: {
23 | autoExpandTrigger: true
24 | }
25 | }
26 | };
27 | ......Get the treeNode's next sibling node.
9 |Do not initialize or modify it, it is created by the zTree.
10 |JSON data object of the treeNode's next sibling node
16 |If have not the next node, return null.
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getSelectedNodes();
22 | if (sNodes.length > 0) {
23 | var node = sNodes[0].getNextNode();
24 | }
25 | 展开 / 折叠 全部节点
9 |此方法不会触发 beforeExpand / onExpand 和 beforeCollapse / onCollapse 事件回调函数。
10 |请通过 zTree 对象执行此方法。
11 |expandFlag = true 表示 展开 全部节点
17 |expandFlag = false 表示 折叠 全部节点
18 |返回值表示最终实际操作情况
20 |true 表示 展开 全部节点
21 |false 表示 折叠 全部节点
22 |null 表示 不存在任何父节点
23 |var treeObj = $.fn.zTree.getZTreeObj("tree");
27 | treeObj.expandAll(true);
28 | 取消节点的编辑名称状态，可以恢复原名称，也可以强行赋给新的名称。
9 |请通过 zTree 对象执行此方法。
10 |重新给定的新名称。
16 |如果省略此参数，则恢复原名称。
17 |目前无任何返回值
19 |var treeObj = $.fn.zTree.getZTreeObj("tree");
23 | treeObj.cancelEditName();
24 | var treeObj = $.fn.zTree.getZTreeObj("tree");
27 | treeObj.cancelEditName("test_new_name");
28 | 获取某节点在同级节点中的序号（从0开始）
9 |请通过 zTree 对象执行此方法。
10 |需要查询顺序的节点 JSON 数据对象
16 |请务必保证此节点数据对象 是 zTree 内部的数据对象
17 |返回值从 0 开始计数
19 |如果不存在该节点数据，返回 -1
20 |var treeObj = $.fn.zTree.getZTreeObj("tree");
24 | var nodes = treeObj.getSelectedNodes();
25 | if (nodes.length>0) {
26 | var index = treeObj.getNodeIndex(nodes[0]);
27 | }
28 | Get the treeNode's previous sibling node.
9 |Do not initialize or modify it, it is created by the zTree.
10 |JSON data object of the treeNode's previous sibling node
16 |If have not the previous node, return null.
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | var sNodes = treeObj.getSelectedNodes();
22 | if (sNodes.length > 0) {
23 | var node = sNodes[0].getPreNode();
24 | }
25 | 设置某节点进入编辑名称状态。
9 |1、如果需要用 js 取消编辑名称状态，请使用 cancelEditName(newName) 方法。
10 |2、可利用此方法让当前正编辑的节点 input 输入框获取焦点。
11 |3、请通过 zTree 对象执行此方法。
12 |指定进入编辑名称状态的节点 JSON 数据
18 |请务必保证此节点数据对象 是 zTree 内部的数据对象
19 |目前无任何返回值
21 |var treeObj = $.fn.zTree.getZTreeObj("tree");
25 | var nodes = treeObj.getNodes();
26 | treeObj.editName(nodes[0]);
27 | Judge whether the node's child nodes being loaded asynchronously.
9 |Do not initialize or modify it, it is created by the zTree.
10 |true means: the node's child nodes is being loaded asynchronously
15 |false means: the node's child nodes is not being loaded asynchronously
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var sNodes = treeObj.getSelectedNodes();
21 | if (sNodes.length > 0) {
22 | var isAjaxing = sNodes[0].isAjaxing;
23 | }
24 | Edit mode and normal mode switch.
9 |To use edit mode, please set the attributes in 'setting.edit'
10 |Please use zTree object to executing the method.
11 |true means: set zTree to edit mode.
17 |false means: set zTree to normal mode.
18 |no return value
20 |var treeObj = $.fn.zTree.getZTreeObj("tree");
24 | treeObj.setEditable(true);
25 | 隐藏一批节点。
9 |1、此功能不支持 exedit 扩展，因此不要在编辑状态时使用隐藏节点的方法。
10 |2、隐藏/显示节点，会影响节点的 isFirstNode 和 isLastNode 属性。
11 |3、请通过 zTree 对象执行此方法。
12 |指定被隐藏的节点 JSON 数据集合
18 |请务必保证这些节点数据对象 是 zTree 内部的数据对象
19 |目前无任何返回值
21 |var treeObj = $.fn.zTree.getZTreeObj("tree");
25 | var nodes = treeObj.getNodes();
26 | treeObj.hideNodes(nodes[0].children);
27 | The URL of node link
9 |1. In edit mode (setting.edit.enable = true) , this feature fails. If you must use a similar feature, please use the 'onClick' callback for their own control.
10 |2. If you use the 'onClick' callback function to control opening URL , then set the URL in the other custom attribute, do not use the 'url' attribute.
11 |Default: undefined
12 |As same as <a> tag's 'href' attribute.
17 |var nodes = [
21 | { "id":1, "name":"Google CN", "url":"http://g.cn"},
22 | ......
23 | ]父节点自定义折叠时图标的 URL 路径。
9 |1、此属性只针对父节点有效
10 |2、此属性必须与 iconOpen 同时使用
11 |3、如果想利用 className 设置个性化图标，需要设置 treeNode.iconSkin 属性
12 |默认值：无
13 |图标图片的 url 可以是相对路径也可以是绝对路径
18 |设置相对路径请注意页面与图片之间的关系，确保图片能够正常加载
19 |var nodes = [
23 | //父节点展开 折叠时使用相同的图标
24 | { name:"父节点1", icon:"/img/parent.gif"},
25 |
26 | //父节点展开 折叠时分别使用不同的图标
27 | { name:"父节点2", iconOpen:"/img/open.gif", iconClose:"/img/close.gif"},
28 |
29 | //叶子节点个性化图标
30 | { name:"叶子节点", icon:"/img/leaf.gif"}
31 | ]父节点自定义展开时图标的 URL 路径。
9 |1、此属性只针对父节点有效
10 |2、此属性必须与 iconClose 同时使用
11 |3、如果想利用 className 设置个性化图标，需要设置 treeNode.iconSkin 属性
12 |默认值：无
13 |图标图片的 url 可以是相对路径也可以是绝对路径
18 |设置相对路径请注意页面与图片之间的关系，确保图片能够正常加载
19 |var nodes = [
23 | //父节点展开 折叠时使用相同的图标
24 | { name:"父节点1", icon:"/img/parent.gif"},
25 |
26 | //父节点展开 折叠时分别使用不同的图标
27 | { name:"父节点2", iconOpen:"/img/open.gif", iconClose:"/img/close.gif"},
28 |
29 | //叶子节点个性化图标
30 | { name:"叶子节点", icon:"/img/leaf.gif"}
31 | ]显示一批已经被隐藏的节点。
9 |1、此功能不支持 exedit 扩展，因此不要在编辑状态时使用隐藏节点的方法。
10 |2、隐藏/显示节点，会影响节点的 isFirstNode 和 isLastNode 属性。
11 |3、请通过 zTree 对象执行此方法。
12 |指定被显示的节点 JSON 数据集合
18 |请务必保证这些节点数据对象 是 zTree 内部的数据对象
19 |目前无任何返回值
21 |var treeObj = $.fn.zTree.getZTreeObj("tree");
25 | var nodes = treeObj.getNodesByParam("isHidden", true);
26 | treeObj.showNodes(nodes);
27 | 从 zTree v3.4 开始提供销毁 zTree 的方法。
9 |1、用此方法可以销毁指定 treeId 的 zTree，也可以销毁当前页面全部的 zTree。
10 |2、销毁指定 treeId 的 zTree 也可以使用 zTreeObj.destroy() 方法。
11 |3、重新使用已经被销毁的树，必须要使用 init 方法进行初始化。
12 |zTree 的 DOM 容器的 id
18 |省略 treeId，表示销毁当前页面全部的 zTree
19 |目前无任何返回值
21 |$.fn.zTree.destroy("treeDemo");$.fn.zTree.destroy();显示某个被隐藏的节点。
9 |1、此功能不支持 exedit 扩展，因此不要在编辑状态时使用隐藏节点的方法。
10 |2、隐藏/显示节点，会影响节点的 isFirstNode 和 isLastNode 属性。
11 |3、请通过 zTree 对象执行此方法。
12 |指定被显示的节点 JSON 数据
18 |请务必保证此节点数据对象 是 zTree 内部的数据对象
19 |目前无任何返回值
21 |var treeObj = $.fn.zTree.getZTreeObj("tree");
25 | var node = treeObj.getNodeByParam("isHidden", true);
26 | if (node) {
27 | treeObj.showNode(node);
28 | }
29 | The group about radio. It is valid when [setting.check.enable = true & setting.check.chkStyle = "radio"]
9 |Default: "level"
10 |When radioType = "level", will be grouped with same level nodes which have the same parent node.
15 |
When radioType = "all", will be grouped with all nodes.
Please note that letter case, do not change.
17 |var setting = {
21 | check: {
22 | enable: true,
23 | chkStyle: "radio",
24 | radioType: "all"
25 | }
26 | };
27 | ......记录 treeNode 节点的 展开 / 折叠 状态。
9 |1、初始化节点数据时，如果设定 treeNode.open = true，则会直接展开此节点
10 |2、叶子节点 treeNode.open = false
11 |3、为了解决部分朋友生成 json 数据出现的兼容问题, 支持 "false","true" 字符串格式的数据
12 |4、非异步加载模式下，无子节点的父节点设置 open=true 后，可显示为展开状态，但异步加载模式下不会生效。（v3.5.15+）
13 |默认值：false
14 |true 表示节点为 展开 状态
19 |false 表示节点为 折叠 状态
20 |var treeObj = $.fn.zTree.getZTreeObj("tree");
24 | var sNodes = treeObj.getSelectedNodes();
25 | if (sNodes.length > 0) {
26 | var isOpen = sNodes[0].open;
27 | }
28 | 获取输入框被勾选 或 未勾选的节点集合。[setting.check.enable = true 时有效]
9 |请通过 zTree 对象执行此方法。
10 |checked = true 表示获取 被勾选 的节点集合
16 |checked = false 表示获取 未勾选 的节点集合
17 |省略此参数，等同于 true。
18 |对于 treeNode.nocheck = true 的节点不进行获取。
19 |返回全部符合要求的节点集合 Array
21 |var treeObj = $.fn.zTree.getZTreeObj("tree");
25 | var nodes = treeObj.getCheckedNodes(true);
26 | The parent node's lock, the parent node will lock 'isParent' attribute to true.
9 |Default: false
10 |true means: lock the parent node, and if remove all of the parent node's child nodes, its 'isParent' attribute still keep to be true..
15 |false means: don't lock the parent node, and if remove all of the parent node's child nodes, its 'isParent' attribute will change to be false..
16 |var setting = {
20 | data: {
21 | keep: {
22 | parent: true
23 | }
24 | }
25 | };
26 | ......From zTree v3.4, zTree support the method for destruction.
9 |1. This method can destroy the zTreeObj's zTree.
10 |2. If you want to destory all of the zTrees, you can use the '$.fn.zTree.destroy()' method.
11 |3. If you want to use the tree which has been destroyed, you must use the 'init()' method at first.
12 |no return value
18 |var zTreeObj = $.fn.zTree.getZTreeObj("treeDemo");
22 | zTreeObj.destroy();
23 | Set zTree asynchronous loading mode on/off.
9 |Default: false
10 |true - turn on asynchronous loading mode
15 |false - turn off asynchronous loading mode
16 |If set it is true, you must set other attributes in setting.async
17 |If you don't pass the 'treeNodes' parameter when you initialize zTree, the root nodes will be retrieved using ajax.
18 |var setting = {
22 | async: {
23 | enable: true,
24 | url: "http://host/getNode.php",
25 | autoParam: ["id", "name"]
26 | }
27 | };
28 | ......节点的子节点数据集合。
9 |1、如果不使用 children 属性保存子节点数据，请修改 setting.data.key.children
10 |2、异步加载时，对于设置了 isParent = true 的节点，在展开时将进行异步加载
11 |默认值：无
12 |标准的 JSON 数据对象
17 |var nodes = [
21 | { "id":1, "name":"test1",
22 | children: [
23 | { "id":3, "name":"test3"},
24 | { "id":4, "name":"test4"},
25 | { "id":5, "name":"test5"}
26 | ]
27 | },
28 | { "id":2, "name":"test2" }
29 | ]var treeObj = $.fn.zTree.getZTreeObj("tree");
32 | var nodes = treeObj.getNodes()[0].children;
33 | The animation speed of expand or collapse node. As same as 'speed' parameter in jQuery
9 |In order to ensure zTree operating speed, if use the IE6, zTree will not use animation.
10 |Default: "fast"
11 |e.g. "slow", "normal", or "fast"
16 |If set to "", zTree will not use animation.
17 |How long the animation will run. [Unit: ms] (e.g. 1000)
21 |var setting = {
25 | view: {
26 | expandSpeed: "slow"
27 | }
28 | };
29 | ......节点自定义图标的 URL 路径。
9 |1、父节点如果只设置 icon ，会导致展开、折叠时都使用同一个图标
10 |2、父节点展开、折叠使用不同的个性化图标需要同时设置 treeNode.iconOpen / treeNode.iconClose 两个属性
11 |3、如果想利用 className 设置个性化图标，需要设置 treeNode.iconSkin 属性
12 |默认值：无
13 |图标图片的 url 可以是相对路径也可以是绝对路径
18 |设置相对路径请注意页面与图片之间的关系，确保图片能够正常加载
19 |var nodes = [
23 | //父节点展开 折叠时使用相同的图标
24 | { name:"父节点1", icon:"/img/parent.gif"},
25 |
26 | //父节点展开 折叠时分别使用不同的图标
27 | { name:"父节点2", iconOpen:"/img/open.gif", iconClose:"/img/close.gif"},
28 |
29 | //叶子节点个性化图标
30 | { name:"叶子节点", icon:"/img/leaf.gif"}
31 | ]勾选 或 取消勾选 全部节点。[setting.check.enable = true 且 setting.check.chkStyle = "checkbox" 时有效]
9 |此方法不会触发 beforeCheck / onCheck 事件回调函数。
10 |请通过 zTree 对象执行此方法。
11 |checked = true 表示勾选全部节点
17 |checked = false 表示全部节点取消勾选
18 |不会影响 treeNode.nocheck = true 的节点。
19 |不会影响未加载的节点。
20 |目前无任何返回值
22 |var treeObj = $.fn.zTree.getZTreeObj("tree");
26 | treeObj.checkAllNodes(true);
27 | 用于捕获父节点展开之前的事件回调函数，并且根据返回值确定是否允许展开操作
9 |默认值：null
10 |对应 zTree 的 treeId，便于用户操控
16 |要展开的父节点 JSON 数据对象
18 |返回值是 true / false
20 |如果返回 false，zTree 将不会展开节点，也无法触发 onExpand 事件回调函数
21 |function zTreeBeforeExpand(treeId, treeNode) {
25 | return false;
26 | };
27 | var setting = {
28 | callback: {
29 | beforeExpand: zTreeBeforeExpand
30 | }
31 | };
32 | ......1. Set node to hide the checkbox or radio. It is valid when [setting.check.enable = true]
9 |2. zTree support identification string 'true' & 'false'.
10 |Default: false
11 |true means: the node hide the checkbox or radio, and don't affect the checked association, and don't affect its parent node's half-checked status.
16 |false means: the node show the checkbox or radio.
17 |var nodes = [
21 | { "id":1, "name":"test1", "nocheck":true},
22 | { "id":2, "name":"test2"},
23 | { "id":3, "name":"test3"}
24 | ]用于捕获父节点折叠之前的事件回调函数，并且根据返回值确定是否允许折叠操作
9 |默认值：null
10 |对应 zTree 的 treeId，便于用户操控
16 |要折叠的父节点 JSON 数据对象
18 |返回值是 true / false
20 |如果返回 false，zTree 将不会折叠节点，也无法触发 onCollapse 事件回调函数
21 |function zTreeBeforeCollapse(treeId, treeNode) {
25 | return false;
26 | };
27 | var setting = {
28 | callback: {
29 | beforeCollapse: zTreeBeforeCollapse
30 | }
31 | };
32 | ......用于捕获 勾选 或 取消勾选 之前的事件回调函数，并且根据返回值确定是否允许 勾选 或 取消勾选
9 |默认值：null
10 |对应 zTree 的 treeId，便于用户操控
16 |进行 勾选 或 取消勾选 的节点 JSON 数据对象
18 |返回值是 true / false
20 |如果返回 false，将不会改变勾选状态，并且无法触发 onCheck 事件回调函数
21 |function zTreeBeforeCheck(treeId, treeNode) {
25 | return false;
26 | };
27 | var setting = {
28 | callback: {
29 | beforeCheck: zTreeBeforeCheck
30 | }
31 | };
32 | ......设置 zTree 是否处于编辑状态
9 |请在初始化之前设置，初始化后需要改变编辑状态请使用 zTreeObj.setEditable() 方法
10 |默认值: false
11 |true / false 分别表示 可以 / 不可以 编辑
16 |1、点击节点时，不会打开 node.url 指定的 URL。
20 |
2、全面支持 编辑 与 异步加载 状态共存。
21 |
3、可以对节点进行拖拽，且支持多棵树之间进行拖拽。
22 |
4、支持拖拽时 复制/移动 节点。（参考: setting.edit.drag.isCopy / setting.edit.drag.isMove）
23 |
5、可以通过编辑按钮修改 name 属性。
24 |
6、可以通过删除按钮删除节点。
25 |
26 |
请注意大小写，不要改变
28 |var setting = {
32 | edit: {
33 | enable: true
34 | }
35 | };
36 | ......用于捕获节点被删除之前的事件回调函数，并且根据返回值确定是否允许删除操作
9 |默认值：null
10 |对应 zTree 的 treeId，便于用户操控
16 |将要删除的节点 JSON 数据对象
18 |返回值是 true / false
20 |如果返回 false，zTree 将不删除节点，也无法触发 onRemove 事件回调函数
21 |function zTreeBeforeRemove(treeId, treeNode) {
25 | return false;
26 | }
27 | var setting = {
28 | edit: {
29 | enable: true
30 | },
31 | callback: {
32 | beforeRemove: zTreeBeforeRemove
33 | }
34 | };
35 | ......