Documentation

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
addSpan adds colspan or rowspan to the datatable
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 behaviour customizations)
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
clearAll removes all items from the component
clearCss removes css class from all items
clearSelection clears selection
clearValidation removes all validation marks from the component
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
exportToExcel exports data to an Excel file
exportToPDF exports data to a PDF file
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
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
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
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
getNode returns the main HTML container for the calling object
getPage returns the currently visible page in case of paged view
getPager returns the pager object associated with the component
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
getScrollState returns the current position of scrolls
getSelectedId returns the selected cells
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
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.
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
mapSelection executes some custom method for all cells in the currently selected block
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
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 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
removeSpan removes a rowspan/colspan from the datatable
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
select selects the specified element
selectRange selects the specified range of elements
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
ungroup ungroups data
unselect cancels selection of the specified element
updateItem sets properties of the data item
validate validates one record or all dataset against validation rules
validateEditor validates data in currently active editor
Back to top