Grid 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
destructor	removes a Grid instance and releases occupied resources
edit	enables editing of a Grid cell
editCell	enables editing of a Grid cell
editEnd	finishes editing in a cell
getCellRect	returns the parameters of a cell
getColumn	returns an object with attributes of a column
getScrollState	returns the coordinates of a position a grid has been scrolled to
getSortingState	returns the current state of sorting data in Grid
getSpan	returns an object with spans
hideColumn	hides a column of Grid
isColumnHidden	checks whether a column 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 Grid columns
showColumn	makes a specified column visible on a page

Data Collection

add	adds a new item to the component
copy	creates a copy of an item at the defined position
exists	checks whether the specified item exists in the component
filter	filters items in the component by the specified key
find	finds an item that corresponds to the specified parameters
findAll	finds all the items that correspond to the specified parameters
getId	returns the id of the item by its index
getIndex	returns the index of the item by its id
getItem	returns the object of an item by its id
load	loads data from an external file
map	iterates through all items of the component
move	moves an item to the defined position
parse	loads data from a local data source
remove	deletes the specified item from the component
removeAll	deletes all the items from the component
serialize	serializes data of the component into an array of JSON objects
sort	sorts data items in a component
update	updates properties of the item

Selection

getCell	returns the object of a selected cell
getCells	returns an array with config objects of selected cells
setCell	sets selection to specified cells

Events

afterEditEnd	fires after editing of a cell is ended
afterEditStart	fires after editing of a cell has started
afterKeyDown	fires after the user is pressing a shortcut key
afterResizeEnd	fires after resizing of a column is ended
beforeColumnDrag	fires before a user drags a column
beforeColumnDrop	fires before a user drops a column
beforeEditEnd	fires before editing of a cell is completed
beforeEditStart	fires before editing of a cell has started
beforeKeyDown	fires before the user is pressing a shortcut key
beforeResizeStart	fires before resizing of a column has started
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
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

Data Collection

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

Properties

adjust	defines whether the width of columns is automatically adjusted to the width of their content
autoEmptyRow	adds an empty row after the last filled row in the Grid
autoWidth	makes grid's columns to fit the size of a grid
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 grid columns by drag and drop
dragMode	enables drag-n-drop in Grid
editable	enables editing in Grid columns
editing	enables editing in Grid columns
fitToContainer	makes grid to fit the size of a container
footerRowHeight	sets the height of rows in the footer
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 Grid columns
keyNavigation	enables keyboard navigation in Grid
multiselection	enables multi-row/multi-cell selection in Grid
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