CollectionViewGroup Class
File
wijmo.js
Module
wijmo.collections

Represents a group created by a CollectionView object based on its groupDescriptions property.

Constructor

constructor

constructor(groupDescription: GroupDescription, name: string, level: number, isBottomLevel: boolean): CollectionViewGroup

Initializes a new instance of the CollectionViewGroup class.

Parameters
Returns
CollectionViewGroup

Properties

groupDescription

Gets the GroupDescription that owns this group.

Type
GroupDescription

groups

Gets an array containing this group's subgroups.

Type
CollectionViewGroup[]

isBottomLevel

Gets a value that indicates whether this group has any subgroups.

Type
boolean

items

Gets an array containing the items included in this group (including all subgroups).

Type
any[]

level

Gets the level of this group.

Type
number

name

Gets the name of this group.

Type
string

Methods

getAggregate

getAggregate(aggType: Aggregate, binding: string, view?: ICollectionView, sheet?: any): void

Calculates an aggregate value for the items in this group.

Parameters
  • aggType: Aggregate

    Type of aggregate to calculate.

  • binding: string

    Property to aggregate on.

  • view: ICollectionView Optional

    CollectionView that owns this group.

  • sheet: any Optional
Returns
void