Advertising sustains the DA. Ads are hidden for members. Join today

Facet

Last updated on
31 May 2023

Facets could use hierarchy, can display number of results per facet, etc.

Properties:

  1. Type (type string). Common for all elements and defines the type of element.
  2. Widget (widget string). This name is taken from Drupal plugin for facet widgets.
  3. Label (label string). The name of the facet.
  4. Settings (settings array ). The facet settings. "facet" property should be used in endpoint request.
  5. Weight (weight integer). The order of the element inside region.

Example object representation:

{
  "id": "f167bf2d-4a97-4891-9cbc-6e06dd59dbfd",
  "type": "facet",
  "weight": "-7",
  "settings": {
    "facet": "date",
    "show_numbers": false,
    "soft_limit": 0,
    "show_reset_link": false,
    "reset_text": "Show all",
    "hide_reset_when_no_selection": false,
    "soft_limit_settings": {
      "show_less_label": "Show less",
      "show_more_label": "Show more"
    },
    "use_hierarchy": true,
    "expand_hierarchy": false,
    "field_alias": "field_date",
    "url_alias": "date",
    "show_title": false
  },
  "label": "Date",
  "widget": "links"
}

Help improve this page

Page status: No known problems

You can: