GroupChannel

Description

A GroupChannel is an interface that represent a communication channel between the grid and a handler that will answer to requests for a specific group.

Functions

Function

Argument

Type

Description

getCount()

[output]

Promise<number>

The number of data items within the group.

getDistinctValues()

fields

readonly string[]

The list of field(s) targeted.

 

[output]

Promise<Iterable<DistinctValue>>

The list of DistinctValue objects that gives the distinct values available within a group for the specified field(s).

getGroup()

path

GroupPath

The path of the group.

 

[output]

GroupChannel

The group channel that targets the child group.

getItems()

startIndex

number

The index to start at.

 

count

number

The number of items that the grid expects to receive.

If the amount received is inferior to what was expected, the grid will understand that it has reached the end of the group or of the data source.

 

[output]

Promise<Iterable<RawItem>>

The list of RawItem objects (data items) within the group.

getStatResult()?

statDescription

StatDescription

The stat description to apply on the targeted data items.

 

[output]

Promise<StatResult>

The aggregate result.