Class TreeGridAggregateColumn
Inheritance
Namespace: Syncfusion.EJ2.TreeGrid
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridAggregateColumn : EJTagHelperConstructors
TreeGridAggregateColumn()
Declaration
public TreeGridAggregateColumn()Properties
ColumnName
Specifies the column name to display the aggregate value. If not defined, the field name is used by default.
Declaration
public string ColumnName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CustomAggregate
Defines a custom function to calculate the aggregate value. The type must be set to custom.
Use the custom value as ${custom} in templates.
Total aggregation: The custom function is called with the entire dataset and the current AggregateColumn object.
Group aggregation: It is called with the current group details and the AggregateColumn object.
Declaration
public object CustomAggregate { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Field
Specifies the column name on which to perform the aggregation.
Declaration
public string Field { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
FooterTemplate
Defines a template for the footer cell of the aggregate column.
Use the aggregate type names within the template to access aggregate values.
Declaration
public string FooterTemplate { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Format
Specifies the format to be applied to the calculated aggregate value before display. Supports both standard and custom formats for numbers and dates. Refer to the Syncfusion documentation for number and date formats.
Declaration
public string Format { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Type
Defines the aggregate type(s) for a particular column.
To apply multiple aggregates to a single column, specify the type as an array.
Available aggregate types include:
sum: Calculates the sum of all values in a column.
average: Computes the average of the column values.
max: Finds the maximum value in a column.
min: Finds the minimum value in a column.
count: Counts the number of records.
falsecount: Counts the number of false values.
truecount: Counts the number of true values.
custom: Allows for a custom aggregate function.
Declaration
public string Type { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |