Trilium Frontend API
    Preparing search index...

    Interface OptionsRowGrouping

    interface OptionsRowGrouping {
        groupBy?: GroupArg;
        groupClosedShowCalcs?: boolean;
        groupHeader?:
            | (
                (
                    value: any,
                    count: number,
                    data: any,
                    group: GroupComponent,
                ) => string
            )
            | ((value: any, count: number, data: any) => string)[];
        groupHeaderPrint?:
            | (
                (
                    value: any,
                    count: number,
                    data: any,
                    group: GroupComponent,
                ) => string
            )
            | ((value: any, count: number, data: any) => string)[];
        groupStartOpen?:
            | boolean
            | boolean[]
            | (
                (
                    value: any,
                    count: number,
                    data: any,
                    group: GroupComponent,
                ) => boolean
            )
            | (
                | boolean
                | (
                    (
                        value: any,
                        count: number,
                        data: any,
                        group: GroupComponent,
                    ) => boolean
                )
            )[];
        groupToggleElement?: false | "header" | "arrow";
        groupUpdateOnCellEdit?: boolean;
        groupValues?: GroupValuesArg;
    }

    Hierarchy (View Summary)

    Index

    Properties

    groupBy?: GroupArg

    String/function to select field to group rows by

    groupClosedShowCalcs?: boolean

    show/hide column calculations when group is closed.

    groupHeader?:
        | (
            (value: any, count: number, data: any, group: GroupComponent) => string
        )
        | ((value: any, count: number, data: any) => string)[]

    You can use the setGroupHeader function to change the header generation function for each group. This function has one argument and takes the same values as passed to the groupHeader setup option.

    groupHeaderPrint?:
        | (
            (value: any, count: number, data: any, group: GroupComponent) => string
        )
        | ((value: any, count: number, data: any) => string)[]

    When printing you may want to apply a different group header from the one usually used in the table. You can now do this using the groupHeaderPrint table option, which takes the same inputs as the standard groupHeader property.

    groupStartOpen?:
        | boolean
        | boolean[]
        | (
            (
                value: any,
                count: number,
                data: any,
                group: GroupComponent,
            ) => boolean
        )
        | (
            | boolean
            | (
                (
                    value: any,
                    count: number,
                    data: any,
                    group: GroupComponent,
                ) => boolean
            )
        )[]

    You can set the default open state of groups using the groupStartOpen property* * This can take one of three possible values:

    true - all groups start open (default value) false - all groups start closed function() - a callback to decide if a group should start open or closed Group Open Function If you want to decide on a group by group basis which should start open or closed then you can pass a function to the groupStartOpen property. This should return true if the group should start open or false if the group should start closed.

    groupToggleElement?: false | "header" | "arrow"

    By default Tabulator allows users to toggle a group open or closed by clicking on the arrow icon in the left of the group header. If you would prefer a different behavior you can use the groupToggleElement option to choose a different option:* * The option can take one of three values: arrow - toggle group on arrow element click header - toggle group on click anywhere on the group header element false - prevent clicking anywhere in the group toggling the group

    groupUpdateOnCellEdit?: boolean
    groupValues?: GroupValuesArg

    By default Tabulator will create groups for rows based on the values contained in the row data. if you want to explicitly define which field values groups should be created for at each level, you can use the groupValues option.

    This option takes an array of value arrays, each item in the first array should be a list of acceptable field values for groups at that level