Grid API Reference

Properties

appearance object Please expand entry to see sub properties
behavior object Please expand entry to see sub properties
layout object Please expand entry to see sub properties
clipboard object Please expand entry to see sub properties
columns Smart.Grid.Column[] | {label: string, dataField: string}[] "[]"
columnMenu object Please expand entry to see sub properties
columnGroups [] []
charting object Please expand entry to see sub properties
checkBoxes object Please expand entry to see sub properties
dataExport object Please expand entry to see sub properties
dataSource Smart.DataAdapter null
editing object Please expand entry to see sub properties
filtering object Please expand entry to see sub properties
grouping object Please expand entry to see sub properties
messages object Please expand entry to see value
onCellValue function | null null
onCellUpdate function | null null
onCellRender function | null null
onBeforeInit function | null null
onInit function | null null
onAfterInit function | null null
onChartInit function | null null
onRender function | null null
onKey function | null null
onRowInit function | null null
onRowDetailInit function | null null
onRowDetailUpdated function | null null
onRowInserted function | null null
onRowRemoved function | null null
onRowUpdate function | null null
onRowUpdated function | null null
onColumnInit function | null null
onColumnInserted function | null null
onColumnRemoved function | null null
onColumnUpdated function | null null
onCommand function | null null
paging object Please expand entry to see sub properties
pager object Please expand entry to see sub properties
rowDetail object Please expand entry to see sub properties
scrolling string "physical"
columnHeader object Please expand entry to see sub properties
groupHeader object Please expand entry to see sub properties
header object Please expand entry to see sub properties
footer object Please expand entry to see sub properties
rows Smart.Grid.Row[] []
selection object Please expand entry to see sub properties
sorting object Please expand entry to see sub properties

Events

beginEdit Event
change Event
columnClick Event
columnDoubleClick Event
columnResize Event
rowExpand Event
rowCollapse Event
rowClick Event
rowDoubleClick Event
rowResize Event
cellClick Event
cellDoubleClick Event
endEdit Event
filter Event
resize Event
rowTap Event
cellTap Event
page Event
sort Event
scrollBottomReached Event
scrollTopReached Event

Methods

Name Type Return Type
addNewRow(position?: string): boolean Method boolean
addUnboundRow(count: number, position?: string): boolean Method boolean
addFilter(dataField: string, filter: string, refreshFilters?: boolean): void Method void
autoSizeRows(): void Method void
autoSizeColumns(): void Method void
beginUpdate(): void Method void
beginEdit(rowId: string, dataField?: string): boolean Method boolean
clearFilter(): void Method void
clearSelection(): void Method void
cancelEdit(): void Method void
checkRow(rowId: string): void Method void
checkAllRows(): void Method void
clearRows(): void Method void
closeMenu(): void Method void
collapseRow(rowId: string): void Method void
collapseAllRows(): void Method void
createChart(type: string, dataSource?: []): void Method void
deleteRow(rowId: string): void Method void
ensureVisible(rowId: string, dataField?: string): boolean Method boolean
endEdit(): void Method void
endUpdate(refresh?: boolean): void Method void
expandRow(rowId: string): void Method void
expandAllRows(): void Method void
exportData(Data format: string): void Method void
getSortedColumns(): {[dataField: string]: { sortOrder: string, sortIndex: number }} Method {[dataField: string]: { sortOrder: string, sortIndex: number }}
getSelection(): { rows: Smart.Grid.Row[], columns: Smart.Grid.Column[], cells: Smart.Grid.Cell[], focused: {id: string, dataField: string} } Method { rows: Smart.Grid.Row[], columns: Smart.Grid.Column[], cells: Smart.Grid.Cell[], focused: {id: string, dataField: string} }
getFilteredColumns(): {[dataField: string]: Smart.Grid.Column} Method {[dataField: string]: Smart.Grid.Column}
getVisibleRows(): Smart.Grid.Row[] Method Smart.Grid.Row[]
getViewRows(): Smart.Grid.Row[] Method Smart.Grid.Row[]
getBatchEditChanges(): { updated: [{ id: string, dataField: string, oldValue: Object, newValue: Object }], deleted: [{id: string, data: Object}], added: [{id: string, data: Object}] } Method { updated: [{ id: string, dataField: string, oldValue: Object, newValue: Object }], deleted: [{id: string, data: Object}], added: [{id: string, data: Object}] }
hasMenu(): boolean Method boolean
hideDetail(rowId: string): void Method void
openMenu(dataField: string): void Method void
print(): void Method void
render(): void Method void
refresh(): void Method void
refreshView(): void Method void
removeFilter(dataField: string, refreshFilters?: boolean): void Method void
revertBatchEdit(): void Method void
saveBatchEdit(): void Method void
select(rowId: string, dataField?: string): void Method void
selectRange(rowId: string, dataField?: string, endRowId: string, endDataField?: string): void Method void
showDetail(rowId: string): void Method void
unselect(rowId: string, dataField?: string): void Method void
uncheckRow(rowId: string): void Method void
uncheckAllRows(): void Method void
toggleRow(rowId: string): void Method void