<div id="treeBox" style="width:200;height:200"></div> <script> tree=new dhtmlXTreeObject(document.getElementById('treeBox'),"100%","100%",0); tree.setImagePath("gfx/"); tree.enableCheckBoxes(false); tree.enableDragAndDrop(true); </script> Parameters passed to the constructor are:

object to attach tree to (should be loaded before calling constructor)

width of the tree

height of the tree

identifier of level parent to tree root level (superroot)

Specify Additional parameters of the tree:

setImagePath(url) - method specifies the path to the folder with tree icons

enableCheckBoxes(mode) - enable/disable checkboxes in tree (checkboxes appear by default)

enableDragAndDrop(mode) - enable/disable drag-n-drop in tree

<div id="treeBox" style="width:200;height:200"></div> <script> tree=new dhtmlXTreeObject(document.getElementById('treeBox'),"100%","100%",0); ... tree.setOnClickHandler(onNodeSelect);//set function object to call on node select //see other available event handlers in API documentation function onNodeSelect(nodeId){ ... } </script> In most cases functions specified inside event handlers get some values with the arguments. For details about passed arguments please refer to API documentation.

<script> tree=new dhtmlXTreeObject('treeBox',"100%","100%",0); ... tree.insertNewChild(0,1,"New Node 1",0,0,0,0,"SELECT,CALL,TOP,CHILD,CHECKED"); tree.insertNewNext(1,2,"New Node 2",0,0,0,0,"CHILD,CHECKED"); </script>

0s passed to the function for arguments 4-7 (function to call on select, images) mean use default values for them

Last argument is a comma delimited string of following possible value (upper case only):

SELECT - move selection to this node after inserting

CALL - call function on select

TOP - add node to the top position

CHILD - node has children

CHECKED - checkbox is checked (if exists)

<script> tree=new dhtmlXTreeObject('treeBox',"100%","100%",0); tree.setXMLAutoLoading("http://127.0.0.1/xml/tree.xml"); tree.loadXML("http://127.0.0.1/xml/tree.xml");//load root level from xml </script>

ID of opened node (as id url parameter) will be added to URL specified in initXMLAutoLoading(url) during the call

No additional ID is added to the url specified in loadXML(url) method during the call

Using loadXML() without parameters you load url specified in initXMLAutoLoading(url) method

XML Syntax: <?xml version='1.0' encoding='iso-8859-1'?> <tree id="0"> <item text="My Computer" id="1" child="1" im0="my_cmp.gif" im1="my_cmp.gif" im2="my_cmp.gif" call="true" select="yes"> <userdata name="system">true</userdata> <item text="Floppy (A:)" id="11" child="0" im0="flop.gif" im1="flop.gif" im2="flop.gif"/> <item text="Local Disk (C:)" id="12" child="0" im0="drv.gif" im1="drv.gif" im2="drv.gif"/> </item> <item text="Recycle Bin" id="4" child="0" im0="recyc.gif" im1="recyc.gif" im2="recyc.gif"/> </tree>
In PHP script use the following code for page header:
<?php if ( stristr($_SERVER["HTTP_ACCEPT"],"application/xhtml+xml") ) { header("Content-type: application/xhtml+xml"); } else { header("Content-type: text/xml"); } echo("<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n"); ?>
<tree> node is mandatory. It specifies the parent of loading block of data. According to this its id parameter specifies the ID oth that parent. To load root level you need to specify the ID you used when created tree object: new myObjTree(boxObject,width,height,0)
<item> can contain subitems (in order to load more than one level at once) or not.
Mandatory parameters for this tag are:

text - label of the node

id - id of the node

Optional parameters for this tag are:

tooltip - tooltip for the node

im0 - image for node without children (tree will get images from the path specified in setImagePath(url) method)

im1 - image for opened node with children

im2 - image for closed node with children

acolor - colour of not selected item

scolor - colour of selected item

select - select node on load (any value)

open - show node opened (any value)

call - call function on select(any value)

checked - check checkbox if exists(any value)

child - spec. if node has children (1) or not (0)

imheight - height of the icon

imwidth - width of the icon

To set userdata directly within XML use <userdata>
It has just one parameter:

name

and value to specify userdata value

There are two ways to set custom icons for the node. And it depends on the way you add items.
Important: tree will get images for the nodes from the path specified in setImagePath(url) method.

