Initialization

enableCheckBoxes(mode)
hide checkboxes

File required:dhtmlXTree.js

mode - enabled/disabled

enableContextMenu(menu) [Commercial]
enable context menu

File required:dhtmlXTree.js

menu - menu object

enableDragAndDrop(mode)
enable/disable drag-and-drop

File required:dhtmlXTree.js

mode - enabled/disabled

enableDragAndDropScrolling(mode) [Commercial]
enable/disable auto scrolling while drag-and-drop

File required:dhtmlXTree.js

mode - enabled/disabled

enableMultiLineItems(width) [Commercial]
enable multi line items

File required:dhtmlXTree.js

width - text width, if equls zero then use single lines items;

enableSmartXMLParsing(mode) [Commercial]
enable/disable smart XML parsing mode

File required:dhtmlXTree.js

mode - 1 - on, 0 - off;

enableThreeStateCheckboxes(mode)
enable three state checkboxes

File required:dhtmlXTree.js

mode - 1 - on, 0 - off;

enableTreeImages(mode)
enable tree images

File required:dhtmlXTree.js

mode - 1 - on, 0 - off;

focusItem(itemId) [Commercial]
focus item in tree

File required:dhtmlXTree.js

itemId - item Id

loadXML(file)
load tree from xml file

File required:dhtmlXTree.js

file - link too XML file

loadXMLString(xmlString)
load tree from xml string

File required:dhtmlXTree.js

xmlString - XML string

setDragBehavior(mode) [Commercial]
set Drag-And-Drop behavior

File required:dhtmlXTree.js

mode - behavior name (child or sibling)

setDragHandler(func)
set function called when drag-and-drop event occured

File required:dhtmlXTree.js

aFunc - event handling function

setDropHandler(func) [Commercial]
set function called after drag-and-drap event occured

File required:dhtmlXTree.js

func - event handling function

setImagePath( newPath )
set path to image directory

File required:dhtmlXTree.js

newPath - path to image directory

setOnCheckHandler(func)
set function called before checkbox checked/unchecked

File required:dhtmlXTree.js

func - event handling function

setOnClickHandler(func)
set function called when tree node selected

File required:dhtmlXTree.js

func - event handling function

setOnDblClickHandler(func)
set function called when tree node double clicked

File required:dhtmlXTree.js

func - event handling function

setOnOpenHandler(func)
set function called before tree node opened/closed

File required:dhtmlXTree.js

func - event handling function

setXMLAutoLoading(filePath)
enables dinamic loading from XML mode

File required:dhtmlXTree.js

filePath - name of script returning XML;

Selection control

getChildItemIdByIndex(itemId,index)
retun child node identificator by index

File required:dhtmlXTree.js

itemId - parent node identificator

index - index of child node

getItemIdByIndex(itemId,index)
retun node identificator by index

File required:dhtmlXTree.js

itemId - node identificator

index - index of node

getSelectedItemId()
retun selected node identificator

File required:dhtmlXTree.js

getSelectedItemText()
retun selected node text

File required:dhtmlXTree.js

selectItem(itemId,mode)
select node ( and optionaly fire onselect event)

File required:dhtmlXTree.js

itemId - node identificator

mode - If true, script function for selected node will be called.

Add/delete

clearCut()
clear cut

File required:dhtmlXTree.js

deleteChildItems(itemId)
delete all child of node

File required:dhtmlXTree.js

itemId - node identificator

deleteItem(itemId,selectParent)
delete node

File required:dhtmlXTree.js

itemId - node identificator

selectParent - If true parent of deleted item get selection, else no selected items leaving in tree.

doCut()
mark selected item as cutted

File required:dhtmlXTree.js

doPaste(itemId)
insert previously cutted branch

File required:dhtmlXTree.js

itemId - id of new parent node

enableAutoSavingSelected(mode) [Commercial]
enable/disable autosaving selected node in cookie

File required:dhtmlXTree_xw.js

mode - true/false

findItem(searchStr,direction,top)
find tree item by text, select and focus it

File required:dhtmlXTree.js

searchStr - search text

direction - 0: top -> bottom; 1: bottom -> top

top - 1: start searching from top

findItemIdByLabel(searchStr,direction,top)
find tree item by text

File required:dhtmlXTree.js

searchStr - search text

direction - 0: top -> bottom; 1: bottom -> top

top - 1: start searching from top

insertNewItem(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)
create new child node

File required:dhtmlXTree.js

parentId - parent node id

itemId - new node id

itemText - new node text

itemActionHandler - function fired on node select event (optional)

image1 - image for node without childrens; (optional)

image2 - image for closed node; (optional)

image3 - image for opened node (optional)

optionStr - options string (optional)

childs - node childs flag (for dynamical trees) (optional)

insertNewNext(parentItemId,itemId,itemName,itemActionHandler,image1,image2,image3,optionStr,childs)
create new node next to specified

File required:dhtmlXTree.js

parentItemId - node id

itemId - new node id

itemName - new node text

itemActionHandler - function fired on node select event (optional)

image1 - image for node without childrens; (optional)

image2 - image for closed node; (optional)

