Skip to content

FacetGroup

Description🔗

This object represents a search Facet group.

Facet groups allow to organize facets as one visual block (collapsable). Although Facet groups are identified by a name during configuration, that can be used to specify translation through labels, the groupName attribute of a returned facet group object is already translated. Facet groups contain a list of childFacets Facet elements.

Fields🔗

Parameter Name	Type	Description
groupName	string	The translated name of the Facet group.
collapsed	boolean	If true the facet starts out collapsed instead of expanded.
childFacets	list of Facet objects	The facets belonging to this group.

Examples🔗

{
    "collapsed": false,
    "groupName": "My Places",
    "childFacets": [
        {
            "field": "jobtitle",
            "dataType": "TEXT",
            "combinationType": "AND",
            "guiType": "CLOUD",
            "cloudType": "SPHERE",
            "hideFacetIfAllZero": false,
            "hideZeroCountItems": false,
            "defaultCondition": "REQUIRED",
            "hideConditionWidget": false,
            "reverseItemOrder": false,
            "textInputOnFacet": true
        },
        {
            "field": "language",
            "dataType": "TEXT",
            "combinationType": "OR",
            "guiType": "FIXED",
            "hideFacetIfAllZero": false,
            "hideZeroCountItems": false,
            "defaultCondition": "REQUIRED",
            "hideConditionWidget": false,
            "reverseItemOrder": false,
            "items": [
                "Arabic",
                "German",
                "English",
                "French",
                "Dutch",
                "RU",
                "other"
            ],
            "textInputOnFacet": false
        }
    ]
}