Treegrid API

Methods
addCellCss adds a style to a cell
addRowCss adds a style to a row
addSpan adds a rows/cols span
adjustColumnWidth adjusts the width of a column to make all its content visible
collapse collapses a tree node by id
collapseAll collapses all expanded Tree nodes
destructor removes a Grid instance and releases occupied resources
edit enables editing of a Grid cell
editCell enables editing of a TreeGrid cell
editEnd finishes editing in a cell
expand expands a tree node by id
expandAll expands all collapsed tree nodes
getCellRect returns the parameters of a cell
getColumn returns an object with attributes of a column
getHeaderFilter returns an object of the header filter by column id
getScrollState returns the coordinates of a position a grid has been scrolled to
getSortingState returns the current state of sorting data in TreeGrid
getSpan returns an object with spans
groupBy groups grid content either by values of the specified column or by the result of calculation
hideColumn hides a column of Grid
hideRow hides a row of TreeGrid
isColumnHidden checks whether a column is hidden
isRowHidden checks whether a row is hidden
paint repaints a grid on a page
removeCellCss removes a style from a cell
removeRowCss removes a style from a row
removeSpan removes a cols/rows span
scroll scrolls a grid according to specified coordinates
scrollTo scrolls a grid to a specified cell
setColumns sets configuration for TreeGrid columns
showColumn makes a specified column visible on a page
showRow makes a specified row visible on a page
ungroup ungroups the grid to return it into the plain view

Tree Collection

add adds an item to a component
canCopy checks whether it is possible to copy a control into some other control
copy adds a copy of an item and places it in the specified position
eachChild iterates through child items of a control
eachParent iterates through all the parent items (the immediate parent and its parent, etc until the parent is the component itself)
exists checks if the control exists
filter filters controls by some criteria
forEach iterates over all items of a tree collection
getId gets the ID of an item
getIndex gets the current position of an item
getItem gets an item by its ID
getItems gets the child items of a control
getLength counts child items of a control
getParent gets the ID of the parent of the control
getRoot returns the ID of the master component
haveItems checks whether an item has children
isSaved checks whether the changes made in a tree collection are saved to the server side
load loads items from a file
loadItems loads child items of a control from a file
move moves items to different positions
parse loads a collection of items from a local source
refreshItems refreshes child items of a control
remove removes an item
removeAll clears the component of all controls
restoreOrder restores the component to the state previous to sorting / filtering
save saves changes made in a tree collection to the server side
serialize returns a collection of all items
sort sorts controls according to some criteria
update changes an item

Selection

