QuanticNumericFacet

This is for:

Developer System Administrator

In this article

Example
Properties
XML configuration file elements
Associated use cases

Note

This component was introduced in version 1.6.1.

The QuanticNumericFacet component displays facet values as numeric ranges.

Example

<c-quantic-numeric-facet engine-id={engineId} facet-id="myfacet" field="ytlikecount" label="Youtube Likes" numberOfValues="5" sort-criteria="descending" range-algorithm="even" formatting-function={myFormattingFunction} is-collapsed></c-quantic-numeric-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.	`string`	Defaults to the `field` value.
`field` (required)	`field`	Specifies the index field whose values the facet should use.	`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, when there are no manual ranges.	`number`	`8`
`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'`
`sortCriteria`	`sort-criteria`	The sort criterion to apply to the returned facet values. Possible values are: `ascending` `descending`	`'ascending', 'descending'`	`'ascending'`
`rangeAlgorithm`	`range-algorithm`	The algorithm used for generating the ranges of this facet when they aren’t manually defined. The default value of `'even'` generates equally sized facet ranges across all of the results. The value `'equiprobable'` generates facet ranges which vary in size but have a more balanced number of results within each range.	`'even', 'equiprobable'`	`'equiprobable'`
`formattingFunction` (required)	`formatting-function`	The function used to format the date facet value label. The default result format is the following: `[start] - [end]`	`function`
`withInput` (required)	`with-input`	Whether this facet should contain an input allowing users to set custom ranges. Depending on the field, the input can allow either decimal or integer values. `integer` `decimal`	`'integer', 'decimal'`
`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`

engineId (required)

engine-id

The ID of the engine instance the component registers to.

string

facetId

facet-id

A unique identifier for the facet.

string

Defaults to the field value.

field (required)

field

Specifies the index field whose values the facet should use.

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, when there are no manual ranges.

number

8

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'

sortCriteria

sort-criteria

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

ascending
descending

'ascending', 'descending'

'ascending'

rangeAlgorithm

range-algorithm

The algorithm used for generating the ranges of this facet when they aren’t manually defined. The default value of 'even' generates equally sized facet ranges across all of the results. The value 'equiprobable' generates facet ranges which vary in size but have a more balanced number of results within each range.

'even', 'equiprobable'

'equiprobable'

formattingFunction (required)

formatting-function

The function used to format the date facet value label. The default result format is the following: [start] - [end]

function

withInput (required)

with-input

Whether this facet should contain an input allowing users to set custom ranges. Depending on the field, the input can allow either decimal or integer values.

integer
decimal

'integer', 'decimal'

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

XML configuration file elements

The following XML configuration file elements apply (see XML Configuration File Elements).

Metadata Value

Metadata	Value
`apiVersion`	`53.0`
`isExposed`	`false`

apiVersion

53.0

isExposed

false

Associated use cases

This component is also relevant in the following use case:

Insight Panel