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


## ColumnSummary

Base classes such as [ColumnFooter](/refs/Interface/ColumnFooter){/* */}, [ColumnHeaderSummary](/refs/Interface/ColumnHeaderSummary)

**Signature:**

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

## Remarks

All properties of ColumnSummary can only be called by subclasses that inherit it.

\[Superclass\]

[ColumnObject](/refs/Interface/ColumnObject)

\[subclass\]

[ColumnFooter](/refs/Interface/ColumnFooter)

[ColumnHeaderSummary](/refs/Interface/ColumnHeaderSummary)

## Events

| Property | Type | Description |
| --- | --- | --- |
| [styleCallback](/refs/Interface/ColumnSummary#stylecallback) | [CellStyleCallback](/refs/realgrid#cellstylecallback) | Callbacks for styling |
| [valueCallback](/refs/Interface/ColumnSummary#valuecallback) | [ColumnSummaryCallback](/refs/realgrid#columnsummarycallback) | Callback used when the user specifies the value displayed on the screen |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [booleanFormat](/refs/Interface/ColumnSummary#booleanformat) | string | Format displayed when the value is of type Boolean |
| [datetimeFormat](/refs/Interface/ColumnSummary#datetimeformat) | string | Format displayed when the value is in date format |
| [excelFormat](/refs/Interface/ColumnSummary#excelformat) | string | Format to be output when exporting to Excel |
| [exportStyleName](/refs/Interface/ColumnSummary#exportstylename) | string | Style name to be applied when exporting to Excel |
| [expression](/refs/Interface/ColumnSummary#expression) | string | expression |
| [index](/refs/Interface/ColumnSummary#index) | number | |
| [numberFormat](/refs/Interface/ColumnSummary#numberformat) | string | Format displayed when the value is in numeric format |
| [prefix](/refs/Interface/ColumnSummary#prefix) | string | Text to be prepended |
| [styleName](/refs/Interface/ColumnSummary#stylename) | string | style class name |
| [suffix](/refs/Interface/ColumnSummary#suffix) | string | Text to be added after |
| [summaryIndex](/refs/Interface/ColumnSummary#summaryindex) | number | sequence number of summary |
| [templateCallback](/refs/Interface/ColumnSummary#templatecallback) | [RealizeSummaryCallback](/refs/realgrid#realizesummarycallback) | Used to replace and display a specific string in [ColumnObject.template](/refs/Interface/ColumnObject#template){/* */} |
| [templateEvents](/refs/Interface/ColumnSummary#templateevents) | [SummaryTemplateEvent](/refs/Interface/SummaryTemplateEvent) \| [SummaryTemplateEvent](/refs/Interface/SummaryTemplateEvent){/* */}\[\] | Used when setting an event on an element added with [ColumnObject.template](/refs/Interface/ColumnObject#template){/* */} |
| [text](/refs/Interface/ColumnSummary#text) | string | Text displayed on screen |
| [textFormat](/refs/Interface/ColumnSummary#textformat) | string | When the value is in text format, Convert Format |
| [value](/refs/Interface/ColumnSummary#value) | any | Used when getting the result of [ColumnSummary.expression](/refs/Interface/ColumnSummary#expression) or [ColumnSummary.valueCallback](/refs/Interface/ColumnSummary#valuecallback){/* */} |
| [zeroText](/refs/Interface/ColumnSummary#zerotext) | string | Sets the string to be printed by replacing the value when the result of expression is the number `0`{/* */}. |

## Events Desc

### styleCallback

Callbacks for styling

`Type` - [CellStyleCallback](/refs/realgrid#cellstylecallback)

**Remarks:**

See [CellStyleCallback](/refs/realgrid#cellstylecallback)

<hr/>

### valueCallback

Callback used when the user specifies the value displayed on the screen

`Type` - [ColumnSummaryCallback](/refs/realgrid#columnsummarycallback)

**Remarks:**

If valueCallback is specified, text/expression is ignored.

<hr/>

## Properties Desc

### booleanFormat

Format displayed when the value is of type Boolean

`Type` - string

**Remarks:**

Separated with a colon (:) or semicolon (;), the left side is `false`{/* */}, and the right side is `true`{/* */}.

Example) `'Nub: Yub'`

<hr/>

### datetimeFormat

Format displayed when the value is in date format

`Type` - string

<hr/>

### excelFormat

Format to be printed when exporting to Excel

`Type` - string

**Remarks:**

Example) `excelFormat: #,##0;[Red]-#,##0;-`

<hr/>

### exportStyleName

Style name to be applied when exporting to Excel

`Type` - string

<hr/>

### expression

expression

`Type` - string

**Remarks:**

If expression is specified, text is ignored.

<hr/>

### index

> Warning: This API is now obsolete.
>
> Replaced with summaryIndex
>

`Type` - number

<hr/>

### numberFormat

Format displayed when the value is in numeric format

`Type` - string

<hr/>

### prefix

text to be added before

`Type` - string

<hr/>

### styleName

style class name

`Type` - string

<hr/>

### suffix

text to be added after

`Type` - string

<hr/>

### summaryIndex

Sequence of summary

`Type` - number

**Remarks:**

Sequence number if there are multiple [GridColumn.footer](/refs/Interface/GridColumn#footer) or [GridColumn.headerSummary](/refs/Interface/GridColumn#headersummary){/* */}.

<hr/>

### templateCallback

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

`Type` - [RealizeSummaryCallback](/refs/realgrid#realizesummarycallback)

**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` - [SummaryTemplateEvent](/refs/Interface/SummaryTemplateEvent) \| [SummaryTemplateEvent](/refs/Interface/SummaryTemplateEvent){/* */}\[\]

<hr/>

### text

Text displayed on screen

`Type` - string

<hr/>

### textFormat

Conversion format when the value is in text format

`Type` - string

**Remarks:**

Separate with a semicolon (;) and specify the same type as the first parameter of String.prototype.replace on the left and the second parameter on the right. Example) `'([A-Za-z]*); Mr\. \$1'`

<hr/>

### value

Used when getting the result of [ColumnSummary.expression](/refs/Interface/ColumnSummary#expression) or [ColumnSummary.valueCallback](/refs/Interface/ColumnSummary#valuecallback){/* */}

`Type` - any

**Remarks:**

This is a read-only value.

<hr/>

### zeroText

Sets the string to be printed by replacing the value when the result of expression is the number `0`{/* */}.

`Type` - string

<hr/>