GroupSettingsModel

23 Sep 20252 minutes to read

Interface for a class GroupSettings

Properties

caption string

It allows to set the caption to custom field that will be used to created from custom group fields in the pivot table.

It is applicable only for custom grouping.

customGroups ICustomGroups[]

It allows to set the custom group information to create custom group fields.

It is applicable only for custom grouping.

endingAt string|Date|number

It allows to set the start value/date to group fields to the specified range that to be displayed in the pivot table.

groupInterval DateGroup[]

It allows to specify the date group intervals such as years or quarter or months or days or hours or minutes or seconds to group fields based on that in the pivot table. They options are:

  • Years - Defines group field as ‘Years’ for date type field.
  • Quarters - Defines group field as ‘Quarters’ for date type field.
  • QuarterYear - Defines group field as ‘Quarter Year’ for date type field.
  • Months - Defines group field as ‘Months’ for date type field.
  • Days - Defines group field as ‘Days’ for date type field.
  • Hours - Defines group field as ‘Hours’ for date type field.
  • Minutes - Defines group field as ‘Minutes’ for date type field.
  • Seconds - Defines group field as ‘Seconds’ for date type field.

    It is applicable only for date type grouping.

name string

It allows to set the specific field name to apply group settings.

rangeInterval number

It allows to set the interval range to group field based on the specified range.

It is applicable only of number type grouping.

startingAt string|Date|number

It allows to set the start value/date to group fields from the specified range that to be displayed in the pivot table.

type GroupType

It allows to set the type as date or number or custom to the specified field for apply grouping. The types are:

  • Date - Defines group type as ‘Date’ for date type field
  • Number - Defines group type as ‘Number’ for numeric type field.
  • Custom - Defines group type as ‘Custom’ for custom group field.