CollectionViewGroup Class
Heirarchy
- CollectionViewGroup
Constructors
Properties
Methods
Constructors
constructor
- new
Collection View Group(groupDescription: GroupDescription, name: string, level: number, isBottomLevel: boolean): CollectionViewGroup
-
Initializes a new instance of the CollectionViewGroup class.
Parameters
-
groupDescription: GroupDescription
GroupDescription that owns the new group.
-
name: string
Name of the new group.
-
level: number
Level of the new group.
-
isBottomLevel: boolean
Whether this group has any subgroups.
Returns CollectionViewGroup
-
Properties
groupDescription
groupDescription: GroupDescription
Gets the GroupDescription that owns this group.
groups
Gets an array containing this group's subgroups.
isBottomLevel
isBottomLevel: boolean
Gets a value that indicates whether this group has any subgroups.
items
items: any[]
Gets an array containing the items included in this group (including all subgroups).
level
level: number
Gets the level of this group.
name
name: string
Gets the name of this group.
Methods
getAggregate
- get
Aggregate(aggType: Aggregate, binding: string, view?: ICollectionView, sheet?: any): any
-
Calculates an aggregate value for the items in this group.
Parameters
-
aggType: Aggregate
Type of aggregate to calculate.
-
binding: string
Property to aggregate on.
-
Optional view: ICollectionView
CollectionView that owns this group.
-
Optional sheet: any
Returns any
The aggregate value.
-
Represents a group created by a CollectionView object based on its CollectionView.groupDescriptions property.