RealGrid2 API
Interface
HeaderSummary

HeaderSummary

Single configuration model in the Header Summary area

Signature:

export interface HeaderSummary extends GridSummaryObject

Extends: GridSummaryObject

Remarks

Grid automatically creates one summary if there is no separate setting, and GridBase.headerSummary returns the first summary.

Change the property using setHeaderSummary() or GridBase.headerSummary Use to specify only the desired properties.

Example

gridView.setHeaderSummary({styleName: 'custom-hsummary-1'});
// or
gridView.headerSummary.styleName = 'custom-hsummary-1';

Events

PropertyTypeDescription
cellStyleCallbackCellStyleCallbackCallback to specify cell style

Properties

PropertyTypeDescription
heightnumberheight
minHeightnumberMinimum Height
styleNamestringstyle class name
summaryIndexnumbersummary Order within the collection
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-summary'
 }
 }
}
headerSummary.cellStyleCallback = f;

Properties Desc

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.

minHeight

minimum height

Type - number

styleName

style class name

Type - string

summaryIndex

Summary Order within the collection

Type - number

value

Stores the value calculated from valueCallback or expression.

Type - any

visible

Visibility

Type - boolean

GroupSummaryHeaderSummaryCollection