Search results

Grid

Represents the Grid component.

<div id="grid"></div>
<script>
 var gridObj = new Grid({ allowPaging: true });
 gridObj.appendTo("#grid");
</script>

Properties

aggregates

AggregateRowModel[]

Configures the Grid aggregate rows.

Check the Aggregates for its configuration.

Defaults to []

allowExcelExport

boolean

If allowExcelExport set to true, then it will allow the user to export grid to Excel file.

Check the ExcelExport to configure exporting document.

Defaults to false

allowFiltering

boolean

If allowFiltering set to true the filter bar will be displayed. If set to false the filter bar will not be displayed. Filter bar allows the user to filter grid records with required criteria.

Check the Filtering to customize its default behavior.

Defaults to false

allowGrouping

boolean

If allowGrouping set to true, then it will allow the user to dynamically group or ungroup columns. Grouping can be done by drag and drop columns from column header to group drop area.

Check the Grouping to customize its default behavior.

Defaults to false

allowMultiSorting

boolean

If allowMultiSorting set to true, then it will allow the user to sort multiple column in the grid.

allowSorting should be true.

Defaults to false

allowPaging

boolean

If allowPaging is set to true, the pager renders at the footer of the Grid. It is used to handle page navigation in the Grid.

Check the Paging to configure the grid pager.

Defaults to false

allowPdfExport

boolean

If allowPdfExport set to true, then it will allow the user to export grid to Pdf file.

Check the Pdfexport to configure the exporting document.

Defaults to false

allowReordering

boolean

If allowReordering is set to true, Grid columns can be reordered. Reordering can be done by drag and drop of a particular column from one index to another index.

If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.

Defaults to false

allowResizing

boolean

If allowResizing is set to true, Grid columns can be resized.

Defaults to false

allowRowDragAndDrop

boolean

If allowRowDragAndDrop is set to true, you can drag and drop grid rows at another grid.

Defaults to false

allowSelection

boolean

If allowSelection is set to true, it allows selection of (highlight row) Grid records by clicking it.

Defaults to true

allowSorting

boolean

If allowSorting is set to true, it allows sorting of grid records when column header is clicked.

Check the Sorting to customize its default behavior.

Defaults to false

allowTextWrap

boolean

If allowTextWrap set to true, then text content will wrap to the next line when its text content exceeds the width of the Column Cells.

Defaults to false

childGrid

GridModel

Defines Grid options to render child Grid. It requires the queryString for parent and child relationship.

Check the Child Grid for its configuration.

clipboardModule

Clipboard

clipboardModule is used to handle Grid copy action.

columnMenuItems

string[] | ColumnMenuItemModel[]

columnMenuItems defines both built-in and custom column menu items.

The available built-in items are,

  • AutoFitAll - Auto fit the size of all columns.
  • AutoFit - Auto fit the current column.
  • Group - Group by current column.
  • Ungroup - Ungroup by current column.
  • SortAscending - Sort the current column in ascending order.
  • SortDescending - Sort the current column in descending order.
  • Filter - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.

Defaults to null

columnMenuModule

ColumnMenu

The columnMenuModule is used to manipulate column menu items and its action in the Grid.

columnQueryMode

string

columnQueryModeprovides options to retrive data from the datasource.Their types are

  • All: It Retrives whole datasource.
  • Schema: Retrives data for all the defined columns in grid from the datasource.
  • ExcludeHidden: Retrives data only for visible columns of grid from the dataSource.

Defaults to All

columns

Column[] | string[] | ColumnModel[]

Defines the schema of dataSource. If the columns declaration is empty or undefined then the columns are automatically generated from data source.

Defaults to []

contextMenuItems

string[] | ContextMenuItemModel[]

contextMenuItems defines both built-in and custom context menu items.

The available built-in items are,

  • AutoFitAll - Auto fit the size of all columns.
  • AutoFit - Auto fit the current column.
  • Group - Group by current column.
  • Ungroup - Ungroup by current column.
  • Edit - Edit the current record.
  • Delete - Delete the current record.
  • Save - Save the edited record.
  • Cancel - Cancel the edited state.
  • Copy - Copy the selected records.
  • PdfExport - Export the grid as Pdf format.
  • ExcelExport - Export the grid as Excel format.
  • CsvExport - Export the grid as CSV format.
  • SortAscending - Sort the current column in ascending order.
  • SortDescending - Sort the current column in descending order.
  • FirstPage - Go to the first page.
  • PrevPage - Go to the previous page.
  • LastPage - Go to the last page.
  • NextPage - Go to the next page.

Defaults to null

contextMenuModule

ContextMenu

The contextMenuModule is used to handle context menu items and its action in the Grid.

currentViewData

Object[]

Gets the currently visible records of the Grid.

dataSource

Object | DataManager | DataResult

It is used to render grid table rows. If the dataSource is an array of JavaScript objects, then Grid will create instance of DataManager from this dataSource. If the dataSource is an existing DataManager, the Grid will not initialize a new one.

Check the available Adaptors to customize the data operation.

Defaults to []

detailTemplate

string

The detail template allows you to show or hide additional information about a particular row.

It accepts either the template string or the HTML element ID.

{% codeBlock src=“grid/detail-template-api/index.ts” %}{% endcodeBlock %}

editModule

Edit

The editModule is used to handle Grid content manipulation.

editSettings

EditSettingsModel

Configures the edit settings.

Defaults to { allowAdding: false, allowEditing: false, allowDeleting: false, mode:‘Normal’,allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }

enableAltRow

boolean

If enableAltRow is set to true, the grid will render with e-altrow CSS class to the alternative tr elements.

Check the AltRow to customize the styles of alternative rows.

Defaults to true

enableAutoFill

boolean

If enableAutoFill is set to true, then the auto fill icon will displayed on cell selection for copy cells. It requires the selection mode to be Cell and cellSelectionMode to be Box.

Defaults to false

enableColumnVirtualization

boolean

If enableColumnVirtualization set to true, then the Grid will render only the columns visible within the view-port and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Grid.

Defaults to false

enableHover

boolean

If enableHover is set to true, the row hover is enabled in the Grid.

Defaults to true

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableVirtualization

boolean

If enableVirtualization set to true, then the Grid will render only the rows visible within the view-port and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.

Defaults to false

excelExportModule

ExcelExport

The excelExportModule is used to handle Excel exporting feature in the Grid.

filterModule

Filter

The filterModule is used to manipulate filtering in the Grid.

filterSettings

FilterSettingsModel

Configures the filter settings of the Grid.

Defaults to {columns: [], type: ‘FilterBar’, mode: ‘Immediate’, showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}

frozenColumns

number

Gets or sets the number of frozen columns.

Defaults to 0

frozenRows

number

Gets or sets the number of frozen rows.

Defaults to 0

gridLines

string

Defines the mode of grid lines. The available modes are,

  • Both: Displays both horizontal and vertical grid lines.
  • None: No grid lines are displayed.
  • Horizontal: Displays the horizontal grid lines only.
  • Vertical: Displays the vertical grid lines only.
  • Default: Displays grid lines based on the theme.

Defaults to Default

groupModule

Group

The groupModule is used to manipulate grouping behavior in the Grid.

groupSettings

GroupSettingsModel

Configures the group settings.

Defaults to {showDropArea: true, showToggleButton: false, showGroupedColumn: false, showUngroupButton: true, columns: []}

height

string | number

Defines the scrollable height of the grid content.

Defaults to auto

hierarchyPrintMode

string

Defines the hierarchy grid print modes. The available modes are

  • Expanded - Prints the master grid with expanded child grids.
  • All - Prints the master grid with all the child grids.
  • None - Prints the master grid alone.

Defaults to Expanded

keyboardModule

KeyboardEvents

The keyboardModule is used to manipulate keyboard interactions in the Grid.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to undefined

pageSettings

PageSettingsModel

Configures the pager in the Grid.

Defaults to {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}

pagerModule

Page

The pagerModule is used to manipulate paging in the Grid.

pdfExportModule

PdfExport

The pdfExportModule is used to handle PDF exporting feature in the Grid.

printMode

string

Defines the print modes. The available print modes are

  • AllPages: Prints all pages of the Grid.
  • CurrentPage: Prints the current page of the Grid.

