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


## GridColumn

Column Information Model

**Signature:**

```typescript
export interface GridColumn
```

## Remarks

In practice, GridColumn's descendant classes [DataColumn](/refs/Interface/DataColumn) or [SeriesColumn](/refs/Interface/SeriesColumn) are used.

\[subclass\]

[ValueColumn](/refs/Interface/ValueColumn)

- [DataColumn](/refs/Interface/DataColumn)

- [SeriesColumn](/refs/Interface/SeriesColumn)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [checked](/refs/Interface/GridColumn#checked) | boolean | Checked or not |
| [displayIndex](/refs/Interface/GridColumn#displayindex) | number | Indicates the display order of the column within the column group to which the column belongs. |
| [displayText](/refs/Interface/GridColumn#displaytext) | string | Display text of the column within the column group to which the column belongs |
| [displayWidth](/refs/Interface/GridColumn#displaywidth) | number | Display width of the column within the column group to which the column belongs |
| [fillWidth](/refs/Interface/GridColumn#fillwidth) | number | Width within column group |
| [footer](/refs/Interface/GridColumn#footer) | [ColumnFooter](/refs/Interface/ColumnFooter) | Column footer (first item if there are multiple) |
| [footers](/refs/Interface/GridColumn#footers) | [ColumnFooterCollection](/refs/Interface/ColumnFooterCollection) | Column Footer Collection Object |
| [groupFooter](/refs/Interface/GridColumn#groupfooter) | [ColumnSummary](/refs/Interface/ColumnSummary) | Group footer (first item if multiple) |
| [groupFooters](/refs/Interface/GridColumn#groupfooters) | [ColumnFooterCollection](/refs/Interface/ColumnFooterCollection) | Group footer collection object. |
| [header](/refs/Interface/GridColumn#header) | [ColumnHeader](/refs/Interface/ColumnHeader) | column header |
| [headerSummaries](/refs/Interface/GridColumn#headersummaries) | [ColumnHeaderSummaryCollection](/refs/Interface/ColumnHeaderSummaryCollection) | Header Summary collection object. |
| [headerSummary](/refs/Interface/GridColumn#headersummary) | [ColumnHeaderSummary](/refs/Interface/ColumnHeaderSummary) | Header Summary (first item if multiple) |
| [indeterminate](/refs/Interface/GridColumn#indeterminate) | boolean | Whether indeterminate status |
| [index](/refs/Interface/GridColumn#index) | number | order |
| [layout](/refs/Interface/GridColumn#layout) | [CellLayoutColumnItem](/refs/Interface/CellLayoutColumnItem) | Layout Item Object |
| [movable](/refs/Interface/GridColumn#movable) | boolean | Whether columns can be moved |
| [name](/refs/Interface/GridColumn#name) | string | column name |
| [resizable](/refs/Interface/GridColumn#resizable) | boolean | Whether column width is adjustable |
| [visible](/refs/Interface/GridColumn#visible) | boolean | Column visibility |
| [width](/refs/Interface/GridColumn#width) | number | column width |

## Methods

| Method | Type | Description |
| --- | --- | --- |
| [getFooter(index)](/refs/Interface/GridColumn#getfooter) | getFooter?(index: number): [ColumnFooter](/refs/Interface/ColumnFooter){/* */}; | Gets the column footer. |
| [getHeaderSummary(index)](/refs/Interface/GridColumn#getheadersummary) | getHeaderSummary?(index: number): [ColumnHeaderSummary](/refs/Interface/ColumnHeaderSummary){/* */}; | Get the column headerSummary. |
| [setFooters(footers)](/refs/Interface/GridColumn#setfooters) | setFooters?(footers: any\[\]): void; | Column footer settings |
| [setGroupFooters(footers)](/refs/Interface/GridColumn#setgroupfooters) | setGroupFooters?(footers: [ColumnSummary](/refs/Interface/ColumnSummary){/* */}\[\]): void; | Column groupFooter settings |
| [setHeaderSummaries(summaries)](/refs/Interface/GridColumn#setheadersummaries) | setHeaderSummaries?(summaries: any\[\]): void; | Set column HeaderSummary |

## Properties Desc

### checked

Checked or not

`Type` - boolean

**Remarks:**

If [column.header.checkLocation](/refs/Interface/ColumnHeader#checklocation){/* */} is not `none`{/* */}, the check status is displayed on the screen.

<hr/>

### displayIndex

Indicates the display order of the column within the column group to which the column belongs.

`Type` - number

**Remarks:**

This is a read-only value.

<hr/>

### displayText

The display text of the column within the column group to which the column belongs.

`Type` - string

**Remarks:**

This is a read-only value.

<hr/>

### displayWidth

Display width of the column within the column group to which the column belongs

`Type` - number

**Remarks:**

This is a read-only value.

<hr/>

### fillWidth

Width within column group

`Type` - number

**Remarks:**

It is specified as a ratio.

<hr/>

### footer

Column footer (first item if there are multiple)

`Type` - [ColumnFooter](/refs/Interface/ColumnFooter)

<hr/>

### footers

Column Footer Collection Object

`Type` - [ColumnFooterCollection](/refs/Interface/ColumnFooterCollection)

<hr/>

### groupFooter

Group footer (first item if multiple)

`Type` - [ColumnSummary](/refs/Interface/ColumnSummary)

<hr/>

### groupFooters

Group footer collection object.

`Type` - [ColumnFooterCollection](/refs/Interface/ColumnFooterCollection)

<hr/>

### header

column header

`Type` - [ColumnHeader](/refs/Interface/ColumnHeader)

<hr/>

### headerSummaries

Header Summary collection object.

`Type` - [ColumnHeaderSummaryCollection](/refs/Interface/ColumnHeaderSummaryCollection)

<hr/>

### headerSummary

Header Summary (first item if multiple)

`Type` - [ColumnHeaderSummary](/refs/Interface/ColumnHeaderSummary)

<hr/>

<hr/> 

### indeterminate 

Indeterminate status 

`Type` - boolean

### index

order

`Type` - number

<hr/>

### layout

Layout item object

`Type` - [CellLayoutColumnItem](/refs/Interface/CellLayoutColumnItem)

**Remarks:**

You can set it by accessing its properties.

**Example:**


```js
column.layout.spanCallback = function (grid, layout, itemIndex) {
 var value = grid.getValue(itemIndex, layout.column.name);
 if (value) {
 return value[0] === "B" ? 2: value[0] === "F" ? 3:1;
 }
};
```

<hr/>

### movable

Is it possible to move the column?

`Type` - boolean

<hr/>

### name

column name

`Type` - string

<hr/>

### resizable

Is column width adjustable?

`Type` - boolean

<hr/>

### visible

Column visibility

`Type` - boolean

**Remarks:**

If it is `false`, it is not displayed even if the visibility of the connected layout is `true`. In other words, both layout and column visibility must be `true`.

<hr/>

### width

column width

`Type` - number

<hr/>

## Method Desc

### getFooter

Gets the column footer.

**\[Parameter List\]**

`index` - number

turn

**\[Return Value\] -** [ColumnFooter](/refs/Interface/ColumnFooter)

<hr/>

### getHeaderSummary

Get the column headerSummary.

**\[Parameter List\]**

`index` - number

turn

**\[Return Value\] -** [ColumnHeaderSummary](/refs/Interface/ColumnHeaderSummary)

<hr/>

### setFooters

Column footer settings

**\[Parameter List\]**

`footers` - any\[\]

Footer setting information arrangement

**\[Return Value\] -** void

**Remarks:**

If the footer has multiple lines, set the style and expression.

**Example:**


```js
gridView.setFooters([{styleName:"footer-style1"}, {styleName:"footer-style2"}]);
gridView.columnByName("column").setFooters([
 {styleName:"footer-cell-style1", expression: "sum"},
 {styleName:"footer-cell-style2", expression: "max"}
]);
```

<hr/>

### setGroupFooters

Column groupFooter settings

**\[Parameter List\]**

`footers` - [ColumnSummary](/refs/Interface/ColumnSummary){/* */}\[\]

footer configuration information arrangement

**\[Return Value\] -** void

**Remarks:**

If groupFooter has multiple lines, set the style and expression.

**Example:**


```js
gridView.rowGroup.setFooters([{styleName:"footer-style1"}, {styleName:"footer-style2"}]);
gridView.columnByName("column").setGroupFooters([
 {styleName:"footer-cell-style1", expression: "sum"},
 {styleName:"footer-cell-style2", expression: "max"}
]);
```

<hr/>

### setHeaderSummaries

Column HeaderSummary settings

**\[Parameter List\]**

`summaries` - any\[\]

headerSummary configuration information array

**\[Return Value\] -** void

**Remarks:**

If headerSummary has multiple lines, set the style and expression.

**Example:**


```js
gridView.setHeaderSummaries([{styleName:"summary-style1"}, {styleName:"summary-style2"}]);
gridView.columnByName("column").setHeaderSummaries([
 {styleName:"summary-cell-style1", expression: "sum"},
 {styleName:"summary-cell-style2", expression: "max"}
]);
```

<hr/>