image3 - image for opened node (optional)

optionStr - options string (optional)

childs - node childs flag (for dynamical trees) (optional)

loadOpenStates(name) [Commercial]
restore open nodes from cookie

File required:dhtmlXTree_xw.js

name - optional,cookie name

loadState(name) [Commercial]
load tree from cookie

File required:dhtmlXTree_xw.js

name - optional,cookie name

restoreSelectedItem(name) [Commercial]
restore selected item from cookie

File required:dhtmlXTree_xw.js

name - optional, cookie name

saveOpenStates(name) [Commercial]
save open nodes to cookie

File required:dhtmlXTree_xw.js

name - optional,cookie name

saveSelectedItem(name) [Commercial]
save selected item to cookie

File required:dhtmlXTree_xw.js

name - optional, cookie name

saveState(name) [Commercial]
save tree to cookie

File required:dhtmlXTree_xw.js

name - optional, cookie name

serializeTree() [Commercial]
return xml description of tree

File required:dhtmlXTree_xw.js

Node/level control

changeItemId(itemId,newItemId)
change item id

File required:dhtmlXTree.js

itemId - old node id

newItemId - new node id

closeAllItems(itemId)
collapse target node and all child nodes

File required:dhtmlXTree.js

itemId - node id

closeItem(itemId)
collapse node

File required:dhtmlXTree.js

itemId - identificator of node

getLevel(itemId)
return node level

File required:dhtmlXTree.js

itemId - identificator of node

getParentId(itemId)
return parent node identificator

File required:dhtmlXTree.js

itemId - identificator of node

hasChildren(itemId)
return count of childrens

File required:dhtmlXTree.js

itemId - identificator of node

openAllItems(itemId)
expand target node and all child nodes

File required:dhtmlXTree.js

itemId - node id

openItem(itemId)
expand node

File required:dhtmlXTree.js

itemId - identificator of node

setItemCloseable(itemId,flag)
prevent node from closing

File required:dhtmlXTree.js

itemId - identificator of node

flag - if 0 - node can't be closed, else node can be closed

Checkboxes/user data manipulation

getAllChecked()
return list of identificators of nodes with checked checkboxes

File required:dhtmlXTree.js

getAllCheckedBranches()
return list of identificators of nodes with checked checkboxes, and parent of that checkboxes

File required:dhtmlXTree.js

getUserData(itemId,name)
return user data from target node

File required:dhtmlXTree.js

itemId - target node identificator

name - key for user data

isItemChecked(itemId)
return state of nodes's checkbox

File required:dhtmlXTree.js

itemId - target node identificator

setCheck(itemId,state)
change state of node's checkbox

File required:dhtmlXTree.js

itemId - target node identificator

state - checkbox state

setSubChecked(itemId,state)
change state of node's checkbox and all childnodes checkboxes

File required:dhtmlXTree.js

itemId - target node identificator

state - checkbox state

setUserData(itemId,name,value)
set user data for target node

File required:dhtmlXTree.js

itemId - target node identificator

name - key for user data

value - user data

Appearence control

enableTreeLines(mode)
enableTreeLines(mode);

File required:dhtmlXTree.js

mode - enable/disable tree lines

getAllSubItems(itemId)
Returns the list of all children items from all next levels of tree, separated by commas.

File required:dhtmlXTree.js

itemId - identificator of node

getItemColor(itemId)
get node color

File required:dhtmlXTree.js

itemId - identificator of node

getItemText(itemId)
return node text

File required:dhtmlXTree.js

itemId - identificator of node

getSubItems(itemId)
Returns the list of all children items from the next level of tree, separated by commas.

File required:dhtmlXTree.js

itemId - identificator of node

refreshItem(itemId)
refresh tree branch from xml

File required:dhtmlXTree.js

itemId - identificator of node, if not defined tree super root used.

setImageArrays(arrayName,image1,image2,image3,image4,image5)
enableTreeLines(mode);

File required:dhtmlXTree.js

arrayName - name of array: plus, minus

image1 - line crossed image

image2 - image with top line

image3 - image with bottom line

image4 - image without line

image5 - single root image

setItemColor(itemId,defaultColor,selectedColor)
set node color

File required:dhtmlXTree.js

itemId - identificator of node

defaultColor - node color

selectedColor - selected node color

setItemImage(itemId,image1,image2)
set node images

File required:dhtmlXTree.js

itemId - identificator of node

image1 - node without childrens image or closed node image (if image2 specified)

image2 - open node image (optional)

setItemImage2(itemId, image1,image2,image3)
set node images

File required:dhtmlXTree.js

itemId - identificator of node

image1 - node without childrens image

image2 - closed node image

image3 - open node image

setItemText(itemId,newLabel)
set new node text (HTML allowed)

File required:dhtmlXTree.js

itemId - identificator of node

newLabel - node text

setStdImages(image1,image2,image3)
set default images for nodes

File required:dhtmlXTree.js

a0 - image for node without childrens;

a1 - image for closed node;

a2 - image for opened node

dhtmlXTreeObject object API

Initialization

Selection control

Add/delete

Node/level control

Checkboxes/user data manipulation

Appearence control