zTree v3.x 内部的全部方法都可以通过 $.fn.zTree._z 进行调用,开放出来是为了更便于大家开发制作自己的 zTree 插件。
9 |如无特殊需求请勿使用此对象,以及修改此对象内部的各个函数。
10 |设置 zTree 的节点上是否显示 checkbox / radio
9 |默认值: false
10 |true / false 分别表示 显示 / 不显示 复选框或单选框
15 |var setting = {
19 | check: {
20 | enable: true
21 | }
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 | ......
27 | 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 | ......
27 | zTree 节点数据中保存 check 状态的属性名称。
9 |默认值:"checked"
10 |请勿与 zTree 节点数据的其他参数冲突,例如:checkedOld
11 |var setting = {
16 | data: {
17 | key: {
18 | checked: "isChecked"
19 | }
20 | }
21 | };
22 | ......
23 | zTree 节点数据中保存子节点数据的属性名称。
9 |默认值:"children"
10 |var setting = {
15 | data: {
16 | key: {
17 | children: "nodes"
18 | }
19 | }
20 | };
21 | ......
22 | zTree 节点数据保存节点名称的属性名称。
9 |默认值:"name"
10 |var setting = {
15 | data: {
16 | key: {
17 | name: "ename"
18 | }
19 | }
20 | };
21 | ......
22 | 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 | ......
23 | zTree 节点数据保存节点链接的目标 URL 的属性名称。
9 |特殊用途:当后台数据只能生成 url 属性,又不想实现点击节点跳转的功能时,可以直接修改此属性为其他不存在的属性名称
10 |默认值:"url"
11 |var setting = {
16 | data: {
17 | key: {
18 | url: "xUrl"
19 | }
20 | }
21 | };
22 | ......
23 | 拖拽时父节点自动展开的延时间隔。 (单位: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 | ......
24 | 拖拽节点成为根节点时的 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 | ......
24 | 拖拽节点成为根节点时的 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 | ......
24 | 拖拽多个兄弟节点时,浮动图层中显示的最大节点数。 多余的节点用...代替。[setting.edit.enable = true 时生效]
9 |默认值:5
10 |请根据自己的需求适当调整此值
11 |var setting = {
16 | edit: {
17 | enable: true,
18 | drag: {
19 | maxShowNodeNum: 10
20 | }
21 | }
22 | };
23 | ......
24 | 判定是否拖拽操作的最小位移值 (单位: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 | ......
24 | zTree 的唯一标识,初始化后,等于 用户定义的 zTree 容器的 id 属性值。
9 |请勿进行初始化 或 修改,属于内部参数。
10 |zTree 容器的 jQuery 对象,主要功能:便于操作。
9 |请勿进行初始化 或 修改,属于内部参数。
10 |点击节点时,按下 Ctrl 或 Cmd 键是否允许取消选择操作。
9 |如果不需要此功能,请设置为 false。
10 |默认值: true
11 |true / false 分别表示 支持 / 不支持 配合 Ctrl 或 Cmd 键进行取消节点选择的操作
16 |var setting = {
20 | view: {
21 | autoCancelSelected: false
22 | }
23 | };
24 | ......
25 | 设置 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 | ......
26 | 设置 zTree 是否显示节点之间的连线。
9 |默认值:true
10 |true / false 分别表示 显示 / 不显示 连线
15 |var setting = {
19 | view: {
20 | showLine: false
21 | }
22 | };
23 | ......
24 | 设置 zTree 是否允许可以选择 zTree DOM 内的文本。
9 |默认值:false
10 |true / false 分别表示 允许 / 不允许 选择 zTree Dom 内的文本
15 |var setting = {
19 | view: {
20 | txtSelectedEnable: true
21 | }
22 | };
23 | ......
24 | 用于设置节点的 checkBox / radio 的 focus 状态。[setting.check.enable = true 时有效]
9 |zTree 内部使用,请勿进行初始化 或 随意修改
10 |默认值:false
11 |true 表示当前鼠标移动到输入框内
16 |false 表示当前鼠标移动到输入框外
17 |用于保存节点的其他自定义数据信息,不要与 zTree 使用的属性相同即可,用户可随意设定。
9 |var node = { "id":1, "name":"test1", "ename":"test eName"};
14 | 用于记录节点是否处于编辑名称状态。[setting.edit.enable = true 时有效]
9 |zTree 内部使用,请勿进行初始化 或 随意修改
10 |默认值:false
11 |true 表示节点处于编辑名称状态
16 |false 表示节点未处于编辑名称状态
17 |记录 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 |
25 | 记录节点 的 hover 状态,主要用于 setting.view.addHoverDom / removeHoverDom 。
9 |zTree 内部使用,请勿进行初始化 或 随意修改
10 |默认值:false
11 |true 表示节点处于 hover 状态
16 |false 表示节点未处于 hover 状态
17 |记录节点的层级
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 |
24 | 节点名称。
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 | ]
24 | 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 |
24 | 设置点击节点后在何处打开 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 | ]
23 | 获取 zTree 当前被选中的节点数据集合
9 |请通过 zTree 对象执行此方法。
10 |当前被选中的节点数据集合
16 |var treeObj = $.fn.zTree.getZTreeObj("tree");
20 | var nodes = treeObj.getSelectedNodes();
21 |
22 | 刷新 zTree 。
9 |没有特殊必要,尽量不要使用此方法。单个节点更新请使用 updateNode 方法,异步加载模式下请使用 reAsyncChildNodes 方法。
10 |请通过 zTree 对象执行此方法。
11 |目前无任何返回值
17 |var treeObj = $.fn.zTree.getZTreeObj("tree");
21 | treeObj.refresh();
22 |
23 | zTree 对象使用的 setting 配置数据,详细请参考 “setting 配置详解”中的各个属性详细说明
9 |v3.x 取消了原先操作 setting 的方法,让用户可以较自由的修改参数,但请注意,对于 zTree 初始化有影响的参数后期修改是不会起作用的,请对各个属性有较深入的了解以后再考虑进行修改。
10 |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 |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 | ......
25 | 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 | ......
23 | 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 | ......
22 | 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 | ......
22 | 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 |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 |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 | ......
25 | 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 |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"};
14 | 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 |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 |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 |