RealGrid2 API
Interface
GridFooterCollection

GridFooterCollection

Collection model for grid footer area

Signature:

export interface GridFooterCollection

Remarks

Displays the footer of the grid or creates and manages multiple footers.

This is an object returned from GridBase.footers.

Example

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

Properties

PropertyTypeDescription
countnumberReturns the number of currently set footers.
itemsGridFooter[]Set gridFooter.
visiblebooleanDisplay status
visibleCountnumberReturns the number of footers whose visibility is true among the currently set footers.

Methods

MethodTypeDescription
get(index)get?(index: number): GridFooter;Returns the footer of the corresponding index.
getVisible(index)getVisible?(index: number): GridFooter;Retrieves the footer corresponding to the display order.

Properties Desc

count

Returns the number of currently set footers.

Type - number

items

Set gridFooter.

Type - GridFooter[]

visible

Display or not

Type - boolean

visibleCount

Returns the number of footers whose visibility is true among the currently set footers.

Type - number

Method Desc

get

Returns the footer of the corresponding index.

[Parameter List]

index - number

index of footer

[Return Value] - GridFooter

Remarks:

Returns GridFooter.

getVisible

Retrieves the footer corresponding to the display order.

[Parameter List]

index - number

The display order starts from 0.

[Return Value] - GridFooter

Remarks:

Returns GridFooter.

GridFooterGridHeader