dhtmlXTree 中文API

2023-11-20 23:32
文章标签 中文 html api frontend xtree

本文主要是介绍dhtmlXTree 中文API,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

dhtmlXTree是一个功能比较强大的树控件,基本上能满足大部分常规需求,比较好用。
    当然,在使用过程中还是发现一点点问题。下面是我整理的一些里面常用函数的说明(只有简单的说明,如果要看详细的说明,自己查看原函数去):

构造函数
dhtmlXTreeObject(htmlObject, width, height, rootId)//rootId 虚拟根节点,在界面上不会显示,一般取值0

replace IMG tag with background images - solve problem with IE image caching , not works for IE6 SP1
enableIEImageFix(mode)

析构函数
destructor()

实现继承
clone()

节点构造函数
dhtmlXTreeItemObject(itemId,itemText,parentObject,treeObject,actionHandler,mode)// mode - do not show images

从xml字符串加载树
loadXMLString(xmlString,afterCall)//afterCall - function which will be called after xml loading

从xml文件加载树
loadXML(file,afterCall)

新建子节点,前三个参数为必须的
insertNewItem(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)
insertNewChild(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)

节点展开与收缩:[1-close 2-open]
_HideShow(itemObject,mode)

获取节点状态:0 - 没有子节点, -1 - 节点合拢, 1 - 节点展开
_getOpenState(node)
getOpenState(itemId)

获取选中的节点Id
getSelectedItemId()

选中节点
_selectItem(node,e)

获取节点的index
getIndexById(itemId)

设置鼠标右键点击事件
setOnRightClickHandler(func)

设置鼠标点击事件
setOnClickHandler(func)

设置节点状态改变事件
setOnSelectStateChange(func)

设置允许动态加载xml文件(异步加载)
setXMLAutoLoading(filePath)

设置checkbox点击事件
setOnCheckHandler(func)

设置节点展开/合拢事件
setOnOpenHandler(func)

设置节点开始展/合拢开事件
setOnOpenStartHandler(func)

设置节点展开/合拢结束事件
setOnOpenEndHandler(func)

设置节点双击事件
setOnDblClickHandler(func)

展开节点及下面所有子节点
_xopenAll(node)

//增加了不传递itemId的判断(1494)
openAllItems(itemId)//不传递itemId参数则合拢根节点

根据id获取节点
_globalIdStorageFind(itemId)

合拢节点及其下所有子节点
_xcloseAll(node)

//修改了原来逻辑的一个错误(1521)
closeAllItems(itemId)//不传递itemId参数则合拢根节点

为节点增加用户自定义的数据
//修正一个错误(1548)
setUserData(itemId,name,value)

获取用户自定义的数据
getUserData(itemId,name)

获取节点颜色
getItemColor(itemId)

设置节点颜色
setItemColor(itemId,defaultColor,selectedColor)

获取节点名称--(with HTML formatting, if any)
getItemText(itemId)

获取父节点id
getParentId(itemId)

更改节点id
changeItemId(itemId,newItemId)

标记被剪切的节点
doCut()

粘贴被剪切的节点到新的父节点下
doPaste(itemId)

清空被剪切的节点
clearCut()

移动节点
_moveNode(itemObject,targetObject)

允许三种状态的复选框(全选、不选、部分选中)
enableThreeStateCheckboxes(mode)// 1 - on, 0 - off;

设置鼠标悬浮事件
setOnMouseInHandler(func)

设置鼠标移走事件
setOnMouseOutHandler(func)

设置是否允许显示树图片
enableTreeImages=function(mode)//1 - on, 0 - off

设置是否允许固定模式(对于显示复选框的界面美观一些,但没有水平滚动条)
enableFixedMode(mode)// - 1 - on, 0 - off

是否显示复选框
enableCheckBoxes(mode, hidden)//mode 0/1 hidden 0/1

设置节点图片
setStdImages(image1,image2,image3)//a0 - image for node without childrens a1 - image for closed node a2 - image for opened node

设置是否显示树线
enableTreeLines(mode)

