Headersummarycollection

HeaderSummaryCollection

Collection model object for the Header summary area

Signature:

export interface HeaderSummaryCollection

Remarks

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

This is an object returned from GridBase.headerSummaries.

Example

//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	number	Returns the number of currently set headerSummary.
get	(index: number) => HeaderSummary	Returns the headerSummary of the corresponding index.
getVisible	(index: number) => HeaderSummary	Retrieves the headerSummary corresponding to the order in which it is displayed.
items	HeaderSummary[]	Set headerSummary.
visible	boolean	Visibility
visibleCount	number	Returns the number of headerSummaries whose visibility is `true` among the currently set headerSummaries.