{/* Do not edit this file. It is automatically generated by API Documenter. */}


## GridHeader

Setting model for header area

**Signature:**

```typescript
export interface GridHeader
```

## Remarks

When using [GridBase.setHeader()](/refs/Class/GridBase#setheader), you only need to enter the necessary information.

## Example


```js
gridView.setHeader({sortable = false});
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [checkHeight](/refs/Interface/GridHeader#checkheight) | number | checkbox height in header |
| [checkWidth](/refs/Interface/GridHeader#checkwidth) | number | Checkbox width in header |
| [exportStyleName](/refs/Interface/GridHeader#exportstylename) | string | Style name to be applied when exported to Excel |
| [filterHeight](/refs/Interface/GridHeader#filterheight) | number | filter in header [handle](/refs/realgrid#handlevisibility) height |
| [filterWidth](/refs/Interface/GridHeader#filterwidth) | number | filter in header [handle](/refs/realgrid#handlevisibility) width |
| [height](/refs/Interface/GridHeader#height) | number | Height of header |
| [heights](/refs/Interface/GridHeader#heights) | number\[\] | Height of each line when the header has multiple lines |
| [itemGap](/refs/Interface/GridHeader#itemgap) | number | Spacing between text and checkbox or image |
| [itemOffset](/refs/Interface/GridHeader#itemoffset) | number | Spacing between header border and checkbox or image |
| [maxRowHeight](/refs/Interface/GridHeader#maxrowheight) | number | Maximum height of the header row |
| [minHeight](/refs/Interface/GridHeader#minheight) | number | Minimum height of header |
| [minRowHeight](/refs/Interface/GridHeader#minrowheight) | number | Minimum height of header row |
| [popupHeight](/refs/Interface/GridHeader#popupheight) | number | Popup menu in header [handle](/refs/realgrid#handlevisibility) height |
| [popupWidth](/refs/Interface/GridHeader#popupwidth) | number | Popup menu in header [handle](/refs/realgrid#handlevisibility) width |
| [resizable](/refs/Interface/GridHeader#resizable) | boolean | Height can be changed |
| [showPopupMenu](/refs/Interface/GridHeader#showpopupmenu) | [HandleVisibility](/refs/realgrid#handlevisibility) | If popupMenuName is set in the header, the popup menu handle is displayed. |
| [showSelection](/refs/Interface/GridHeader#showselection) | boolean | Selection Visibility |
| [showTooltip](/refs/Interface/GridHeader#showtooltip) | boolean | Tooltip visibility |
| [sortHeight](/refs/Interface/GridHeader#sortHeight) | number | Alignment of header [handle](/refs/realgrid#handlevisibility) height |
| [sortWidth](/refs/Interface/GridHeader#sortwidth) | number | alignment of header [handle](/refs/realgrid#handlevisibility) width |
| [styleName](/refs/Interface/GridHeader#stylename) | string | style name |
| [tooltipEllipsisOnly](/refs/Interface/GridHeader#tooltipellipsisonly) | boolean | Whether to display tooltips for cells in ellipsis state |
| [visible](/refs/Interface/GridHeader#visible) | boolean | Visibility |

## Properties Desc

### checkHeight

Checkbox height in header

`Type` - number

<hr/>

### checkWidth

Checkbox width in header

`Type` - number

<hr/>

### exportStyleName

Style name to be applied when exported to Excel

`Type` - string

<hr/>

### filterHeight

Filter [handle](/refs/realgrid#handlevisibility) height in header

`Type` - number

<hr/>

### filterWidth

Filter [handle](/refs/realgrid#handlevisibility) width in header

`Type` - number

<hr/>

### 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 //deprecated

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.

<hr/>

### heights

Height of each line when header has multiple lines

`Type` - number\[\]

**Remarks:**

Specifies the height of each table row.

**Example:**


```js
gridView.header.heights = [50, 30, 30]
```

<hr/>

### itemGap

Spacing between text and checkbox or image

`Type` - number

<hr/>

### itemOffset

Spacing between header border and checkbox or image

`Type` - number

<hr/>

### maxRowHeight

Maximum height of the header row

`Type` - number

<hr/>

### minHeight

Minimum height of header

`Type` - number

<hr/>

### minRowHeight

Minimum height of header row

`Type` - number

<hr/>

### popupHeight

Popup menu in header [handle](/refs/realgrid#handlevisibility) height

`Type` - number

<hr/>

### popupWidth

Popup menu in header [handle](/refs/realgrid#handlevisibility) width

`Type` - number

<hr/>

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

<hr/>

### showPopupMenu

If popupMenuName is set in the header, the popup menu handle is displayed.

`Type` - [HandleVisibility](/refs/realgrid#handlevisibility)

<hr/>

### showSelection

Selection visibility

`Type` - boolean

**Remarks:**

When `true`, the selection area is specified for related cells according to the data selection area.

<hr/>

### showTooltip

Whether to display tooltips

`Type` - boolean

**Remarks:**

If the value is `undefined`{/* */}, the `tooltip` of the column where [ColumnHeader.showTooltip](/refs/Interface/ColumnHeader#showtooltip){/* */} is `true`{/* */} Only {/* */} is displayed.

<hr/>

### sortHeight

Alignment of header [handle](/refs/realgrid#handlevisibility) height

`Type` - number

<hr/>

### sortWidth

Alignment of header [handle](/refs/realgrid#handlevisibility) width

`Type` - number

<hr/>

### styleName

style name

`Type` - string

<hr/>

### tooltipEllipsisOnly

Whether to show tooltips for cells in ellipsis state

`Type` - boolean

<hr/>

### visible

Visibility

`Type` - boolean

<hr/>