Customizing DatafariUI - Field Facet

Customizing DatafariUI - Field Facet

Valid from Datafari 5.1 (UI 1.0.0-beta-0.6.0)

checked for UIv2 1.0

This document Refer to the complete configuration file

A field facet displays a facet tied to a given field, with the possibility to filter results based on the field values.

It looks like this:

It is usually used on the left column.

The definition of a field facet looks like the following (Complete configuration file):

{ "type": "FieldFacet", "title": "Extension", "field": "extension", "op": "OR", "minShow": 2, "maxShow": 5, "show": true, "sendToSolr": true },

Parameters

Name

Optional

Default value

Description

Name

Optional

Default value

Description

title

 

 

The title showed at the top of the facet

field

 

 

The solr field associated to the facet

op

 

 

Operator, either “OR” or “AND”. Tells how documents are shown when selecting multiple entries in the facet. If “OR” documents need to have at least one selected element in the concerned field to be selected. If “AND” they need to have all selected elements as part of the concerned field

minShow

 

 

The maximum number of elements that are shown if the facet is not expanded

maxShow

 

 

The maximum number of elements that are shown if the facet is expanded (after clicking show more)

variant

yes

checkbox

Specify the type of FieldFacet to use. It can take these values :

  • checkbox : use classic FieldFacet with a checkbox list

  • autocomplete

show

yes

true

True to display the FieldFacet in the left panel. This option is only an UI effect. The facet is still registered as a field facet in the query.

sendToSolr

yes

false

Set to true to force the query to Solr even if show is false (keep in mind that if show is true, the facet is queried whatever the value of the sendToSolr parameter). Required to be true for the use of field facet tabs (https://datafari.atlassian.net/wiki/x/J4DH8), which is its only purpose for now.