GridHeader
Setting model for header area
Signature:
export interface GridHeader
Remarks
When using GridBase.setHeader(), you only need to enter the necessary information.
Example
gridView.setHeader({sortable = false});
Properties
Property | Type | Description |
---|---|---|
checkHeight | number | checkbox height in header |
checkWidth | number | Checkbox width in header |
exportStyleName | string | Style name to be applied when exported to Excel |
filterHeight | number | filter in header handle height |
filterWidth | number | filter in header handle width |
height | number | Height of header |
heights | number[] | Height of each line when the header has multiple lines |
itemGap | number | Spacing between text and checkbox or image |
itemOffset | number | Spacing between header border and checkbox or image |
minHeight | number | Minimum height of header |
minRowHeight | number | Minimum height of header row |
popupHeight | number | Popup menu in header handle height |
popupWidth | number | Popup menu in header handle width |
resizable | boolean | Height can be changed |
showPopupMenu | HandleVisibility | If popupMenuName is set in the header, the popup menu handle is displayed. |
showSelection | boolean | Selection Visibility |
showTooltip | boolean | Tooltip visibility |
sortHeight | number | Alignment of header handle height |
sortWidth | number | alignment of header handle width |
styleName | string | style name |
tooltipEllipsisOnly | boolean | Whether to display tooltips for cells in ellipsis state |
visible | boolean | Visibility |
Properties Desc
checkHeight
Checkbox height in header
Type
- number
checkWidth
Checkbox width in header
Type
- number
exportStyleName
Style name to be applied when exported to Excel
Type
- string
filterHeight
Filter handle height in header
Type
- number
filterWidth
Filter handle width in header
Type
- number
height
header height
Type
- number
Remarks:
-
0
: The default style calculates and specifies the height of the tr (which becomes the minimum height of the table row). When the overall header height grows, the height of the element container is corrected so that all rows are displayed. -
Exceeding
0
: Set the total height to the specified height, and set the tr height to the minRowHeight height. If the container height is greater than the sum of the heights of trs, it is distributed. The container height is not corrected. -
Less than
0
: Height calculated by the browser
You can specify the height of each table row in the heights property.
Total height cannot be less than minHeight.
The height of an individual tr cannot be less than minRowHeight.
heights
Height of each line when header has multiple lines
Type
- number[]
Remarks:
Specifies the height of each table row.
Example:
gridView.header.heights = [50, 30, 30]
itemGap
Spacing between text and checkbox or image
Type
- number
itemOffset
Spacing between header border and checkbox or image
Type
- number
minHeight
Minimum height of header
Type
- number
minRowHeight
Minimum height of header row
Type
- number
popupHeight
Popup menu in header handle height
Type
- number
popupWidth
Popup menu in header handle width
Type
- number
resizable
Height can be changed
Type
- boolean
Remarks:
Whether to allow the user to change the height of the header by dragging the mouse over the top of the cell to the left of the header.
showPopupMenu
If popupMenuName is set in the header, the popup menu handle is displayed.
Type
- HandleVisibility
showSelection
Selection visibility
Type
- boolean
Remarks:
When true
, the selection area is specified for related cells according to the data selection area.
showTooltip
Whether to display tooltips
Type
- boolean
Remarks:
If the value is undefined
, the tooltip
of the column where ColumnHeader.showTooltip is true
Only is displayed.
sortHeight
Alignment of header handle height
Type
- number
sortWidth
Alignment of header handle width
Type
- number
styleName
style name
Type
- string
tooltipEllipsisOnly
Whether to show tooltips for cells in ellipsis state
Type
- boolean
visible
Visibility
Type
- boolean