cpr.controls.gridpart.GridHeaderBand

Hierarchy

Index

Properties
Name Type Description
cellCount Number Returns the number of cells in the band.
Methods
Name Return Type Description
clearFilter Remove all filters in the grid header area.
clearSort Remove all alignment of grid header area.
filter Allows the grid to be filtered in the same way as using the filter in the grid header.
getCellIndices Number[] Returns an array of cellIndex.
getColumn GridHeaderColumn Returns a specific cell.
getColumnByColIndex GridHeaderColumn[] Returns an array of GridColumn that fits this information.
getColumnByName GridDetailColumn[] Returns a GridDetailColumn array bound to a specific columnName.
getControl UIControl Returns controls that exist in a specific cell.
getControlAttr Object If a control exists in a specific cell, it returns the value of that control's specific property.
getFilter { cellIndex: Number, values: String[] }[] Returns filter information applied to the grid header area.
getRowHeight Number Returns the height of each region by row index.
getRowHeights { height: Number }[] Returns the row height of the region.
getSort { cellIndex: Number, asc: Boolean }[] Returns sort information applied to the header area.
getSortCondition String Returns the sort condition applied to the header area.
setRowHeights Change the row height of the area.
sort Causes the grid to be sorted the same as using sort in the grid header.

Properties

cellCount
declaring type GridBand
type Number
readonly
Returns the number of cells in the band.

Methods

clearFilter()
Remove all filters in the grid header area.
clearSort()
Remove all alignment of grid header area.
filter(filterInfos)
Allows the grid to be filtered in the same way as using the filter in the grid header.
The filter style of the grid header is applied.
It is managed separately from the filter of the dataset.

for values ​​not visible by the grid filter You cannot change the filter check through the header filter.
Parameters
name type description
filterInfos { cellIndex: Number, values: any[] }[] filter conditions.
cellIndex: Header cell index.
values: The values ​​to filter.
getCellIndices()
declaring typeGridBand
Returns an array of cellIndex.
return Number[] cellIndex array.
getColumn(cellIndex)
Returns a specific cell.
Parameters
name type description
cellIndex Number Cell index.
return GridHeaderColumn The cell of the input cell index.
getColumnByColIndex(colIndex, colSpan)
Returns an array of GridColumn that fits this information.
Parameters
name type description
colIndex Number The colIndex of the column to find.
colSpan Number The colSpan of the column you are looking for.
return GridHeaderColumn[] A GridColumn array for that information.
getColumnByName(columnName)
deprecatedThis function is only available in 19.01.21 detail.
Returns a GridDetailColumn array bound to a specific columnName.
Parameters
name type description
columnName String The columnName bound to detail.
return GridDetailColumn[] GridDetailColumn array of input columnName.
getControl(cellIndex)
declaring typeGridBand
Returns controls that exist in a specific cell.
Parameters
name type description
cellIndex Number Cell index.
return UIControl The control that exists at the input cell index.
getControlAttr(cellIndex, attrName)
If a control exists in a specific cell, it returns the value of that control's specific property.
Parameters
name type description
cellIndex Number
attrName String Attribute name.
return Object Property Value.
getFilter()
Returns filter information applied to the grid header area.
return { cellIndex: Number, values: String[] }[] filter information.
getRowHeight(rowIndex)
declaring typeGridBand
Returns the height of each region by row index.
The unit is px.
Parameters
name type description
rowIndex Number Row index.
return Number The height of the input row index.
getRowHeights()
declaring typeGridBand
Returns the row height of the region.
Row height at design time.
The unit is px.
return { height: Number }[] Row height array.
getSort()
Returns sort information applied to the header area.
return { cellIndex: Number, asc: Boolean }[] sort information.
getSortCondition()
Returns the sort condition applied to the header area.
return String sort condition.
setRowHeights(heights)
declaring typeGridBand
Change the row height of the area.
Parameters
name type description
heights Number[] Set height array. (ex. [30])
sort(sortInfos)
Causes the grid to be sorted the same as using sort in the grid header.
The alignment style of the grid header is applied.
It is managed separately from the sort of dataset.
Parameters
name type description
sortInfos { cellIndex: Number, asc: Boolean, emptyValueSort?: String }[] sort condition.
cellIndex: Header cell index.
asc: Sort ascending / descending. (true / false) emptyValueSort: Handle empty values ​​when sorting (emptyString, nullLast)