Javascript way. Using arguments of insertNewChild(...) or insertNewNext(...) methods: <script> var im0 = "doc.gif";//icon to show if node contains no children var im1 = "opened.gif";//if node contains children and opened var im2 = "closed.gif";//if node contains children and closed tree.insertNewItem(0,1,"New Node 1",0,im0,im1,im2); tree.insertNewNext(1,2,"New Node 2",0,"txt.gif","opened.gif","closed.gif"); </script> XML way. Using parameters of <item> tag: <?xml version='1.0' encoding='iso-8859-1'?> <tree id="0"> <item text="My Computer" id="1" child="1" im0="doc.gif" im1="my_opened.gif" im2="my_closed.gif"> </tree>

im0 - image for node without children (tree will get images from the path specified in setImagePath(url) method)

im1 - image for opened node with children

im2 - image for closed node with children

If your tree should contain large amount of nodes (or you simply do not want to waist time loading hidden nodes), it would be better to load them on demand, not at once. For this purpose we made the tree to load levels dynamically using XML.
See chapter "Loading data with XML"
or for more details "Dynamical Loading in dhtmlxTree v.1.x" article from our Knowledge Base.

A few examples of manipulating node with tree object methods: <script> tree=new dhtmlXTreeObject('treeboxbox_tree',"100%","100%",0); ... var sID = tree.getSelectedItemId();//get id of selected node tree.setLabel(sID,"New Label");//change label of selecte node tree.setItemColor(sID,'blue','red');//set colors for selected node's label (for not selected state and for selected state) tree.openItem(sID);//expand selected node tree.closeItem(sID);//close selected node tree.changeItemId(sID,100);//change id of selected node to 100 alert("This node has children: "+tree.hasChildren(100));//show alert with information if this node has children </script>

Serialization methods allows getting tree in xml representation (xml string). Various levels of serializations define the number of tree parameters reflected in resulting XML:
<script> tree.setSerializationLevel(userDataFl,itemDetailsFl); var myXmlStr = tree.serializeTree(); </script>

no parameters - id,open,select,text,child

userDataFl true - userdata

itemDetailsFl true - im0,im1,im2,acolor,scolor,checked,open

There are three ways to set tooltip for the node:

Use node label ("text" attribute of item node) as tooltip - enableAutoTooltips(mode) - false by default

Use "tooltip" attribute of item node for tooltip (it is used by default if this attribute was specified)

setItemText(itemId,newLabel,newTooltip)

To move Item programaticaly developer can use the following ways:

To move upp/down/left: tree.moveItem(nodeId,mode) mode possible values are:

"down" - move node down in list of nodes (do not pay attention on hierarchy)

"up" - move node up in list of nodes

"left" - move node up in hierarchy

To move directly into position (within tree) tree.moveItem(nodeId,mode,targetId) mode possible values are:

"item_child" - place node as child of node specified in third argument

"item_sibling" - place node as sibling of node specified in third argument

targetId - id of target node.

To move node into position (to another tree) tree.moveItem(nodeId,mode,targetId,targetTree) mode possible values as above.
targetId - id of target node (in target tree).
targetTree - target tree object

Cut/Paste way
Another way is to use doCut(),doPaste(id) - but this works with selected item only. Developer can also delete node in one place and create it in other (also the way ;-)).
To give users the possibility to move items use drag-n-drop functionlity.

There is a possibility to display item children elements counter with the label of the node. To activate this feature use the following: <script> tree.setChildCalcMode(mode); </script> Possible modes are:

"child" - all childs on this level

"leafs" - all childs without subchilds on this level

"childrec" - all childs

"leafsrec" all childs without subchilds

"disabled" - nothing

Other related methods:
_getChildCounterValue(itemId) - get current counter value
setChildCalcHTML(before,after) - html around counter to change default [x]
Use child attribute in xml if you need to set counter value when using dynamical loading.

The idea of Smart XML Parsing is simple - the entire tree structute loaded on client side, but only nodes which should be displayed are rendered. This helps to dramaticaly decrease loading time and general performance of large trees. Plus - in the contrary to Dynamical Loading - entrire tree structure is available for most of script methods (for example Search performed agains all nodes - not only rendered). To activate Smart XML Parsing use the following method: <script> tree.enableSmartXMLParsing(true);//false to disable </script> Smart XML Parsing do not work if tree loaded fully expanded.