设置图片
setImageArrays(arrayName,image1,image2,image3,image4,image5)//image1 - line crossed image image2 - image with top line image3 - image with bottom line image4 - image without line image5 - single root image

展开当前节点(一节)
_openItem(node)
openItem(itemId)

合拢当前节点(一节)
closeItem(itemId)

获取节点的层节数
getLevel(itemId)

设置节点是否允许被合拢
setItemCloseable(itemId,flag)//flag 0/1

对于展开节点返回子节点数量,对于未加载子节点的节点(异步加载)返回true
hasChildren(itemId)

获取节点下的子节点数
_getLeafCount(itemNode)

设置节点名称
setItemText(itemId,newLabel,newTooltip)

获取节点tip
getItemTooltip(itemId)

刷新节点
refreshItem(itemId)

设置节点图片
setItemImage2(itemId, image1,image2,image3)//image1 - node without childrens image image2 - closed node image image3 - open node image

设置节点图片
setItemImage(itemId,image1,image2)//image1 - node without childrens image or closed node image (if image2 specified)  image2 - open node image (optional)

获取节点下所有子节点id以逗号分割
getSubItems(itemId)
getAllSubItems(itemId)

获取节点的所有子节点
_getAllScraggyItems(node)

获取选中节点的名称--(with HTML formatting, if any)
getSelectedItemText()

设置节点的选中状态
setCheck(itemId,state)//state - checkbox state (0/1/unsure)

设置节点及所有子节点的选中状态
setSubChecked(itemId,state)

获取节点的选中状态 return: node state (0 - unchecked,1 - checked, 2 - third state)
isItemChecked(itemId)

删除节点的所有子节点
deleteChildItems(itemId)

删除节点
deleteItem(itemId,selectParent) //selectParent - If true parent of deleted item get selection, else no selected items leaving in tree.

在节点下创建一个节点,前三个参数是必须的
insertNewNext(itemId,newItemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)

根据index获取节点下子节点的id
getChildItemIdByIndex(itemId,index)//itemId 节点id

设置拖动事件
setDragHandler(func)

设置是否允许拖拽
//mode - enabled/disabled [ can be true/false/temporary_disabled - last value mean that tree can be D-n-D can be switched to true later ]
//rmode - enabled/disabled drag and drop on super root
enableDragAndDrop(mode,rmode)

设置是否允许IE缓存
preventIECashing=function(mode)//mode - enable/disable random seed ( disabled by default )

设置是否允许选中节点名称高亮显示
enableHighlighting(mode)//mode - 1 - on, 0 - off

是否允许图片可点击和拖拽(clickable and dragable)
enableActiveImages(mode)// mode - 1 - on, 0 - off

设置节点获得焦点
focusItem(itemId)

获取所有无子节点的节点id
getAllChildless()
getAllLeafs()

获取所有有子节点的节点id
getAllItemsWithKids()

获取所有被选中节点id,不包括第三中状态的节点(部分选中的节点)
getAllChecked()

获取所有被选中节点id,包括第三中状态的节点(部分选中的节点)
getAllCheckedBranches()

获取节点下所有未选中的节点id,不传递itemId表示从根节点开始查找
getAllUnchecked(itemId)

获取所有部分选中的节点id(因部分子节点选中而被选中的节点)
getAllPartiallyChecked()

设置节点样式
setItemStyle(itemId,style_string)

设置是否允许拖拽图片
enableImageDrag(mode)
set function called when tree item draged over another item
setOnDragIn(func)

设置拖拽是是否允许自动滚动
enableDragAndDropScrolling(mode)


补充说明:加载树时,必须确保所有节点的id不重复,否则控件会为重复id自动生成一个随机数(原id+"_"+当前日期)。
增加了一个dhtmlXTreeExtend.js对原类进行扩展,增加了getAllCheckedLeaf(),getAllUcCheckedLeaf()两个函数
修改了1个bug:
1 增加没有选中节点时执行展开/收缩选定节点时报没有parentId的bug
dhtmlXTreeObject.prototype.setSubChecked=function(itemId,state){
   if(itemId)
{
  var sNode=this._globalIdStorageFind(itemId);
  this._setSubChecked(state,sNode);
  this._correctCheckStates(sNode.parentObject);
}
}


