RealGrid2 API
Interface
GridFooter

GridFooter

Single setup model for footer area

Signature:

export interface GridFooter extends GridSummaryObject

Extends: GridSummaryObject

Remarks

Grid automatically creates a footer if there is no separate setting, and GridBase.footer returns the first footer.

Change properties using setFooter() or GridBase.footer Use to specify only the desired properties.

Example

gridView.setFooter({styleName: 'custom-footer'});
// or
gridView.footer.styleName = 'custom-footer';

Events

PropertyTypeDescription
cellStyleCallbackCellStyleCallbackCallback to specify cell style

Properties

PropertyTypeDescription
footerIndexnumberOrder within the collection of footers
heightnumberheight
heightsnumber[]Specifies the height of each TR of the footer row consisting of multiple rows as an array.
minHeightnumberMinimum Height
styleNamestringstyle class name
valueanyStores the value calculated from valueCallback or expression.
visiblebooleanVisibility

Events Desc

cellStyleCallback

Callbacks for specifying cell styles

Type - CellStyleCallback

Remarks:

It can be specified as a CSS class name in string form or in the form of ColumnSummaryStyleObject.

Example:

// Apply footer
const f = function (grid, cell) {
 if (cell.value > 10) {
 return {
 styleName: 'custom-footer'
 }
 }
}
footer.cellStyleCallback = f;

Properties Desc

footerIndex

Order within the collection of footers

Type - number


height

height

Type - number

Remarks:

If it is 0, it is automatically calculated and specified. If it is 0 or more, compare it to minHeight and specify a larger value.


heights

Specifies the height of each TR of the footer row consisting of multiple rows as an array.

Type - number[]

Remarks:

If heights is specified, height is ignored.


minHeight

minimum height

Type - number


styleName

style class name

Type - string


value

Stores the value calculated from valueCallback or expression.

Type - any


visible

Visibility

Type - boolean