Defaults to AllPages

printModule

Print

The printModule is used to handle the printing feature of the Grid.

query

Query

Defines the external Query that will be executed along with data processing.

Defaults to null

queryString

string

Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.

reorderModule

Reorder

The reorderModule is used to manipulate reordering in the Grid.

rowDragAndDropModule

RowDD

The rowDragAndDropModule is used to manipulate row reordering in the Grid.

rowDropSettings

RowDropSettingsModel

Configures the row drop settings.

Defaults to {targetID: ”}

rowHeight

number

Defines the height of Grid rows.

Defaults to null

rowTemplate

string

The row template that renders customized rows from the given template. By default, Grid renders a table row for every data source item.

scrollModule

Scroll

The scrollModule is used to manipulate scrolling in the Grid.

searchModule

Search

The searchModule is used to manipulate searching in the Grid.

searchSettings

SearchSettingsModel

Configures the search behavior in the Grid.

Defaults to { ignoreCase: true, fields: [], operator: ‘contains’, key: ” }

selectedRowIndex

number

The selectedRowIndex allows you to select a row at initial rendering. You can also get the currently selected row index.

Defaults to -1

selectionModule

Selection

The selectionModule is used to manipulate selection behavior in the Grid.

selectionSettings

SelectionSettingsModel

Configures the selection settings.

Defaults to {mode: ‘Row’, cellSelectionMode: ‘Flow’, type: ‘Single’}

showColumnChooser

boolean

If showColumnChooser is set to true, it allows you to dynamically show or hide columns.

Check the ColumnChooser for its configuration.

Defaults to false

showColumnMenu

boolean

If showColumnMenu set to true, then it will enable the column menu options in each columns.

Check the Column menu for its configuration.

Defaults to false

showHider

ShowHide

The showHider is used to manipulate column’s show/hide operation in the Grid.

sortModule

Sort

The sortModule is used to manipulate sorting in the Grid.

sortSettings

SortSettingsModel

Configures the sort settings.

Defaults to {columns:[]}

textWrapSettings

TextWrapSettingsModel

Configures the text wrap in the Grid.

Defaults to {wrapMode:“Both”}

toolbar

[]

toolbar defines the ToolBar items of the Grid. It contains built-in and custom toolbar items. If a string value is assigned to the toolbar option, it is considered as the template for the whole Grid ToolBar. If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid’s Toolbar.

The available built-in ToolBar items are:

  • Add: Adds a new record.
  • Edit: Edits the selected record.
  • Update: Updates the edited record.
  • Delete: Deletes the selected record.
  • Cancel: Cancels the edit state.
  • Search: Searches records by the given key.
  • Print: Prints the Grid.
  • ExcelExport - Export the Grid to Excel(excelExport() method manually to make export.)
  • PdfExport - Export the Grid to PDF(pdfExport() method manually to make export.)
  • CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)

    The following code example implements the custom toolbar items.

    Check the Toolbar to customize its default items.

{% codeBlock src=“grid/toolbar-api/index.ts” %}{% endcodeBlock %}

Defaults to null

toolbarModule

Toolbar

The toolbarModule is used to manipulate ToolBar items and its action in the Grid.

width

string | number

Defines the Grid width.

Defaults to auto

Methods

addEventListener

Adds the handler to the given event listener.

Returns void

addRecord

Adds a new record to the Grid. Without passing parameters, it adds empty rows.

editSettings.allowEditing should be true.

Parameter Type Description
data (optional) Object Defines the new add record data.
index (optional) number Defines the row index to be added

Returns void

appendTo

Appends the control within the given HTML element

Parameter Type Description
selector (optional) string | HTMLElement Target element where control needs to be appended

Returns void

autoFitColumns

Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.

  • This method ignores the hidden columns.
  • Uses the autoFitColumns method in the dataBound event to resize at initial rendering.
Parameter Type Description
fieldNames (optional) string | string[] Defines the column names.

Returns void

clearFiltering

Clears all the filtered rows of the Grid.

Returns void

clearSelection

Deselects the current selected rows and cells.

Returns void

clearSorting

Clears all the sorted columns of the Grid.

