ColumnSummary
Base classes such as ColumnFooter, ColumnHeaderSummary
Signature:
export interface ColumnSummary extends ColumnObjectExtends: ColumnObject
Remarks
All properties of ColumnSummary can only be called by subclasses that inherit it.
[Superclass]
[subclass]
Events
| Property | Type | Description |
|---|---|---|
| styleCallback | CellStyleCallback | Callbacks for styling |
| valueCallback | ColumnSummaryCallback | Callback used when the user specifies the value displayed on the screen |
Properties
| Property | Type | Description |
|---|---|---|
| booleanFormat | string | Format displayed when the value is of type Boolean |
| datetimeFormat | string | Format displayed when the value is in date format |
| exportStyleName | string | Style name to be applied when exporting to Excel |
| expression | string | expression |
| index | number | |
| numberFormat | string | Format displayed when the value is in numeric format |
| prefix | string | Text to be prepended |
| styleName | string | style class name |
| suffix | string | Text to be added after |
| summaryIndex | number | sequence number of summary |
| templateCallback | RealizeSummaryCallback | Used to replace and display a specific string in ColumnObject.template |
| templateEvents | SummaryTemplateEvent | SummaryTemplateEvent[] | Used when setting an event on an element added with ColumnObject.template |
| text | string | Text displayed on screen |
| textFormat | string | When the value is in text format, Convert Format |
| value | any | Used when getting the result of ColumnSummary.expression or ColumnSummary.valueCallback |
Events Desc
styleCallback
Callbacks for styling
Type - CellStyleCallback
Remarks:
valueCallback
Callback used when the user specifies the value displayed on the screen
Type - ColumnSummaryCallback
Remarks:
If valueCallback is specified, text/expression is ignored.
Properties Desc
booleanFormat
Format displayed when the value is of type Boolean
Type - string
Remarks:
Separated with a colon (:) or semicolon (;), the left side is false, and the right side is true.
Example) 'Nub: Yub'
datetimeFormat
Format displayed when the value is in date format
Type - string
exportStyleName
Style name to be applied when exporting to Excel
Type - string
expression
expression
Type - string
Remarks:
If expression is specified, text is ignored.
index
Warning: This API is now obsolete.
Replaced with summaryIndex
Type - number
numberFormat
Format displayed when the value is in numeric format
Type - string
prefix
text to be added before
Type - string
styleName
style class name
Type - string
suffix
text to be added after
Type - string
summaryIndex
Sequence of summary
Type - number
Remarks:
Sequence number if there are multiple GridColumn.footer or GridColumn.headerSummary.
templateCallback
Used to replace and display a specific string in ColumnObject.template
Type - RealizeSummaryCallback
Remarks:
Called if the string is not in values.
templateEvents
Used when setting an event to an element added with ColumnObject.template
Type - SummaryTemplateEvent | SummaryTemplateEvent[]
text
Text displayed on screen
Type - string
textFormat
Conversion format when the value is in text format
Type - string
Remarks:
Separate with a semicolon (;) and specify the same type as the first parameter of String.prototype.replace on the left and the second parameter on the right. Example) '([A-Za-z]*); Mr\. \$1'
value
Used when getting the result of ColumnSummary.expression or ColumnSummary.valueCallback
Type - any
Remarks:
This is a read-only value.