Angular UI Components Documentation

Properties

NameTypeDefault
altRows Boolean false
autoRowHeight Boolean true
aggregatesHeight Number 34
autoShowLoadElement Boolean true
checkboxes Boolean false
columnsHeight Number 30
columns Array<Any> []
columnGroups Array<Any> []
columnsResize Boolean false
columnsReorder Boolean false
disabled Boolean false
editable Boolean false
editSettings TreeGridEditSettings { saveOnPageChange: true, saveOnBlur: true, saveOnSelectionChange: true, cancelOnEsc: true, saveOnEnter: true, editSingleCell: false, editOnDoubleClick: true, editOnF2: true }
exportSettings TreeGridExportSettings {columnsHeader: true, hiddenColumns: false, serverURL: null, characterSet: null, collapsedRecords: false, recordsInView: true,fileName: "jqxTreeGrid"}
enableHover Boolean true
enableBrowserSelection Boolean false
filterable Boolean false
filterHeight Number 30
filterMode enum:TreeGridFilterMode "default"
height String | Number null
hierarchicalCheckboxes Boolean false
icons Boolean false
incrementalSearch Boolean true
localization Any default localization strings.
pagerHeight Number 28
pageSize Number 10
pageSizeOptions Array<Number | String> ['5', '10', '20']
pageable Boolean false
pagerPosition enum:TreeGridPagerPosition "bottom"
pagerMode enum:TreeGridPagerMode "default"
pageSizeMode enum:TreeGridPageSizeMode "default"
pagerButtonsCount Number 5
pagerRenderer () => Any null
ready () => Void null
rowDetails Boolean false
rowDetailsRenderer (key: Number, dataRow: Number) => Any null
renderToolbar (toolBar?: Any) => Void null
renderStatusbar (statusBar?: Any) => Void null
rendering () => Void null
rendered () => Void null
rtl Boolean false
source Any null
sortable Boolean false
showAggregates Boolean false
showSubAggregates Boolean false
showToolbar Boolean false
showStatusbar Boolean false
statusBarHeight Number 34
scrollBarSize Number 17
selectionMode enum:TreeGridSelectionMode "multipleRows"
showHeader Boolean true
theme String ''
toolbarHeight Number 34
width String | Number null
virtualModeCreateRecords (expandedRecord?: Any, done?: Any) => Void null
virtualModeRecordCreating (record?: Any) => Any null

Events

bindingComplete Event
cellBeginEdit Event
cellEndEdit Event
cellValueChanged Event
columnResized Event
columnReordered Event
filter Event
pageChanged Event
pageSizeChanged Event
rowClick Event
rowDoubleClick Event
rowSelect Event
rowUnselect Event
rowBeginEdit Event
rowEndEdit Event
rowExpand Event
rowCollapse Event
rowCheck Event
rowUncheck Event
sort Event

Methods

NameReturn TypeArguments
addRow Void rowKey: String,
rowData: Any,
rowPosition: String,
parent: String
addFilter Void dataField: String,
filerGroup: Any
applyFilters Void None
beginUpdate Void None
beginRowEdit Void rowKey: String
beginCellEdit Void rowKey: String,
dataField: String
clearSelection Void None
clearFilters Void None
clear Void None
checkRow Void rowKey: String
collapseRow Void rowKey: String
collapseAll Void None
destroy Void None
deleteRow Void rowKey: Array<String> | String
expandRow Void rowKey: Array<Number | String> | String | Number
expandAll Void None
endUpdate Void None
ensureRowVisible Void rowKey: String
endRowEdit Void rowKey: String,
cancelChanges: Boolean
endCellEdit Void rowKey: String,
dataField: String,
cancelChanges: Boolean
exportData Any exportDataType: Any
focus Void None
getColumnProperty Any dataField: String,
propertyName: String
goToPage Void pageIndex: Number
goToPrevPage Void None
goToNextPage Void None
getSelection Array<Any> None
getKey String row: Any
getRow TreeGridGetRow rowKey: String
getRows Array<TreeGridGetRow> None
getCheckedRows Array<TreeGridGetRow> None
getView Array<TreeGridGetRow> None
getCellValue Any rowKey: String,
dataField: String
hideColumn Void dataField: String
isBindingCompleted Boolean None
lockRow Void rowKey: String | Number | Array<Number | String>
refresh Void None
render Void None
removeFilter Void dataField: String
scrollOffset TreeGridScrollOffset top: Number,
left: Number
setColumnProperty Void dataField: String,
propertyName: String,
propertyValue: Any
showColumn Void dataField: String
selectRow Void rowId: String | Number | Array<Number | String>
setCellValue Void rowId: String,
dataField: String,
cellValue: Any
sortBy Void dataField: String | Number,
sortOrder: String
updating Boolean None
updateBoundData Void None
unselectRow Void rowId: String | Number | Array<Number | String>
uncheckRow Void rowId: String
updateRow Void rowId: Number | String,
data: Any
unlockRow Void rowId: String | Number | Array<Number | String>