Returns void

closeEdit

Cancels edited state.

Returns void

copy

Copy the selected rows or cells data into clipboard.

Parameter Type Description
withHeader (optional) boolean Specifies whether the column header text needs to be copied along with rows or cells.

Returns void

csvExport

Export Grid data to CSV file.

Parameter Type Description
excelExportProperties (optional) ExcelExportProperties Defines the export properties of the Grid.
isMultipleExport (optional) boolean Define to enable multiple export.
workbook (optional) any Defines the Workbook if multiple export is enabled.
isBlob (optional) boolean If ‘isBlob’ set to true, then it will be returned as blob data.

Returns Promise

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

deleteRecord

Delete a record with Given options. If fieldname and data is not given then grid will delete the selected record.

editSettings.allowDeleting should be true.

Parameter Type Description
fieldname (optional) string Defines the primary key field, ‘Name of the column’.
data (optional) Object Defines the JSON data of the record to be deleted.

Returns void

deleteRow

Delete any visible row by TR element.

Parameter Type Description
tr HTMLTableRowElement Defines the table row element.

Returns void

destroy

Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).

Returns void

destroyTemplate

Destroys the given template reference.

Returns void

endEdit

If Grid is in editable state, you can save a record by invoking endEdit.

Returns void

excelExport

Export Grid data to Excel file(.xlsx).

Parameter Type Description
excelExportProperties (optional) ExcelExportProperties Defines the export properties of the Grid.
isMultipleExport (optional) boolean Define to enable multiple export.
workbook (optional) any Defines the Workbook if multiple export is enabled.
isBlob (optional) boolean If ‘isBlob’ set to true, then it will be returned as blob data.

Returns Promise

filterByColumn

Filters grid row by column name with the given options.

Parameter Type Description
fieldName string Defines the field name of the column.
filterOperator string Defines the operator to filter records.
filterValue string | number | Date | boolean Defines the value used to filter records.
predicate (optional) string Defines the relationship between one filter query and another by using AND or OR predicate.
matchCase (optional) boolean If match case is set to true, the grid filters the records with exact match. if false, it filters case
insensitive records (uppercase and lowercase letters treated the same).
ignoreAccent (optional) boolean If ignoreAccent set to true,
then filter ignores the diacritic characters or accents while filtering.
actualFilterValue (optional) string Defines the actual filter value for the filter column.
actualOperator (optional) string Defines the actual filter operator for the filter column.

Returns void

getCellFromIndex

Gets a cell by row and column index.

Parameter Type Description
rowIndex number Specifies the row index.
columnIndex number Specifies the column index.

Returns Element

getColumnByField

Gets a Column by column name.

Parameter Type Description
field string Specifies the column name.

Returns Column

getColumnByUid

Gets a column by UID.

Parameter Type Description
uid string Specifies the column UID.

Returns Column

getColumnFieldNames

Gets the collection of column fields.

Returns string[]

getColumnHeaderByField

Gets a column header by column name.

Parameter Type Description
field string Specifies the column name.

Returns Element

getColumnHeaderByIndex

Gets a column header by column index.

Parameter Type Description
index number Specifies the column index.

Returns Element

getColumnHeaderByUid

Gets a column header by UID.

Returns Element

getColumnIndexByField

Gets a column index by column name.

Parameter Type Description
field string Specifies the column name.

Returns number

getColumnIndexByUid

Gets a column index by UID.

Parameter Type Description
uid string Specifies the column UID.

Returns number

getColumns

Gets the columns from the Grid.

Returns Column[]

getContent

Gets the content div of the Grid.

Returns Element

getContentTable

Gets the content table of the Grid.

Returns Element

getDataModule

Gets the data module.

Returns Data

getDataRows

Gets all the Grid’s data rows.

Returns Element[]

getFooterContent

Gets the footer div of the Grid.

Returns Element

getFooterContentTable

Gets the footer table element of the Grid.

Returns Element

getForeignKeyColumns

Gets the foreign columns from Grid.

Returns Column[]

getHeaderContent

Gets the header div of the Grid.

Returns Element

getHeaderTable

Gets the header table element of the Grid.

