RealGrid2 API
Interface
GridHeader

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

PropertyTypeDescription
checkHeightnumbercheckbox height in header
checkWidthnumberCheckbox width in header
exportStyleNamestringStyle name to be applied when exported to Excel
filterHeightnumberfilter in header handle height
filterWidthnumberfilter in header handle width
heightnumberHeight of header
heightsnumber[]Height of each line when the header has multiple lines
itemGapnumberSpacing between text and checkbox or image
itemOffsetnumberSpacing between header border and checkbox or image
minHeightnumberMinimum height of header
minRowHeightnumberMinimum height of header row
popupHeightnumberPopup menu in header handle height
popupWidthnumberPopup menu in header handle width
resizablebooleanHeight can be changed
showPopupMenuHandleVisibilityIf popupMenuName is set in the header, the popup menu handle is displayed.
showSelectionbooleanSelection Visibility
showTooltipbooleanTooltip visibility
sortHeightnumberAlignment of header handle height
sortWidthnumberalignment of header handle width
styleNamestringstyle name
tooltipEllipsisOnlybooleanWhether to display tooltips for cells in ellipsis state
visiblebooleanVisibility

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:

  1. 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.

  2. 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.

  3. 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