ui.treetable

A control for presenting tree in a grid cell.

The component is used to integrate a tree into an editable grid. There is a support for in-line node editing, drag-and-drop, filtering, checkboxes etc. Check treetable documentation for more detailed description.

Constructor

var treetable = webix.ui({
    view:"treetable",
    columns:[
      { id:"id", header:"", width:50},
      { id:"value", header:"Film title", width:250,
       template:"{common.treetable()} #value#" },
      { id:"chapter", header:"Mode", width:200}
    ],    
    data: [
      { "id":"1", "value":"The Shawshank Redemption", "open":true, "data":[
        { "id":"1.1", "value":"Part 1", "chapter":"alpha"},
        { "id":"1.2", "value":"Part 2", "chapter":"beta", "open":true, "data":[
          { "id":"1.2.1", "value":"Part 1", "chapter":"beta-twin"}
        ]}
      ]}
    ]
});

Where to start

Methods
add adds an item to the store
addCellCss adds a css class to the cell
addCss applied CSS class to a component item
addRowCss adds a css class to the row
adjust adjusts the component to the size of the parent HTML container
adjustColumn adjusts a column to the width of the content
adjustRowHeight autodetect height of rows in datatable
attachEvent attaches the handler to an inner event of the component (allows behavior customizations)
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
checkAll check all items in tree
checkItem checks the checkbox it the tree item
clearAll removes all items from the component
clearCss removes CSS class from all items
clearValidation removes all validation marks from the component
close closes the branch with the specified id
closeAll closes all branches in the tree
collectValues returns an array of unique values of the specified column
columnId returns the id of the column at the specified index
copy copies an item to the same or another object
count returns the number of currently visible items
define redefines a single configuration property (or a hash of properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
eachColumn iterates over all visible columns in the table
eachRow iterates over all rows in the table
edit enables the edit mode for the specified item
editCancel cancels the edit mode and closes all opened editors. The component is still editable
editCell enables the edit mode for the specified cell
editColumn enables the edit mode for the specified column
editNext closes the current editor and opens one in the next cell of the row
editRow enables the edit mode for the specified row
editStop stops the edit mode and closes all opened editors. The component is still editable
enable enables the calling view that was disabled by the 'disable' method
exists checks whether an item with the specified id exists
filter filters the component
filterByAll refilters DataTable by all specified filters
find returns rows that match the criterion
focusEditor moves focus to the active editor
freezeRow fixes a row at the top of the datatable "on the fly"
getBranchIndex gets index of the node in a specific branch
getChecked returns ids of the checked items
getChildViews returns child views of the calling component
getColumnConfig returns the configuration object of the specified column
getColumnIndex returns the index of the column with the specified id
getCss returns the className of a cell
getEditState returns info about active editor object
getEditor returns editor object
getEditorValue returns the value of the active (currently open) editor
getFilter returns the filter object that the component uses to filter the values of the specified column
getFirstChildId gets the ID of the first child of the specified branch
getFirstId returns the ID of the first item
getFormView returns master form for the input
getHeaderContent returns set of helpers for header content manipulation
getHeaderNode returns HTML element of the column's header
getIdByIndex returns the id of the item with the specified index
getIndexById returns the index of the item with the specified id
getItem gets the object of the data item with the specified id
getItemNode returns HTML element of the item
getLastId returns the id of the last item
getNextId returns the ID of an item which is positioned the specified step after the specified item
getNextSiblingId returns the id of the next sibling of the specified node
getNode returns the main HTML container for the calling object
getOpenItems returns ids of the opened branches
getPage returns the currently visible page in case of paged view
getPager returns the pager object associated with the component
getParentId get the ID of the parent node of the specified item
getParentView returns the parent view of the component
getPrevId returns the ID of an item which is positioned the specified step before the specified item
getPrevSiblingId returns the id of the previous sibling of the specified node
getScrollState returns the current position of scrolls
getSelectedId returns the selected elements' ids
getSelectedItem gets an object of the selected data item
getState returns the current state of the view
getText returns text value of a cell
getTopParentView returns top parent view
getVisibleCount returns count of visible rows
group groups data by the specified data property
hasCss checks if item has specific css class
hasEvent checks whether the component has the specified event
hide hides the view
hideColumn hides the specified column
hideOverlay hides previously defined overlay
isBranch checks whether the node has any children
isBranchOpen checks whether the specified branch is open or closed
isChecked checks whether the specified node is checked
isColumnVisible returns true if column is visible
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
load loads data from an external data source.
loadBranch loads data to the specified branch, as direct children of the node with the id provided
loadNext sends a request to load the specified number of records to the end of the clientside dataset or to the specified position
locate converts an HTML node or event object to in-table position
mapCells applies the callback to a range of cells
mapEvent routes events from one object to another
markSorting marks the sorted column with a dedicated sign (asc/desc) in the header
move moves the specified item to a new position
moveBottom moves the specified item to the last position
moveColumn moves column to different position
moveDown increases the item index and moves the item to the new position
moveSelection moves selection in the specified direction
moveTop moves the specified item to the first position
moveUp decreases the item index and moves the item to the new position
open opens the branch with the specified id
openAll opens all branches in the tree
parse loads data to the component from an inline data source
refresh repaints the whole view or a certain item
refreshColumns refreshes the structure of DataTable
refreshFilter rebuilds list of options in select filter
refreshHeaderContent refreshes the header row of DataTable
registerFilter registers a filter element
remove removes the specified item/items from datastore
removeCellCss remove css class from the cell of datatable
removeCss removes CSS class from a component item
removeRowCss remove css class from the row
render renders the specified item or the whole component
resize adjusts the view to a new size
scrollTo scrolls the view to the defined position
serialize serializes data to a JSON object
setColumnWidth sets the width of the specified column
setPage makes the specified page visible (assuming that the pager was defined )
setRowHeight sets the height of the specified row
setState restores the specified state
show makes the component visible
showCell scrolls the table (if needed) to make the specified cell visible
showColumn shows the column which was previously hidden by method 'hidecolumn'
showColumnBatch shows or hides a group of columns
showItem 'scrolls' the table to make the specified row visible
showItemByIndex 'scrolls' the table to make the specified row visible
showOverlay shows the overlay message over the body of DataTable
sort sorts datastore
sync allows syncing two copies of data (all or just a part of it) from one DataCollection to another
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
uncheckAll uncheck all items in the tree
uncheckItem unchecks the checkbox in the tree item
ungroup ungroups data
updateItem updates the data item with new properties
validate validates one record or all dataset against validation rules
validateEditor validates data in currently active editor
Events
onAfterAdd fires after adding item to datastore
onAfterAreaAdd fires after a select area was added
onAfterAreaRemove fires after a select area was removed
onAfterBlockSelect event occurs after block selection
onAfterClose fires after the branch has been closed
onAfterColumnDrop fires after the column has been dragged and dropped to the target position
onAfterColumnDropOrder fires after the column order was changed with the help of drag-and-drop
onAfterColumnHide fires after a column was hidden in datatable
onAfterColumnShow fires when a column is shown in datatable
onAfterContextMenu fires after the context menu was called in the item area
onAfterDelete fires after item deleting
onAfterDrop fires after drag-n-drop was finished
onAfterDropOrder called when dnd reordering is fully finished
onAfterEditStart fires after edit operation was initiated, editor opened and ready for input
onAfterEditStop fires after edit operation finished
onAfterFilter occurs after datatable was filtered
onAfterLoad fires after data loading is complete
onAfterOpen fires after the branch has been opened
onAfterRender occurs each time after the view is rendered
onAfterScroll occurs when some webix view has been scrolled
onAfterSelect fires after a cell is selected
onAfterSort fires after sorting dataset
onAfterUnSelect fires after a cell is unselected
onAreaDrag fires when area selection is started
onBeforeAdd fires before adding item to datastore
onBeforeAreaAdd fires before a select area is added
onBeforeAreaRemove fires before a select area is removed
onBeforeBlockSelect event occurs before block selection
onBeforeClose fires the moment you attempt to close the tree branch
onBeforeColumnDrag fires the moment you start dragging the column from its source position
onBeforeColumnDrop fires the moment you drop the column to its target position
onBeforeColumnDropOrder fires the moment you drop the column over the target area
onBeforeColumnHide fires before a column is hidden in datatable
onBeforeColumnShow fires before a column is shown in datatable
onBeforeContextMenu fires before the context menu is called in the item area
onBeforeDelete fires before item deleting
onBeforeDrag fires before the mouse button is pressed and the cursor is moved over a draggable item
onBeforeDragIn fires before a dragged element is moved over the droppable area
onBeforeDrop fires before a dragged element is released over the droppable area
onBeforeDropOrder called when dnd reordering has been made, but not applied yet
onBeforeDropOut fires before a dragged element is released over the droppable area
onBeforeEditStart fires before edit operation is initiated
onBeforeEditStop fires before stop edit command is received
onBeforeFilter called when filtering process is started, but data is not filtered yet
onBeforeLoad occurs immediately before data loading has been started
onBeforeOpen fires the moment you attempt to open the tree branch
onBeforeRender occurs each time before the view is rendered
onBeforeSelect fires before a cell is selected
onBeforeSort fires before sorting dataset
onBeforeUnSelect fired before a cell is unselected
onBindRequest fires when the component is ready to receive data from the master component
onBlur fires when focus is moved out of the view
onCheck fires when a checkbox is checked or unchecked in the datatable item
onCollectValues fires after datatable has collected options
onColumnResize fires when width of column was changed
onDataRequest fires when data from the server is requested for linear data structures (List, DataTable, DataView etc.) to implement dynamic data loading
onDataUpdate fires when data item is in update process
onDestruct occurs when component destroyed
onDragOut fires when a dragged element is moved outside of the droppable area
onEditorChange fires when the native onchange event occurs for an HTML input (select, text)
onFocus fires when a view gets focus
onHeaderClick occurs after clicking on header
onItemCheck fires when you check an item in tree and treetable
onItemClick fires when a component item was clicked
onItemDblClick fires when a component item was double-clicked
onKeyPress occurs when keyboard key is pressed for the control in focus
onLiveEdit occurs when data was changed in the editor
onLoadError fires when an error occurs during data loading ( invalid server side response )
onLongTouch fires on holding finger in some position for a certain period of time
onMouseMove fires when the mouse was moved over the specified component
onMouseMoving fires when the mouse was moved over the component
onMouseOut fires when the mouse was moved out from the specified item
onResize fires when the width or height of DataTable was changed
onRowResize fires when height of row was changed
onScrollX fires when the user scrolls the table left or right
onScrollY fires when the user scrolls the table up or down
onSelectChange fires when selection is changed in a DataTable
onStructureLoad fires when the structure of DataTable (columns configuration) is initialized
onStructureUpdate fires when structure of datatable was changed ( column added, hidden or reconfigured )
onSubViewClose fires after a subview or a subrow is closed
onSubViewCreate fires after a subview was created
onSubViewOpen fires after a subview or a subrow is opened
onSubViewRender fires each time subview is rendered
onSwipeX occurs on a horizontal swipe movement
onSwipeY occurs on a vertical swipe movement
onTimedKeyPress fires after typing has been finished in the field
onTouchEnd occurs when the touch event is ended
onTouchMove occurs during touch movement
onTouchStart when some webix view has been touched
onValidationError fires when newly loaded/added/edited data fails to pass validation
onValidationSuccess fires after the newlyloaded/added/edited data has passes validation successfully
onViewResize view size was changed by resizer
Properties
animate defines or disables view change animation.
areaselect enables/disables area selection
autoConfig datatable adjust configuration to the data
autoheight adjusts Datatable size to the its content vertically
autowidth adjusts Datatable size to its content horizontally
blockselect enables/disables block selection
borderless used to hide the component borders
checkboxRefresh controls behavior of checkbox editors in grid
clipboard enables/disables clipboard support
columnWidth defines the default width for columns (in pixels)
columns configures columns of the table
container an HTML container (or its id) where the component should be initialized
css the name of a css class that will be applied to the view container
data JavaScript array containing data for the component
datafetch defines the number of records that will be loaded into datatable during the next dynamic loading call
datathrottle sets the polling interval (the time period between the completion of a network request and the next request for data)
datatype the type of loaded data
delimiter sets CSV delimiters for clipboard operations
disabled indicates whether an item is enabled
drag enables or disables drag-and-drop
dragColumn enables drag-and-drop support for columns
dragscroll enables autoscroll of component during drag-n-drop
editMath enables formular editing
editValue defines which data item is editable (in case of several data item in the cell/line)
editable allows/denies editing in the view
editaction defines the action on which editors will be opened
externalData allows defining custom 'move' logic for the component.
filterMode defines filtering rules in tree-like components
fixedRowHeight defines whether the height should be fixed for all rows or can vary
footer enables/disables the footer in DataTable (disabled, by default)
form linked form
gravity sets the view gravity (1 by default)
header enables/disables the header in DataTable (enabled, by default)
headerRowHeight sets the heigth of the header row
headermenu adds a headermenu to control column visibility
height sets the height of the component
hidden defines whether the view will be hidden initially
hover css class for a row-hover in the datatable
id the component ID
leftSplit the number of the fixed columns from the left side of the table (actual for the split mode )
liveValidation validation during cell editing
loadahead sets the number of items that will be loaded on each scroll movement relative to the last item in the scrolling direction
map defines data mapping
math enables math formulas in DataTable
maxHeight sets the maximum height for the view
maxWidth sets the maximum width for the view
minColumnHeight sets the minimum height for a row
minColumnWidth sets the minimum width for a column
minHeight sets the minimal height for the view
minWidth sets the minimal width for the view
mouseEventDelay the delay between a real mouse action and invoking the related events
multiselect enables the multi selection mode
navigation activates the selection keyboard navigation
on allows attaching custom handlers to inner events of the component
onClick attaches a click behavior for component items with the specified CSS class.
onContext a property used to define custom context-click (right click) handlers for elements in the DataTable cells
onDblClick attaches a dblclick behavior for component items with the specified CSS class.
onMouseMove attaches a mousemove behaviour for component items with the specified CSS class.
pager defines paging configuration ( creates a 'ui.pager' object)
prerender invokes the full rendering of DataTable data
ready event handler called just after the component has been completely initialized
removeMissed defines how to treat items in case of reloading
resizeColumn enables/disables horizontal resizing of columns
resizeRow enables/disables vertical resizing of rows
rightSplit sets the number of the fixed columns from the right side of the table (actual for the split mode )
rowHeight sets the default height for rows
rowLineHeight default line height for grid's row
rules set of validation rules for the component
save defines URLs for data saving
scheme defines schemes for data processing
scroll enables or disables scroll for the datatable
scrollAlignY enables/disables scrolling the table just by whole rows (i.e. you won't be allowed to scroll along the full length of rows)
scrollX enables/disables horizontal scrolling
scrollY enables/disables vertical scrolling
select sets the selection mode in DataTable
spans array of span configurations for the datatable
subRowHeight automatically adjusts the subrow's height to the size of the text
subrow sets a subrow template
subview adds a subview configuration into datatable
threeState defines three-state checkboxes for the tree
tooltip sets a popup message appearing on pointing a mouse cursor over the dedicated item
topSplit defines the number of rows that will be "frozen" at the top of datatable
type used for configuring presentation of items
url the URL which the component will use to load data after its initialization
width sets the width of the component
yCount defines height of datatable in rows
Other
$drag method called when drag operation initiated
$dragHTML defines how dragged item will look
$dragIn method called when item moved on possible drop landing during dnd
$dragMark method called during drag-n-drop, when some item in the component should be marked as an active drop target
$dragOut method called when item moved out of possible drop landing during dnd
$drop method called when item dragged and dropped on valid target
$dropAllow can be redefined, if you need custom drop rules
$getSize returns the current size of the component
$height current height of the view
$scope scope for resolving event and method names
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to top html element of the view
$width current width of the view
config all options from initial component configuration
headerContent a hash property containing a collection of active elements which can be placed in the header
name indicates the name of the component (a read-only property)
on_click redefines default click behavior for component items.
on_context a property used to define custom context-click (right click) handlers for elements in the DataTable cells
on_dblclick attaches a dblclick behavior for component items with the specified CSS class
on_mouse_move attaches a mouse move behavior for component items with the specified CSS class
waitData eventual result of an asynchronous operation ('promise' object) for the loaded data
Back to top