Returns Element

getMovableCellFromIndex

Gets a movable table cell by row and column index.

Parameter Type Description
rowIndex number Specifies the row index.
columnIndex number Specifies the column index.

Returns Element

getMovableDataRows

Gets all the Grid’s movable table data rows.

Returns Element[]

getMovableRowByIndex

Gets a movable tables row by index.

Parameter Type Description
index number Specifies the row index.

Returns Element

getMovableRows

Gets the Grid’s movable content rows from frozen grid.

Returns Element[]

getPager

Gets the pager of the Grid.

Returns Element

getPrimaryKeyFieldNames

Get the names of the primary key columns of the Grid.

Returns string[]

getRowByIndex

Gets a row by index.

Parameter Type Description
index number Specifies the row index.

Returns Element

getRowInfo

Get a row information based on cell

Returns RowInfo

getRows

Gets all the data rows of the Grid.

Returns Element[]

getSelectedRecords

Gets the collection of selected records.

Returns Object[]

getSelectedRowCellIndexes

Gets the collection of selected row and cell indexes.

Returns ISelectedCell[]

getSelectedRowIndexes

Gets the collection of selected row indexes.

Returns number[]

getSelectedRows

Gets the collection of selected rows.

Returns Element[]

getUidByColumnField

Gets UID by column name.

Parameter Type Description
field string Specifies the column name.

Returns string

getVisibleColumns

Gets the visible columns from the Grid.

Returns Column[]

goToPage

Navigates to the specified target page.

Parameter Type Description
pageNo number Defines the page number to navigate.

Returns void

groupColumn

Groups a column by column name.

Parameter Type Description
columnName string Defines the column name to group.

Returns void

hideColumns

Hides a column by column name.

Parameter Type Description
keys string | string[] Defines a single or collection of column names.
hideBy (optional) string Defines the column key either as field name or header text.

Returns void

hideSpinner

Manually showed spinner needs to hide by hideSpinnner.

Returns void

pdfExport

Export Grid data to PDF document.

Returns Promise

print

By default, prints all the pages of the Grid and hides the pager.

You can customize print options using the printMode.

Returns void

refresh

Refreshes the Grid header and content.

Returns void

refreshColumns

Refreshes the Grid column changes.

Returns void

refreshHeader

Refreshes the Grid header.

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

reorderColumns

Changes the Grid column positions by field names.

Parameter Type Description
fromFName string | string[] Defines the origin field name.
toFName string Defines the destination field name.

Returns void

reorderRows

Changes the Grid Row position with given indexes.

Parameter Type Description
fromIndexes number[] Defines the origin Indexes.
toIndex number Defines the destination Index.

Returns void

Searches Grid records using the given key. You can customize the default search option by using the searchSettings.

Parameter Type Description
searchString string Defines the key.

Returns void

selectCell

Selects a cell by the given index.

Parameter Type Description
cellIndex IIndex Defines the row and column indexes.
isToggle (optional) boolean If set to true, then it toggles the selection.

Returns void

selectCellsByRange

Selects a range of cells from start and end indexes.

Parameter Type Description
startIndex IIndex Specifies the row and column’s start index.
endIndex (optional) IIndex Specifies the row and column’s end index.

Returns void

selectRow

Selects a row by given index.

Parameter Type Description
index number Defines the row index.
isToggle (optional) boolean If set to true, then it toggles the selection.

Returns void

selectRows

Selects a collection of rows by indexes.

Parameter Type Description
rowIndexes number[] Specifies the row indexes.

Returns void

setCellValue

Updates particular cell value based on the given primary key value.

Primary key column must be specified using columns.isPrimaryKey property.

Parameter Type Description
key string | number Specifies the PrimaryKey value of dataSource.
field string Specifies the field name which you want to update.
value string | number | boolean | Date To update new value for the particular cell.

Returns void

setGridContent

Sets the content div of the Grid to replace the old Grid content.

Parameter Type Description
element Element Specifies the Grid content.

Returns void

setGridContentTable

Sets the content table of the Grid to replace the old content table.

Parameter Type Description
element Element Specifies the Grid content table.

Returns void

setGridHeaderContent

Sets the header div of the Grid to replace the old header.

Parameter Type Description
element Element Specifies the Grid header.

Returns void

setGridHeaderTable

Sets the header table of the Grid to replace the old one.

Parameter Type Description
element Element Specifies the Grid header table.

Returns void

setGridPager

Sets the pager of the Grid to replace the old pager.

Parameter Type Description
element Element Specifies the Grid pager.

Returns void

setRowData

Updates and refresh the particular row values based on the given primary key value.

Primary key column must be specified using columns.isPrimaryKey property. @param {string| number} key - Specifies the PrimaryKey value of dataSource. @param {Object} rowData - To update new data for the particular row.

Returns void

showColumns

Shows a column by its column name.

Parameter Type Description
keys string | string[] Defines a single or collection of column names.
showBy (optional) string Defines the column key either as field name or header text.

Returns void

showSpinner

By default, grid shows the spinner for all its actions. You can use this method to show spinner at your needed time.

Returns void

sortColumn

Sorts a column with the given options.

Parameter Type Description
columnName string Defines the column name to be sorted.
direction string Defines the direction of sorting field.
isMultiSort (optional) boolean Specifies whether the previous sorted columns are to be maintained.

Returns void

startEdit

To edit any particular row by TR element.

Returns void

ungroupColumn

Ungroups a column by column name.

Parameter Type Description
columnName string Defines the column name to ungroup.

Returns void

updateExternalMessage

Defines the text of external message.

Parameter Type Description
message string Defines the message to update.

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void

Events

actionBegin

EmitType<PageEventArgs|GroupEventArgs|FilterEventArgs|SearchEventArgs|SortEventArgs|AddEventArgs|SaveEventArgs|EditEventArgs|DeleteEventArgs>

Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.

actionComplete

EmitType<PageEventArgs|GroupEventArgs|FilterEventArgs|SearchEventArgs|SortEventArgs|AddEventArgs|SaveEventArgs|EditEventArgs|DeleteEventArgs>

Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.

actionFailure

EmitType<FailureEventArgs>

Triggers when any Grid action failed to achieve the desired results.

batchAdd

EmitType<BatchAddArgs>

Triggers when records are added in batch mode.

batchCancel

EmitType<BatchCancelArgs>

Triggers when cancel the batch edit changes batch mode.

batchDelete

EmitType<BatchDeleteArgs>

Triggers when records are deleted in batch mode.

beforeBatchAdd

EmitType<BeforeBatchAddArgs>

Triggers before records are added in batch mode.

beforeBatchDelete

EmitType<BeforeBatchDeleteArgs>

Triggers before records are deleted in batch mode.

beforeBatchSave

EmitType<BeforeBatchSaveArgs>

Triggers before records are saved in batch mode.

beforeCopy

EmitType<BeforeCopyEventArgs>

Triggers before Grid copy action.

beforeDataBound

EmitType<BeforeDataBoundArgs>

Triggers before data is bound to Grid.

beforeExcelExport

EmitType<Object>

Triggers before Grid data is exported to Excel file.

beforeOpenColumnChooser

EmitType<ColumnChooserEventArgs>

Triggers before the columnChooser open.

beforePdfExport

EmitType<Object>

Triggers before Grid data is exported to PDF document.

beforePrint

EmitType<PrintEventArgs>

Triggers before the print action starts.

beginEdit

EmitType<BeginEditArgs>

Triggers before the record is to be edit.

cellDeselected

EmitType<CellDeselectEventArgs>

Triggers when a particular selected cell is deselected.

cellDeselecting

EmitType<CellDeselectEventArgs>

Triggers before the selected cell is deselecting.

cellEdit

EmitType<CellEditArgs>

Triggers when the cell is being edited.

cellSave

EmitType<CellSaveArgs>

Triggers when cell is saved.

cellSaved

EmitType<CellSaveArgs>

Triggers when cell is saved.

cellSelected

EmitType<CellSelectEventArgs>

Triggers after a cell is selected.

cellSelecting

EmitType<CellSelectingEventArgs>

Triggers before any cell selection occurs.

checkBoxChange

EmitType<CheckBoxChangeEventArgs>

