expandcollaps

dhtmlXTreeObject object API

changeItemId(itemId,newItemId)
change item id
Topic(s): Node/level control;
File required:dhtmlXTree.js
  • itemId - old node id
  • newItemId - new node id
  • clearCut()
    clear cut
    Topic(s): Add/delete;
    File required:dhtmlXTree.js
    closeAllItems(itemId)
    collapse target node and all child nodes
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - node id
  • closeItem(itemId)
    collapse node
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • deleteChildItems(itemId)
    delete all child of node
    Topic(s): Add/delete;
    File required:dhtmlXTree.js
  • itemId - node identificator
  • deleteItem(itemId,selectParent)
    delete node
    Topic(s): Add/delete;
    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
    Topic(s): Add/delete;
    File required:dhtmlXTree.js
    doPaste(itemId)
    insert previously cutted branch
    Topic(s): Add/delete;
    File required:dhtmlXTree.js
  • itemId - id of new parent node
  • enableAutoSavingSelected(mode) [Commercial]
    enable/disable autosaving selected node in cookie
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
  • mode - true/false
  • enableCheckBoxes(mode)
    hide checkboxes
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • mode - enabled/disabled
  • enableContextMenu(menu) [Commercial]
    enable context menu
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • menu - menu object
  • enableDragAndDrop(mode)
    enable/disable drag-and-drop
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • mode - enabled/disabled
  • enableDragAndDropScrolling(mode) [Commercial]
    enable/disable auto scrolling while drag-and-drop
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • mode - enabled/disabled
  • enableMultiLineItems(width) [Commercial]
    enable multi line items
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • width - text width, if equls zero then use single lines items;
  • enableSmartXMLParsing(mode) [Commercial]
    enable/disable smart XML parsing mode
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • mode - 1 - on, 0 - off;
  • enableThreeStateCheckboxes(mode)
    enable three state checkboxes
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • mode - 1 - on, 0 - off;
  • enableTreeImages(mode)
    enable tree images
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • mode - 1 - on, 0 - off;
  • enableTreeLines(mode)
    enableTreeLines(mode);
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • mode - enable/disable tree lines
  • findItem(searchStr,direction,top)
    find tree item by text, select and focus it
    Topic(s): Add/delete;
    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
    Topic(s): Add/delete;
    File required:dhtmlXTree.js
  • searchStr - search text
  • direction - 0: top -> bottom; 1: bottom -> top
  • top - 1: start searching from top
  • focusItem(itemId) [Commercial]
    focus item in tree
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • itemId - item Id
  • getAllChecked()
    return list of identificators of nodes with checked checkboxes
    Topic(s): Checkboxes/user data manipulation;
    File required:dhtmlXTree.js
    getAllCheckedBranches()
    return list of identificators of nodes with checked checkboxes, and parent of that checkboxes
    Topic(s): Checkboxes/user data manipulation;
    File required:dhtmlXTree.js
    getAllSubItems(itemId)
    Returns the list of all children items from all next levels of tree, separated by commas.
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • getChildItemIdByIndex(itemId,index)
    retun child node identificator by index
    Topic(s): Selection control;
    File required:dhtmlXTree.js
  • itemId - parent node identificator
  • index - index of child node
  • getItemColor(itemId)
    get node color
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • getItemIdByIndex(itemId,index)
    retun node identificator by index
    Topic(s): Selection control;
    File required:dhtmlXTree.js
  • itemId - node identificator
  • index - index of node
  • getItemText(itemId)
    return node text
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • getLevel(itemId)
    return node level
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • getParentId(itemId)
    return parent node identificator
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • getSelectedItemId()
    retun selected node identificator
    Topic(s): Selection control;
    File required:dhtmlXTree.js
    getSelectedItemText()
    retun selected node text
    Topic(s): Selection control;
    File required:dhtmlXTree.js
    getSubItems(itemId)
    Returns the list of all children items from the next level of tree, separated by commas.
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • getUserData(itemId,name)
    return user data from target node
    Topic(s): Checkboxes/user data manipulation;
    File required:dhtmlXTree.js
  • itemId - target node identificator
  • name - key for user data
  • hasChildren(itemId)
    return count of childrens
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • insertNewItem(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)
    create new child node
    Topic(s): Add/delete;
    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
    Topic(s): Add/delete;
    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)
  • isItemChecked(itemId)
    return state of nodes's checkbox
    Topic(s): Checkboxes/user data manipulation;
    File required:dhtmlXTree.js
  • itemId - target node identificator
  • loadOpenStates(name) [Commercial]
    restore open nodes from cookie
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
  • name - optional,cookie name
  • loadState(name) [Commercial]
    load tree from cookie
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
  • name - optional,cookie name
  • loadXML(file)
    load tree from xml file
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • file - link too XML file
  • loadXMLString(xmlString)
    load tree from xml string
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • xmlString - XML string
  • openAllItems(itemId)
    expand target node and all child nodes
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - node id
  • openItem(itemId)
    expand node
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • refreshItem(itemId)
    refresh tree branch from xml
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • itemId - identificator of node, if not defined tree super root used.
  • restoreSelectedItem(name) [Commercial]
    restore selected item from cookie
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
  • name - optional, cookie name
  • saveOpenStates(name) [Commercial]
    save open nodes to cookie
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
  • name - optional,cookie name
  • saveSelectedItem(name) [Commercial]
    save selected item to cookie
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
  • name - optional, cookie name
  • saveState(name) [Commercial]
    save tree to cookie
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
  • name - optional, cookie name
  • selectItem(itemId,mode)
    select node ( and optionaly fire onselect event)
    Topic(s): Selection control;
    File required:dhtmlXTree.js
  • itemId - node identificator
  • mode - If true, script function for selected node will be called.
  • serializeTree() [Commercial]
    return xml description of tree
    Topic(s): Add/delete;
    File required:dhtmlXTree_xw.js
    setCheck(itemId,state)
    change state of node's checkbox
    Topic(s): Checkboxes/user data manipulation;
    File required:dhtmlXTree.js
  • itemId - target node identificator
  • state - checkbox state
  • setDragBehavior(mode) [Commercial]
    set Drag-And-Drop behavior
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • mode - behavior name (child or sibling)
  • setDragHandler(func)
    set function called when drag-and-drop event occured
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • aFunc - event handling function
  • setDropHandler(func) [Commercial]
    set function called after drag-and-drap event occured
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • func - event handling function
  • setImageArrays(arrayName,image1,image2,image3,image4,image5)
    enableTreeLines(mode);
    Topic(s): Appearence control;
    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
  • setImagePath( newPath )
    set path to image directory
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • newPath - path to image directory
  • setItemCloseable(itemId,flag)
    prevent node from closing
    Topic(s): Node/level control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • flag - if 0 - node can't be closed, else node can be closed
  • setItemColor(itemId,defaultColor,selectedColor)
    set node color
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • defaultColor - node color
  • selectedColor - selected node color
  • setItemImage(itemId,image1,image2)
    set node images
    Topic(s): Appearence control;
    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
    Topic(s): Appearence control;
    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)
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • itemId - identificator of node
  • newLabel - node text
  • setOnCheckHandler(func)
    set function called before checkbox checked/unchecked
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • func - event handling function
  • setOnClickHandler(func)
    set function called when tree node selected
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • func - event handling function
  • setOnDblClickHandler(func)
    set function called when tree node double clicked
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • func - event handling function
  • setOnOpenHandler(func)
    set function called before tree node opened/closed
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • func - event handling function
  • setStdImages(image1,image2,image3)
    set default images for nodes
    Topic(s): Appearence control;
    File required:dhtmlXTree.js
  • a0 - image for node without childrens;
  • a1 - image for closed node;
  • a2 - image for opened node
  • setSubChecked(itemId,state)
    change state of node's checkbox and all childnodes checkboxes
    Topic(s): Checkboxes/user data manipulation;
    File required:dhtmlXTree.js
  • itemId - target node identificator
  • state - checkbox state
  • setUserData(itemId,name,value)
    set user data for target node
    Topic(s): Checkboxes/user data manipulation;
    File required:dhtmlXTree.js
  • itemId - target node identificator
  • name - key for user data
  • value - user data
  • setXMLAutoLoading(filePath)
    enables dinamic loading from XML mode
    Topic(s): Initialization;
    File required:dhtmlXTree.js
  • filePath - name of script returning XML;