QuanticTimeframeFacet

This is for:

Developer System Administrator

The QuanticTimeframeFacet component displays dates as relative ranges.

Example

<c-quantic-timeframe-facet engine-id={engineId} field="Date" label="Indexed Date" is-collapsed with-date-picker>
  <c-quantic-timeframe period="past" unit="year" amount="10" label="Past decade"></c-quantic-timeframe>
</c-quantic-timeframe-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

withDatePicker

with-date-picker

Whether the facet should display custom range inputs.

boolean

false

isCollapsed

is-collapsed

Whether the facet is collapsed.

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

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

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

XML Configuration File Elements

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

Metadata Value

apiVersion

53.0

isExposed

false

Associated Use Cases

This component is also relevant in the following use case: