Box
API
Row
Map
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery DataGrid - grouping.texts

Defines the texts of grouping-related visual elements.

Type:

Object

Use the properties of this object to localize or customize grouping-related elements. For example, the groupByThisColumn, ungroup and ungroupAll properties customize items of the context menu. These items appear in the menu only if the grouping.contextMenuEnabled property is set to true.

Also, this object contains the groupContinuesMessage and groupContinuedMessage properties that specify the text added to group rows when the group is parted.

groupByThisColumn

Specifies the text of the context menu item that groups data by a specific column.

Type:

String

Default Value: 'Group by This Column'

groupContinuedMessage

Specifies the message displayed in a group row when the corresponding group is continued from the previous page.

Type:

String

Default Value: 'Continued from the previous page'

When grid records are grouped, the groups might be parted due to the fact that their sizes don't fit the page size. In that case, the group row corresponding to a parted group is supplemented with a message notifying the user that the group is started on one of the previous pages. To specify the text of this message, use the groupContinuedMessage property.

Additionally, you can specify the message displayed in a group row when the corresponding group continues on the next page. Use the groupContinuesMessage property for this purpose.

NOTE
If a group simultaneously continues on the next page and is continued from the previous page, the texts specified by the groupContinuedMessage and groupContinuesMessage properties will be concatenated.

groupContinuesMessage

Specifies the message displayed in a group row when the corresponding group continues on the next page.

Type:

String

Default Value: 'Continues on the next page'

When grid records are grouped, the groups might be parted due to the fact that their sizes do not match the page size. In that case, the group row corresponding to a parted group is supplemented with a message notifying the user that the group does not end on the current page. To specify the text of this message, use the groupContinuesMessage property.

Additionally, you can specify the message displayed in a group row when the corresponding group is continued from the previous page. Use the groupContinuedMessage property for this purpose.

NOTE
If a group simultaneously continues on the next page and is continued from the previous page, the texts specified by the groupContinuedMessage and groupContinuesMessage properties will be concatenated.

ungroup

Specifies the text of the context menu item that clears grouping settings of a specific column.

Type:

String

Default Value: 'Ungroup'

ungroupAll

Specifies the text of the context menu item that clears grouping settings of all columns.

Type:

String

Default Value: 'Ungroup All'