1 增加了未传递itemId参数时默认从根节点展开
dhtmlXTreeObject.prototype.openAllItems=function(itemId)
   {
      if (itemId==window.undefined) itemId=this.rootId;
      var temp=this._globalIdStorageFind(itemId);
      if (!temp) return 0;
      this._xopenAll(temp);
   };

这篇关于dhtmlXTree 中文API的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/398251

相关文章

HTML5中的Microdata与历史记录管理详解

《HTML5中的Microdata与历史记录管理详解》Microdata作为HTML5新增的一个特性,它允许开发者在HTML文档中添加更多的语义信息,以便于搜索引擎和浏览器更好地理解页面内容,本文将探... 目录html5中的Mijscrodata与历史记录管理背景简介html5中的Microdata使用M

html5的响应式布局的方法示例详解

《html5的响应式布局的方法示例详解》:本文主要介绍了HTML5中使用媒体查询和Flexbox进行响应式布局的方法,简要介绍了CSSGrid布局的基础知识和如何实现自动换行的网格布局,详细内容请阅读本文,希望能对你有所帮助... 一 使用媒体查询响应式布局        使用的参数@media这是常用的

HTML5表格语法格式详解

《HTML5表格语法格式详解》在HTML语法中,表格主要通过table、tr和td3个标签构成,本文通过实例代码讲解HTML5表格语法格式,感兴趣的朋友一起看看吧... 目录一、表格1.表格语法格式2.表格属性 3.例子二、不规则表格1.跨行2.跨列3.例子一、表格在html语法中,表格主要通过< tab

Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案

《Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案》:本文主要介绍Vue3组件中getCurrentInstance()获取App实例,但是返回nu... 目录vue3组件中getCurrentInstajavascriptnce()获取App实例,但是返回n

JS+HTML实现在线图片水印添加工具

《JS+HTML实现在线图片水印添加工具》在社交媒体和内容创作日益频繁的今天,如何保护原创内容、展示品牌身份成了一个不得不面对的问题,本文将实现一个完全基于HTML+CSS构建的现代化图片水印在线工具... 目录概述功能亮点使用方法技术解析延伸思考运行效果项目源码下载总结概述在社交媒体和内容创作日益频繁的

前端CSS Grid 布局示例详解

《前端CSSGrid布局示例详解》CSSGrid是一种二维布局系统,可以同时控制行和列,相比Flex(一维布局),更适合用在整体页面布局或复杂模块结构中,:本文主要介绍前端CSSGri... 目录css Grid 布局详解(通俗易懂版)一、概述二、基础概念三、创建 Grid 容器四、定义网格行和列五、设置行

springboot项目中常用的工具类和api详解

《springboot项目中常用的工具类和api详解》在SpringBoot项目中,开发者通常会依赖一些工具类和API来简化开发、提高效率,以下是一些常用的工具类及其典型应用场景,涵盖Spring原生... 目录1. Spring Framework 自带工具类(1) StringUtils(2) Coll

前端下载文件时如何后端返回的文件流一些常见方法

《前端下载文件时如何后端返回的文件流一些常见方法》:本文主要介绍前端下载文件时如何后端返回的文件流一些常见方法,包括使用Blob和URL.createObjectURL创建下载链接,以及处理带有C... 目录1. 使用 Blob 和 URL.createObjectURL 创建下载链接例子:使用 Blob

Vuex Actions多参数传递的解决方案

《VuexActions多参数传递的解决方案》在Vuex中,actions的设计默认只支持单个参数传递,这有时会限制我们的使用场景,下面我将详细介绍几种处理多参数传递的解决方案,从基础到高级,... 目录一、对象封装法(推荐)二、参数解构法三、柯里化函数法四、Payload 工厂函数五、TypeScript

Vue3使用router,params传参为空问题

《Vue3使用router,params传参为空问题》:本文主要介绍Vue3使用router,params传参为空问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录vue3使用China编程router,params传参为空1.使用query方式传参2.使用 Histo