Class TreeGridAggregateColumn

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

TreeGridAggregateColumn

Namespace: Syncfusion.EJ2.TreeGrid

Assembly: Syncfusion.EJ2.dll

Syntax

public class TreeGridAggregateColumn : EJTagHelper

Constructors

TreeGridAggregateColumn()

Declaration

public TreeGridAggregateColumn()

Properties

ColumnName

Defines the column name to display the aggregate value. If columnName is not defined, then field name value will be assigned to the columnName property.

Declaration

public string ColumnName { get; set; }

Property Value

Type	Description
System.String	The default value is null

CustomAggregate

Defines a function to calculate custom aggregate value. The type value should be set to custom. To use custom aggregate value in the template, use the key as ${custom}. Total aggregation: The custom function will be called with the whole data and the current AggregateColumn object. Group aggregation: This will be 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

Defines the column name to perform aggregation.

Declaration

public string Field { get; set; }

Property Value

Type	Description
System.String	The default value is null

FooterTemplate

Defines the footer cell template as a string for the aggregate column. The type name should be used to access aggregate values inside the template.

Declaration

public string FooterTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

Format

Format is applied to a calculated value before it is displayed. Gets the format from the user, which can be standard or custom 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 of a particular column. To use multiple aggregates for single column, specify the type as array. Types of aggregate are, sum average max min count falsecount truecount custom

Specify the type value as custom to use custom aggregation.

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String	The default value is null