QuanticFacet

This is for:

In this article

Examples
Properties
XML Configuration File Elements
Associated Use Cases

A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences). A QuanticFacet displays a facet of the results for the current query. Custom captions can be provided by adding caption provider components to the captions named slot.

Examples

<c-quantic-facet engine-id={engineId} facet-id="myFacet" field="filetype" label="File Type" number-of-values="5" sort-criteria="occurrences" no-search display-values-as="link" is-collapsed></c-quantic-facet>

<c-quantic-facet engine-id={engineId} field="filetype">
  <c-quantic-facet-caption slot="captions" value="text" caption="Plain text"></c-quantic-facet-caption>
  <c-quantic-facet-caption slot="captions" value="html" caption="Web page"></c-quantic-facet-caption>
</c-quantic-facet>

Properties

Property Attribute Description Type Default

Property	Attribute	Description	Type	Default
`engineId` (required)	`engine-id`	The ID of the engine instance the component registers to.	`string`
`facetId`	`facet-id`	A unique identifier for the facet. Defaults to the facet field.	`string`	Defaults to the `field` value.
`field` (required)	`field`	The field whose values you want to display in the facet.	`string`
`label` (required)	`label`	The non-localized label for the facet. This label is displayed in the facet header.	`string`
`numberOfValues`	`number-of-values`	The number of values to request for this facet. Also determines the number of additional values to request each time this facet is expanded, and the number of values to display when this facet is collapsed.	`number`	`8`
`sortCriteria`	`sort-criteria`	The sort criterion to apply to the returned facet values Possible values are: `score` `alphanumeric` `occurrences`	`'score', 'alphanumeric', 'occurrences'`	`'score'`
`noSearch`	`no-search`	Whether this facet should not contain a search box.	`boolean`	`false`
`displayValuesAs`	`display-values-as`	Whether to display the facet values as checkboxes (multiple selection) or links (single selection). Possible values are 'checkbox', 'link'.	`'checkbox', 'link'`	`'checkbox'`
`noFilterFacetCount`	`no-filter-facet-count`	Whether not to exclude the parents of folded results when estimating the result count for each facet value.	`boolean`	`false`
`injectionDepth`	`injection-depth`	The maximum number of results to scan in the index to ensure that the facet lists all potential facet values. Note: A high injectionDepth may negatively impact the facet request performance. Minimum: `0`	`number`	`1000`
`isCollapsed`	`is-collapsed`	Whether the facet is collapsed.	`boolean`	`false`

engineId (required)

engine-id

The ID of the engine instance the component registers to.

string

facetId

facet-id

A unique identifier for the facet. Defaults to the facet field.

string

Defaults to the field value.

field (required)

field

The field whose values you want to display in the facet.

string

label (required)

label

The non-localized label for the facet. This label is displayed in the facet header.

string

numberOfValues

number-of-values

The number of values to request for this facet. Also determines the number of additional values to request each time this facet is expanded, and the number of values to display when this facet is collapsed.

number

8

sortCriteria

sort-criteria

The sort criterion to apply to the returned facet values Possible values are:

score
alphanumeric
occurrences

'score', 'alphanumeric', 'occurrences'

'score'

noSearch

no-search

Whether this facet should not contain a search box.

boolean

false

displayValuesAs

display-values-as

Whether to display the facet values as checkboxes (multiple selection) or links (single selection). Possible values are 'checkbox', 'link'.

'checkbox', 'link'

'checkbox'

noFilterFacetCount

no-filter-facet-count

Whether not to exclude the parents of folded results when estimating the result count for each facet value.

boolean

false

injectionDepth

injection-depth

The maximum number of results to scan in the index to ensure that the facet lists all potential facet values. Note: A high injectionDepth may negatively impact the facet request performance. Minimum: 0

number

1000

isCollapsed

is-collapsed

Whether the facet is collapsed.

boolean

false