Version 1
IGroupingEventArgs GrapeCity DataViewsJS Interface

IGroupingEventArgs Interface

Defines arguments of the event that occurs when the user updates groups with UI actions

Heirarchy

  • IGroupingEventArgs

Properties

action

action: "insert" | "remove" | "reorder"

Indicates the group action

cancel

cancel: boolean

If it is set to true, the action is canceled

Optional newGroupDescriptor

newGroupDescriptor: IGroupDescriptor

The new IGroupDescriptor to be inserted

Optional newIndex

newIndex: number

If the action is 'insert', the index of the new group descriptor is inserted before. If the action is 'reorder', the new index of the reordered groupDescriptor in the old collection is inserted before

Optional oldIndex

oldIndex: number

If the action is 'remove', the groupDescriptor index is removed. If the action is 'reorder', the old index of the reorder groupDescriptor is used