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
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
getSpan returns an object with spans
hideColumn hides a column of Grid
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 headers for 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
getNearId returns the id of an item which is nearest to the specified one
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
Events
AfterEditEnd fires after editing of a cell is ended
AfterEditStart fires after editing of a cell has started
AfterResizeEnd fires after resizing of a column is ended
BeforeEditEnd fires before editing of a cell has started
BeforeEditStart fires before editing of a cell has started
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
expand fires on expanding a treegrid
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
autoEmptyRow adds an empty row after the last filled row in the 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
dragMode enables drag-n-drop in Grid
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
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
spans describes the configuration of cols/rows spans
splitAt sets the number of frozen columns
width sets the width of a grid
Back to top