disable disables selection of cells in TreeGrid
enable enables selection of cells in TreeGrid
getCell returns the object of a selected cell
removeCell unselects previously selected cells
setCell sets selection to a specified cell
Events
afterCollapse fires after collapsing a treegrid
afterColumnDrag fires after dragging of a column is finished
afterColumnDrop fires before the user has finished dragging a column but after the mouse button is released
afterColumnHide fires after a column is hidden
afterColumnShow fires after a column is shown
afterEditEnd fires after editing of a cell is ended
afterEditStart fires after editing of a cell has started
afterExpand fires after expanding a treegrid
afterResizeEnd fires after resizing of a column is ended
afterRowDrag fires after dragging of a row is finished
afterRowDrop fires before the user has finished dragging a row but after the mouse button is released
afterRowHide fires after a row is hidden
afterRowShow fires after a row is shown on a page
beforeCollapse fires before collapsing a treegrid
beforeColumnDrag fires before dragging of a column has started
beforeColumnDrop fires before the user has finished dragging and released the mouse button over a target column
beforeColumnHide fires before a column is hidden
beforeColumnShow fires before a column is shown on a page
beforeEditEnd fires before editing of a cell is ended
beforeEditStart fires before editing of a cell has started
beforeExpand fires before expanding a treegrid
beforeResizeStart fires before resizing of a column has started
beforeRowDrag fires before dragging of a row has started
beforeRowDrop fires before the user has finished dragging and released the mouse button over a target row
beforeRowHide fires before a row is hidden
beforeRowShow fires before a row is shown on a page
canColumnDrop fires when a dragged column is placed over a target column
canRowDrop fires when a dragged row is placed over a target row
cancelColumnDrop fires on moving a mouse pointer out of borders of a column while dragging the column
cancelRowDrop fires on moving a mouse pointer out of borders of a row while dragging the row
cellClick fires on click on a grid cell
cellDblClick fires on double-click on a grid cell
cellMouseDown fires before releasing the left mouse button when clicking on a grid cell
cellMouseOver fires on moving the mouse pointer over a grid cell
cellRightClick fires on right click on a grid cell
dragColumnIn fires when a column is dragged to another potential target
dragColumnOut fires when a column is dragged out of a potential target
dragColumnStart fires when dragging of a column has started
dragRowIn fires when a row is dragged to another potential target
dragRowOut fires when a row is dragged out of a potential target
dragRowStart fires when dragging of a row has started
expand fires on expanding a treegrid
filterChange fires on typing text in an input of a column's header
footerCellClick fires on click on a grid footer cell
footerCellDblClick fires on double-click on a grid footer cell
footerCellMouseDown fires on moving the mouse pointer over a grid footer cell
footerCellMouseOver fires on moving the mouse pointer over a grid footer cell
footerCellRightClick fires on right click on a grid footer cell
headerCellClick fires on click on a grid header cell
headerCellDblClick fires on double-click on a grid footer cell
headerCellMouseDown fires on moving the mouse pointer over a grid header cell
headerCellMouseOver fires on moving the mouse pointer over a grid header cell
headerCellRightClick fires on right click on a grid header cell
headerInput fires on typing text in an input of a column's header
resize fires on resizing a column
scroll fires on scrolling a grid
sort fires on sorting a column by clicking on its header

Tree Collection

afterAdd fires after adding a new item into a tree collection
afterRemove fires after removing a new item from a tree collection
beforeAdd fires before adding a new item into a tree collection
beforeRemove fires before removing an item from a tree collection
change fires when a tree collection is modified
load fires when items are loaded in a tree collection
loadError fires when loading of data fails
removeAll fires when all items are removed from a tree collection

Selection

afterSelect fires after selecting a cell
afterUnSelect fires after unselecting a cell
beforeSelect fires before selecting a cell
beforeUnSelect fires before unselecting a cell
Properties
adjust defines whether the width of columns is automatically adjusted to the width of their content
autoWidth makes treegrid's columns to fit the size of a treegrid
columns specifies the configuration of grid columns
columnsAutoWidth defines whether the width of columns is automatically adjusted to the width of their content
css adds style classes to Grid
data specifies an array of data objects to set into the grid
dragCopy defines that a row is copied to a target during drag-n-drop
dragItem enables the possibility to reorder treegrid columns by drag and drop
dragMode enables drag-n-drop in Grid
editable enables editing in Grid columns
editing enables editing in Grid columns
eventHandlers adds event handlers to HTML elements of a custom template of a TreeGrid cell or to the HTML elements defined in the data set of TreeGrid
fitToContainer makes grid to fit the size of a container
footerRowHeight sets the height of rows in the footer
groupTitleTemplate sets a template to the title of a group
headerRowHeight sets the height of rows in the header
headerSort defines whether sorting on clicking headers of columns is enabled
height sets the height of a grid
htmlEnable specifies the HTML content (inner HTML) of TreeGrid columns
leftSplit sets the number of frozen columns
resizable defines whether columns can be resized
rowCss sets style for a row
rowHeight defines the height of a row in a grid
selection enables selection in a grid
sortable defines whether sorting on clicking headers of columns is enabled
spans describes the configuration of cols/rows spans
splitAt sets the number of frozen columns
tooltip enables a tooltip on hovering over the content of a column
width sets the width of a grid
Back to top