QuanticDateFacet

This is for:

Developer System Administrator
Note

This component was introduced in version 1.6.1.

The QuanticDateFacet component displays facet values as date ranges.

Example

<c-quantic-date-facet engine-id={engineId} facet-id="myfacet" field="date" label="Date" number-of-values="5" formatting-function={formattingFunction} is-collapsed></c-quantic-date-facet>

Properties

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

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

formattingFunction (required)

formatting-function

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

function

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. Example usage:

  • To show a facet when any value is selected in the parent facet:<pre class="prettyprint source lang-javascript">`{ parentFacetId: 'filetype' } `</pre>

  • To show a facet only when a specific value is selected:<pre class="prettyprint source lang-javascript">`{ parentFacetId: 'filetype', expectedValue: 'txt' } `</pre>

DependsOn

isCollapsed

is-collapsed

Whether the facet is collapsed.

boolean

false

XML configuration file elements

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

Metadata Value

apiVersion

53.0

isExposed

false