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


## ColumnHeader

Setting information model for column headers displayed in the grid header area

**Signature:**

```typescript
export interface ColumnHeader extends ColumnObject
```
**Extends:** [ColumnObject](/refs/Interface/ColumnObject)

## Remarks

Used in [GridColumn.header](/refs/Interface/GridColumn#header).

\[Superclass\]

[ColumnObject](/refs/Interface/ColumnObject)

## Example


```js
let col = grid.columnByName('col1')
col.header.checkLocation = 'leftEdge';
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [checkLocation](/refs/Interface/ColumnHeader#checklocation) | [ColumnHeaderItemLocation](/refs/realgrid#columnheaderitemlocation) | Position of checkbox based on header string |
| [excelMemo](/refs/Interface/ColumnHeader#excelmemo) | [CellMemo](/refs/Interface/CellMemo) \| string | Set a memo in the header when exporting to Excel |
| [exportStyleName](/refs/Interface/ColumnHeader#exportstylename) | string | Style name to be applied when exported to Excel |
| [itemGap](/refs/Interface/ColumnHeader#itemgap) | number | Spacing between header string and image or checkbox |
| [itemOffset](/refs/Interface/ColumnHeader#itemoffset) | number | Space between images or checkboxes and cell boundaries |
| [localeText](/refs/Interface/ColumnHeader#localetext) | [ConfigObject](/refs/realgrid#configobject) | Use when using multiple languages. |
| [showTooltip](/refs/Interface/ColumnHeader#showtooltip) | boolean | Tooltip visibility |
| [styleName](/refs/Interface/ColumnHeader#stylename) | string | style class name |
| [templateCallback](/refs/Interface/ColumnHeader#templatecallback) | [RealizeHeaderCallback](/refs/realgrid#realizeheadercallback) | Used to replace and display a specific string in [ColumnObject.template](/refs/Interface/ColumnObject#template){/* */} |
| [templateEvents](/refs/Interface/ColumnHeader#templateevents) | [HeaderTemplateEvent](/refs/Interface/HeaderTemplateEvent) \| [HeaderTemplateEvent](/refs/Interface/HeaderTemplateEvent){/* */}\[\] | Used when setting an event on an element added with [ColumnObject.template](/refs/Interface/ColumnObject#template){/* */} |
| [text](/refs/Interface/ColumnHeader#text) | string | String to be displayed in column header |
| [tooltip](/refs/Interface/ColumnHeader#tooltip) | string | Tooltip message to display |
| [tooltipEllipsisOnly](/refs/Interface/ColumnHeader#tooltipellipsisonly) | boolean | <p>Whether to display tooltips for cells in ellipsis state</p><p>If set to `true`{/* */}, tooltips will be displayed for cells in ellipsis state even if grid.header.tooltipEllipsisOnly is not set.</p> |
| [useCheckImage](/refs/Interface/ColumnHeader#usecheckimage) | boolean | Displays the check box in the header using an image. |

## Properties Desc
### checkLocation

Position of checkbox based on header string

`Type` - [ColumnHeaderItemLocation](/refs/realgrid#columnheaderitemlocation)

<hr/>

### excelMemo

Set a note in the header when exporting to Excel

`Type` - [CellMemo](/refs/Interface/CellMemo) \| string

<hr/>

### exportStyleName

Style name to be applied when exported to Excel

`Type` - string

<hr/>

### itemGap

Spacing between header string and image or checkbox

`Type` - number

<hr/>

### itemOffset

Space between images or checkboxes and cell boundaries

`Type` - number

<hr/>

### localeText

Use when using multiple languages.

`Type` - [ConfigObject](/refs/realgrid#configobject)

**Example:**


```js
gridView.setColumns([
 { fieldName: "fieldName",
 name: "columnName",
 text: "Default",
 localeText: {
 "ko": "Korea",
 "en": "English",
 "en-CA": "English-Canada"
 }
 }
])
```

<hr/>

### showTooltip

Whether to display tooltips

`Type` - boolean

**Remarks:**

If grid.header.showTooltip is `undefined`{/* */}, the tooltip is displayed only in columns where column.header.showTooltip is `true`{/* */}. If grid.header.showTooltip is `true`{/* */}, the tooltip of the column for which column.header.showTooltip is `undefined`{/* */} or `true`{/* */} is displayed. If grid.header.showTooltip is `false`{/* */}, it is not displayed.

<hr/>

### styleName

style class name

`Type` - string

<hr/>

### templateCallback

Used to replace and display a specific string in [ColumnObject.template](/refs/Interface/ColumnObject#template){/* */}

`Type` - [RealizeHeaderCallback](/refs/realgrid#realizeheadercallback)

**Remarks:**

Called if the string is not in `values`{/* */}.

<hr/>

### templateEvents

Used when setting an event to an element added with [ColumnObject.template](/refs/Interface/ColumnObject#template){/* */}

`Type` - [HeaderTemplateEvent](/refs/Interface/HeaderTemplateEvent) \| [HeaderTemplateEvent](/refs/Interface/HeaderTemplateEvent){/* */}\[\]

<hr/>

### text

String to be displayed in column header

`Type` - string

**Remarks:**

If this value is `null`, the data field name connected to the column is displayed. If the data field is not connected, the name of the column is displayed.

<hr/>

### tooltip

Tooltip message to display

`Type` - string

**Remarks:**

If not specified, text is displayed.

<hr/>

### tooltipEllipsisOnly

Whether to display tooltips for cells in ellipsis state

If set to `true`{/* */}, tooltips will be displayed for cells in ellipsis state even if grid.header.tooltipEllipsisOnly is not set.

`Type` - boolean

<hr/>

### useCheckImage

Displays the checkbox in the header using an image.

`Type` - boolean

<hr/>