Interface DateFacet

The DateFacet controller makes it possible to create a facet with date ranges.

Examples:

interface DateFacet {
    state: DateFacetState;
    deselectAll(): void;
    disable(): void;
    enable(): void;
    isSortedBy(criterion: RangeFacetSortCriterion): boolean;
    isValueSelected(selection: DateFacetValue): boolean;
    sortBy(criterion: RangeFacetSortCriterion): void;
    subscribe(listener: () => void): Unsubscribe;
    toggleExclude(selection: DateFacetValue): void;
    toggleSelect(selection: DateFacetValue): void;
    toggleSingleExclude(selection: DateFacetValue): void;
    toggleSingleSelect(selection: DateFacetValue): void;
}

Hierarchy (View Summary)

Controller
- DateFacet

Index

Documents

relative-date-format

Methods

deselectAll disable enable isSortedBy isValueSelected sortBy subscribe toggleExclude toggleSelect toggleSingleExclude toggleSingleSelect

Properties

Methods

deselectAll

deselectAll(): void
Deselects all facet values.

Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:77

disable

disable(): void
Disables the facet. I.e., prevents it from filtering results.

Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:137

enable

enable(): void
Enables the facet. I.e., undoes the effects of disable.

Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:132

isSortedBy

isSortedBy(criterion: RangeFacetSortCriterion): boolean
Checks whether the facet values are sorted according to the specified criterion.
Parameters
- criterion: RangeFacetSortCriterion
  The criterion to compare.
Returns boolean
Whether the facet values are sorted according to the specified criterion.
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:85

isValueSelected

isValueSelected(selection: DateFacetValue): boolean
Checks whether the specified facet value is selected.
Parameters
- selection: DateFacetValue
  The facet value to check.
Returns boolean
Whether the specified facet value is selected.
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:93

sortBy

sortBy(criterion: RangeFacetSortCriterion): void
Sorts the facet values according to the specified criterion.
Parameters
- criterion: RangeFacetSortCriterion
  The criterion by which to sort values.
Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:99

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

toggleExclude

toggleExclude(selection: DateFacetValue): void
Toggles exclusion of the specified facet value
Parameters
- selection: DateFacetValue
  The facet value to toggle.
Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:113

toggleSelect

toggleSelect(selection: DateFacetValue): void
Toggles the specified facet value.
Parameters
- selection: DateFacetValue
  The facet value to toggle.
Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:106

toggleSingleExclude

toggleSingleExclude(selection: DateFacetValue): void
Toggles exclusion of the specified facet value, deselecting others.
Parameters
- selection: DateFacetValue
  The facet value to toggle.
Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:127

toggleSingleSelect

toggleSingleSelect(selection: DateFacetValue): void
Toggles the specified facet value, deselecting others.
Parameters
- selection: DateFacetValue
  The facet value to toggle.
Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.ts:120

Properties

state

state: DateFacetState

The state of the DateFacet controller.