GridGroup Class [PHP]

Summary

Properties Description
Expand Set whether the group is expanded initially.
GroupField Set the data field that will be grouped by.
HeaderText Set the header text of group that shown in group panel.
InfoTemplate Set the information template that will be shown in the header of each group.
Sort Set the sorting direction.
Methods Description
AddInfoField Add the data fields whose values will bed filled in InfoTemplate.

Properties Detail

ExpandTop

bool Expand

Set whether the group is expanded initially.

Default value : true

Show/Hide Code

Supported from version: 2.0.0.0

GroupFieldTop

string GroupField

Set the data field that will be grouped by.

Show/Hide Code

Supported from version: 2.0.0.0

HeaderTextTop

string HeaderText

Set the header text of group that shown in group panel.

Show/Hide Code

Supported from version: 2.0.0.0

InfoTemplateTop

string InfoTemplate

Set the information template that will be shown in the header of each group.

Show/Hide Code

Supported from version: 2.0.0.0

SortTop

bool Sort

Set the sorting direction.

Default value : 1

Allowed values :

  • 1 : Sort in accending order
  • -1 : Sort in descending order

Show/Hide Code

Supported from version: 2.0.0.0

Methods Detail

AddInfoFieldTop

array AddInfoField(string $info_field, [string $aggregate])

Add the data fields whose values will bed filled in InfoTemplate. The value of $aggregate can be "min"|"max"|"first"|"last"|"sum"|"count"|"avg"

Show/Hide Code

Supported from version: 1.0.0.0