QuanticTimeframe (Deprecated)

This is for:

Developer System Administrator
Warning

Quantic v1 has been deprecated. Use the latest version of the Coveo Quantic library.
Note

This component was introduced in version 1.6.1.0.

The QuanticTimeframe component defines a timeframe of a c-quantic-timeframe-facet, and therefore must be defined within a c-quantic-timeframe-facet component. A timeframe is a span of time from now to a specific time in the past, or the future.

Example

<c-quantic-timeframe amount="6" unit="month"></c-quantic-timeframe>

Properties

Property Attribute Description Type Default

period

period

The relative period of time.

'past', 'next'

'past'

unit

unit

The unit used to define:

  • the start date of the timeframe, if the period is past.

  • the end date of the timeframe, if the period is next.

'minute', 'hour', 'day', 'week', 'month', 'quarter', 'year'

'day'

amount

amount

The amount of the unit of time (for example, 10 days, 1 year, etc.).

number

1

label

label

The non-localized label for the timeframe. When defined, it will appear instead of the formatted value.

string

Defaults to the formatted value based on amount, unit, and period.

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: