QuanticCategoryFacet

This is for:

Developer System Administrator

In this article

Examples
Properties
XML configuration file elements
Associated use cases

Note

This component was introduced in version 1.6.1.

A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (e.g., number of occurrences). A QuanticCategoryFacet displays field values in a browsable, hierarchical fashion. Custom captions can be provided by adding caption provider components to the captions named slot. See Create a custom caption provider component for Quantic facets.

Examples

<c-quantic-category-facet engine-id={engineId} facet-id="myfacet" field="geographicalhierarchy" label="Country" base-path="Africa,Togo,Lome" no-filter-by-base-path delimiting-character="/" number-of-values="5" is-collapsed></c-quantic-category-facet>

<c-quantic-category-facet engine-id={engineId} field="geographicalhierarchy">
  <c-quantic-facet-caption slot="captions" value="United States" caption="United States of America"></c-quantic-facet-caption>
  <c-quantic-facet-caption slot="captions" value="usa" caption="USA"></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 `field` value.	`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`
`basePath`	`base-path`	The base path shared by all facet values, separated by commas.	`string`	`''`
`noFilterByBasePath`	`no-filter-by-base-path`	Whether not to use the `basePath` as a filter for the results.	`boolean`	`false`
`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`
`delimitingCharacter`	`delimiting-character`	The character that separates the values of the target multi-value field. If the field is defined as "hierarchical", parts of a path are delimited by `;`. A value is indexed as `parent;child` and `delimitingCharacter` should be set to `;`.	`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 more values are shown.	`number`	`8`
`sortCriteria`	`sort-criteria`	The sort criterion to apply to the returned facet values. Possible values are: `alphanumeric`: Filters are sorted in alphanumerical order. `occurrences`: Filters are sorted in descending order of number of occurrences.	`'alphanumeric', 'occurrences'`	`'occurrences'`
`withSearch`	`with-search`	Whether this facet should contain a search box.	`boolean`	`false`
`dependsOn` (required)	`depends-on`	This property defines the relationship between this facet and a parent facet, indicating the specific parent facet that this facet relies on and the selected value required from that parent facet for this facet to be displayed. When this property is defined, the facet will only display if the specified `parentFacetId` has the `expectedValue` selected. If `expectedValue` is omitted or set to `undefined`, the facet will display as long as any value is selected in the parent facet. <strong>Supported facets:</strong> Dependencies can only be created on a basic or category facet. Dependencies on numeric, timeframe, or date facets are not supported. For example usage and more details, see: https://docs.coveo.com/en/quantic/latest/usage/display-facet-based-on-selection-of-another-facet/	`DependsOn`
`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 field value.

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

basePath

base-path

The base path shared by all facet values, separated by commas.

string

''

noFilterByBasePath

no-filter-by-base-path

Whether not to use the basePath as a filter for the results.

boolean

false

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

delimitingCharacter

delimiting-character

The character that separates the values of the target multi-value field. If the field is defined as "hierarchical", parts of a path are delimited by ;. A value is indexed as parent;child and delimitingCharacter should be set to ;.

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 more values are shown.

number

8

sortCriteria

sort-criteria

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

alphanumeric: Filters are sorted in alphanumerical order.
occurrences: Filters are sorted in descending order of number of occurrences.

'alphanumeric', 'occurrences'

'occurrences'

withSearch

with-search

Whether this facet should contain a search box.

boolean

false

dependsOn (required)

depends-on

This property defines the relationship between this facet and a parent facet, indicating the specific parent facet that this facet relies on and the selected value required from that parent facet for this facet to be displayed. When this property is defined, the facet will only display if the specified parentFacetId has the expectedValue selected. If expectedValue is omitted or set to undefined, the facet will display as long as any value is selected in the parent facet. <strong>Supported facets:</strong> Dependencies can only be created on a basic or category facet. Dependencies on numeric, timeframe, or date facets are not supported. For example usage and more details, see: https://docs.coveo.com/en/quantic/latest/usage/display-facet-based-on-selection-of-another-facet/

DependsOn

isCollapsed

is-collapsed

Whether the facet is collapsed.

boolean

false