Skip to main content

beforeGroup

fires before grouping of data has started

Usage​

interface IGroupConfig {
    showMissed?: boolean | string; // true by default
    field?: string; // "group" by default
}

beforeGroup: (config: IGroupConfig) => boolean | void;

Parameters​

  • config - the configuration object used for data grouping
    • showMissed - (optional) specifies whether the elements that don't have the field for grouping should be displayed, true by default
      • if set to true, the rows that don't have values for grouping are rendered row by row after all the data
      • if a string value is set, e.g. "Missed", the rows that don't have values for grouping are rendered as a separate group the name of which will have the specified string value. This group will be rendered as the last one
      • if set to false, the rows that don't suit the grouping criteria won't be rendered
    • field - (optional) the group field name, "group" by default

Returns:

Return false to prevent data grouping; otherwise, true.

Example

component.data.events.on("beforeGroup", (config) => {
    console.log("Grouping starts:", config);
    return true; // continue grouping
});

Change log:

added in v9.0