dhtmlxTree support two or three state checkboxes. Three state checkboxes means: checked/unchecked/some-child-checked (not all). To enable three state checkboxes use the following method: <script> tree.enableThreeStateCheckboxes(true)//false to disable </script> Using three-state checboxes with smart xml parsing you need to specify third state manually (checked="-1"): <item checked="-1" ...> <item checked="1" .../> <item .../> </item> Checkboxes can be disabled - disableCheckbox(id,state)
Some node can hide checkboxes - showItemCheckbox(id,state) (nocheckbox xml attribute)

There are three modes of drag-n-drop (set with setDragBehavior(mode)):

Drop as child - "child"

Drop as sibling - "sibling"

Complex mode (both previous are active) - "complex"

Plus two modes of each of them:

1. Common drag-n-drop

2. Copy with drag-n-drop - tree.enableMercyDrag(1/0)

All modes can be changed on the fly.

Event handlers

To process drag-n-drop before drop occured use onDrug event handler - setDragHandler(func). If func doesn't return true, drop will be canceled.
After drop occured there is another event - onDrop - handle it using setDropHandler(func).
Both event handlers pass 5 parameters into the func object:

id of node which was dragged

id of target node

id of target-before node (if drop as sibling)

tree object source

tree object target

Drag-n-drop between iframes enabled by default. All you need to do additionaly is to insert the following code into the page where no tree exists:
<script src="js/dhtmlXCommon.js"></script> <script> new dhtmlDragAndDropObject(); </script>

Taking into account the general low performance of DHTML we introducrd two ways of increasing performance of large trees:
1. Dynamical Loading
2. Smart XML Parsing
Also be sure your tree was organized well - putting a lot of items on one level of the branch makes tree difficalt for visual perception and decrease performance.

There is built in context menu in dhtmlxTree. The content of this menu can be set with XML or script. For changing context menu content depending on tree item developer can implement function for hidding/showing items of the same menu or associate different menues with different items. To enable context menu do the following: <script> //init menu aMenu=new dhtmlXContextMenuObject('120',0,"Demo menu"); aMenu.menu.setGfxPath("../imgs/"); aMenu.menu.loadXML("menu/_context.xml"); aMenu.setContextMenuHandler(onMenuClick); //init tree tree=new dhtmlXTreeObject("treeboxbox_tree","100%","100%",0); ... tree.enableContextMenu(aMenu); //link context menu to tree function onMenuClick(id){ alert("Menu item "+id+" was clicked"); } </script>

refreshItems(itemIdList,source) to refresh only items from the itemIdList (not their children)

refreshItem(itemId) - to refresh children of item with itemId. In this case auto loading should be activated.

You can sort nodes in dhtmlxTree Pro (necessary file: dhtmlXTree_sb.js) using follwoing ways:
Sort by label text (if no custom comparator specified)
tree.sortTree(nodeId,order,all_levels);

nodeId - parent of the level to start sorting from (id of superroot for entire tree)

order - sort direction: "ASC"/"DES"

all_levels - if true, then all sublevels will be processed as well

Custom defined sorting
//define your comparator (in our case it compares second words in label) function mySortFunc(idA,idB){ a=(tree.getItemText(idA)).split(" ")[1]||""; b=(tree.getItemText(idB)).split(" ")[1]||""; return ((a>b)?1:-1); } tree = new ... //attach your comparator to the tree tree.setCustomSortFunction(mySortFunc); Comparator function gets 2 nodes IDs. Use your tree object there and these IDs to return a comparison result.
If custome comparator was specified, then tree.sortTree(...) method uses it for sorting.

Search functionality of dhtmlxTree allows moving focus on node with label fitting searchString mask.
Has support for Smart XML Parsing.

Script syntax: tree.findItem(searchString); //find item next to current selection tree.findItem(searchString,1,1)//find item previous to current selection tree.findItem(searchString,0,1)//search from top Example of usage is included in Professional Edition package – samples/treeExPro2.html.

...allows displaying tree items in multiline mode. For now it is recommended to turn tree lines off for better appearance. To enable multiline feature you need to do the following: tree.enableTreeLines(false); tree.enableMultiLineItems(true); Example of usage is included in professional edition package – samples/treeExPro6.html.

Set Icons

There is a way to set icons for the node explicetly using script (setItemImage,setItemImage2) or xml (im0,im1,im2 attributes of item node):

im0 - item without children

im1 - closed item with children

im2 - opened item with children

Set Icon Size

There is a way to set icon size for the whole tree or each node using script or xml:
XML syntax for icon size per each item (optional): <item ... imheight="Xpx" imwidth="Xpx"></item> Script syntax: tree.setIconSize(w,h);//set global icon size tree.setIconSize(w,h,itemId)//set icon size for particular item