Triggers when the check box state change in checkbox column.

columnDrag

EmitType<ColumnDragEventArgs>

Triggers when column header element is dragged (moved) continuously.

columnDragStart

EmitType<ColumnDragEventArgs>

Triggers when column header element drag (move) starts.

columnDrop

EmitType<ColumnDragEventArgs>

Triggers when a column header element is dropped on the target column.

columnMenuClick

EmitType<MenuEventArgs>

Triggers when click on column menu.

columnMenuOpen

EmitType<ColumnMenuOpenEventArgs>

Triggers before column menu opens.

contextMenuClick

EmitType<MenuEventArgs>

Triggers when click on context menu.

contextMenuOpen

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before context menu opens.

created

EmitType<Object>

Triggers when the component is created.

dataBound

EmitType<Object>

Triggers when data source is populated in the Grid.

dataSourceChanged

EmitType<DataSourceChangedEventArgs>

Triggers when the grid data is added, deleted and updated. Invoke the done method from the argument to start render after edit operation.

dataStateChange

EmitType<DataStateChangeEventArgs>

Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done. In this event,the current view data and total record count should be assigned to the dataSource based on the action performed.

destroyed

EmitType<Object>

Triggers when the component is destroyed.

detailDataBound

EmitType<DetailDataBoundEventArgs>

Triggers after detail row expands.

This event triggers at initial expand.

excelExportComplete

EmitType<ExcelExportCompleteArgs>

Triggers after Grid data is exported to Excel file.

excelHeaderQueryCellInfo

EmitType<ExcelHeaderQueryCellInfoEventArgs>

Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.

excelQueryCellInfo

EmitType<ExcelQueryCellInfoEventArgs>

Triggers before exporting each cell to Excel file. You can also customize the Excel cells.

exportDetailDataBound

EmitType<ExportDetailDataBoundEventArgs>

Triggers before exporting each detail Grid to PDF document.

headerCellInfo

EmitType<HeaderCellInfoEventArgs>

Triggered for stacked header.

load

EmitType<Object>

This event allows customization of Grid properties before rendering.

pdfExportComplete

EmitType<PdfExportCompleteArgs>

Triggers after Grid data is exported to PDF document.

pdfHeaderQueryCellInfo

EmitType<PdfHeaderQueryCellInfoEventArgs>

Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.

pdfQueryCellInfo

EmitType<PdfQueryCellInfoEventArgs>

Triggers before exporting each cell to PDF document. You can also customize the PDF cells.

printComplete

EmitType<PrintEventArgs>

Triggers after print action is completed.

queryCellInfo

EmitType<QueryCellInfoEventArgs>

Triggered every time a request is made to access cell information, element, or data. This will be triggered before the cell element is appended to the Grid element.

recordDoubleClick

EmitType<RecordDoubleClickEventArgs>

Triggers when record is double clicked.

resizeStart

EmitType<ResizeArgs>

Triggers when column resize starts.

resizeStop

EmitType<ResizeArgs>

Triggers when column resize ends.

resizing

EmitType<ResizeArgs>

Triggers on column resizing.

rowDataBound

EmitType<RowDataBoundEventArgs>

Triggered every time a request is made to access row information, element, or data. This will be triggered before the row element is appended to the Grid element.

rowDeselected

EmitType<RowDeselectEventArgs>

Triggers when a selected row is deselected.

rowDeselecting

EmitType<RowDeselectEventArgs>

Triggers before deselecting the selected row.

rowDrag

EmitType<RowDragEventArgs>

Triggers when row elements are dragged (moved) continuously.

rowDragStart

EmitType<RowDragEventArgs>

Triggers when row element’s drag(move) starts.

rowDragStartHelper

EmitType<RowDragEventArgs>

Triggers when row element’s before drag(move).

rowDrop

EmitType<RowDragEventArgs>

Triggers when row elements are dropped on the target row.

rowSelected

EmitType<RowSelectEventArgs>

Triggers after a row is selected.

rowSelecting

EmitType<RowSelectingEventArgs>

Triggers before row selection occurs.

toolbarClick

EmitType<ClickEventArgs>

Triggers when toolbar item is clicked.

Contents
Contents