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.
focusable	boolean	Whether to allow focus to move to the HeaderSummary area
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.

Properties Desc

count

Returns the number of currently set headerSummary.

Type - number

focusable

Whether focus is allowed to move to the HeaderSummary area

Type - boolean

Remarks:

If EditOptions.extendedFocus is true and focusable is true, you can move to the HeaderSummary area using the keyboard or mouse.

get

Returns the headerSummary of the corresponding index.

Type - (index: number) => HeaderSummary

Remarks:

Returns HeaderSummary.

getVisible

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

Type - (index: number) => HeaderSummary

Remarks:

Returns HeaderSummary.

items

Set headerSummary.

Type - HeaderSummary[]

visible

Visibility

Type - boolean

visibleCount

Returns the number of headerSummary whose visible value is true among the currently set headerSummary.

Type - number

HeaderSummary HeaderTemplateEvent