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


## HeaderSummaryCollection

Collection model object for the Header summary area

**Signature:**

```typescript
export interface HeaderSummaryCollection
```

## Remarks

Displays the headerSummary of the grid or creates and manages multiple headerSummaries.

This is an object returned from [GridBase.headerSummaries](/refs/Class/GridBase#headersummaries).

## Example


```js
//object
gridView.setHeaderSummaries({
      visible: true;
      items:[
          {
              styleName: 'custom-headerSummary-1'
          }, {
              styleName: 'custom-headerSummary-2'
          }
      ]
})
// or specified in array format
gridView.setFooters([
      {
          styleName: 'custom-headerSummary-1'
      }, {
          styleName: 'custom-headerSummary-2'
      }
])
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [count](/refs/Interface/HeaderSummaryCollection#count) | number | Returns the number of currently set headerSummary. |
| [get](/refs/Interface/HeaderSummaryCollection#get) | (index: number) =&gt; [HeaderSummary](/refs/Interface/HeaderSummary) | Returns the headerSummary of the corresponding index. |
| [getVisible](/refs/Interface/HeaderSummaryCollection#getvisible) | (index: number) =&gt; [HeaderSummary](/refs/Interface/HeaderSummary) | Retrieves the headerSummary corresponding to the order in which it is displayed. |
| [items](/refs/Interface/HeaderSummaryCollection#items) | [HeaderSummary](/refs/Interface/HeaderSummary){/* */}\[\] | Set headerSummary. |
| [visible](/refs/Interface/HeaderSummaryCollection#visible) | boolean | Visibility |
| [visibleCount](/refs/Interface/HeaderSummaryCollection#visiblecount) | number | Returns the number of headerSummaries whose visibility is `true`{/* */} among the currently set headerSummaries. |

## Properties Desc

### count

Returns the number of currently set headerSummary.

`Type` - number

<hr/>

### get

Returns the headerSummary of the corresponding index.

`Type` - (index: number) =&gt; [HeaderSummary](/refs/Interface/HeaderSummary)

**Remarks:**

Returns [HeaderSummary](/refs/Interface/HeaderSummary){/* */}.

<hr/>

### getVisible

Retrieves the headerSummary corresponding to the order in which it is displayed.

`Type` - (index: number) =&gt; [HeaderSummary](/refs/Interface/HeaderSummary)

**Remarks:**

Returns [HeaderSummary](/refs/Interface/HeaderSummary){/* */}.

<hr/>

### items

Set headerSummary.

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

<hr/>

### visible

Visibility

`Type` - boolean

<hr/>

### visibleCount

Returns the number of headerSummary whose visible value is `true`{/* */} among the currently set headerSummary.

`Type` - number

<hr/>