StaticFilter (Deprecated)

This is for:

Developer

In this article

Example implementation
Methods
Attributes
Initialize
Utils
Related types

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

Example implementation

static-filter.fn.tsx

import {StaticFilterOptions, buildStaticFilter} from '@coveo/headless';
import {useEffect, useState, FunctionComponent, useContext} from 'react';
import {AppContext} from '../../context/engine';
 
export const StaticFilter: FunctionComponent<StaticFilterOptions> = (props) => {
  const {engine} = useContext(AppContext);
  const controller = buildStaticFilter(engine!, {options: props});
  const [state, setState] = useState(controller.state);
 
  useEffect(() => controller.subscribe(() => setState(controller.state)), []);
 
  return (
    <ul>
      {state.values.map((value) => {
        return (
          <li key={value.caption}>
            <input
              type="checkbox"
              checked={controller.isValueSelected(value)}
              onChange={() => controller.toggleSelect(value)}
            />
            <span>{value.caption}</span>
          </li>
        );
      })}
    </ul>
  );
};
 
/* Usage
 
const youtubeExpression = buildQueryExpression()
  .addStringField({
    field: 'filetype',
    operator: 'isExactly',
    values: ['youtubevideo'],
  })
  .toQuerySyntax();
 
const dropboxExpression = buildQueryExpression()
  .addStringField({
    field: 'connectortype',
    operator: 'isExactly',
    values: ['DropboxCrawler'],
  })
  .addStringField({
    field: 'objecttype',
    operator: 'isExactly',
    values: ['File'],
  })
  .toQuerySyntax();
 
const youtube = buildStaticFilterValue({
  caption: 'Youtube',
  expression: youtubeExpression,
})
const dropbox = buildStaticFilterValue({
  caption: 'Dropbox',
  expression: dropboxExpression,
})
 
<StaticFilter id="fileType" values={[youtube, dropbox]}/>;
*/

The StaticFilter controller manages a collection of filter values.

Methods

`deselectAll`

Deselects all static filter values.

`isValueSelected`

Checks whether the specified static filter value is selected.

Parameters

value: StaticFilterValue

The static filter value to check.

Returns boolean: Whether the specified static filter value is selected.

`toggleSelect`

Toggles the specified static filter value.

Parameters

value: StaticFilterValue

The static filter value to toggle.

`toggleSingleSelect`

Toggles the specified static filter value, deselecting others.

Parameters

value: StaticFilterValue

The static filter value to toggle.

`subscribe`

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.

Attributes

`state`

A state of the StaticFilter controller.

Properties

hasActiveValues: boolean

true if there’s at least one non-idle value and false otherwise.
id: string

The static filter id.
values: StaticFilterValue[]

The static filter values.

Initialize

`buildStaticFilter`

Creates a Static Filter controller instance.

Parameters

engine: SearchEngine

The headless engine.
props: StaticFilterProps

The configurable Sort controller properties.

Returns StaticFilter

`StaticFilterProps`

The configurable Sort controller properties.

Properties

options: StaticFilterOptions

The options for the StaticFilter controller.

`StaticFilterOptions`

The options for the StaticFilter controller.

Properties

id: string

A unique identifier for the static filter.
values: StaticFilterValue[]

The values the static filter is responsible for managing.

Utils

`buildStaticFilterValue`

Creates a StaticFilterValue.

Parameters

config: StaticFilterValueOptions

The options with which to create a StaticFilterValue.

Returns StaticFilterValue

`buildQueryExpression`

Creates an QueryExpression instance.

Returns QueryExpression: A utility to help build query expressions.

`DateFieldExpression`

Properties

field: string

The field name.
operator: NumericOperator

The operator to use when comparing field and value. Options for the operator are: "isExactly" | "lowerThan" | "lowerThanOrEqual" | "greaterThan" | "greaterThanOrEqual".
value: string

The value to match against the field. For absolute dates, please use form YYYY/MM/DD. For relative dates, please refer to the supported date/time operators.
negate?: boolean

If true, the inverse expression will be created.

`DateRangeFieldExpression`

Properties

field: string

The field name.
from: string

The start of the range. For absolute dates, please use form YYYY/MM/DD. For relative dates, please refer to the supported date/time operators.
to: string

The end of the range. For absolute dates, please use form YYYY/MM/DD. For relative dates, please refer to the supported date/time operators.
negate?: boolean

If true, the inverse expression will be created.

`ExactMatchExpression`

Properties

expression: string

An expression that must appear in its entirety at least once for an item to be returned.

For example, specifying Star Wars will only return items containing the exact phrase.
negate?: boolean

If true, the inverse expression will be created.

`FieldExistsExpression`

Properties

field: string

The field that should be defined on all matching items.
negate?: boolean

If true, the inverse expression will be created.

`KeywordExpression`

Properties

expression: string

An expression containing terms to match. Terms can be in any order, and may also be expanded with stemming.

For example, specifying Star Wars will return items containing either Star or Wars or both.
negate?: boolean

If true, the inverse expression will be created.

`NearExpression`

Properties

otherTerms: OtherTerm[]

The other terms to check against the reference term. See NEAR for an example.
startTerm: string

The reference term.
negate?: boolean

If true, the inverse expression will be created.

`NumericFieldExpression`

Properties

field: string

The field name.
operator: NumericOperator

The operator to use when comparing field and value.
value: number

The value to match against the field.
negate?: boolean

If true, the inverse expression will be created.

`NumericRangeFieldExpression`

Properties

field: string

The field name.
from: number

The start of the range.
to: number

The end of the range.
negate?: boolean

If true, the inverse expression will be created.

`OtherTerm`

Properties

endTerm: string

The term to check against the reference term.
maxKeywordsBetween: number

The maximum number of keywords that should exist between the current term and the reference term.

`QueryExpression`

Properties

addDateField: function

Adds an expression that uses an operator to compare a date field to a value. Returns all of the items for which the expression evaluates to true.

Parameters
- expression: DateFieldExpression
  
  A date field expression.
  
  Returns QueryExpression: The QueryExpression instance.
addDateRangeField: function

Adds an expression that returns all items for which the value of the date field is within the defined range.

Parameters
- expression: DateRangeFieldExpression
  
  A numeric field expression.
  
  Returns QueryExpression: The QueryExpression instance.
addExactMatch: function

Adds an expression that must appear in its entirety, at least once, for an item to be returned.

Parameters
- expression: ExactMatchExpression
  
  An exact match expression.
  
  Returns QueryExpression: The QueryExpression instance.
addExpression: function

Adds a QueryExpression to the current instance.

Parameters
- expression: QueryExpression
  
  The query expression instance to add.
  
  Returns QueryExpression: The QueryExpression instance.
addFieldExists: function

Adds an expression returning all items where the defined field exists.

Parameters
- expression: FieldExistsExpression
  
  A field exists expressions.
  
  Returns QueryExpression: The QueryExpression instance.
addKeyword: function

Adds an expression containing terms to match. Terms can be in any order, and may also be expanded with stemming.

Parameters
- expression: KeywordExpression
  
  A keyword expression.
  
  Returns QueryExpression: The QueryExpression instance.
addNear: function

Adds an expression that returns all of the items in which the specified startTerm appears no more than maxKeywordsBetween from the endTerm, for each element in otherTerms.

Parameters
- expression: NearExpression
  
  A near expression.
  
  Returns QueryExpression: The QueryExpression instance.
addNumericField: function

Adds an expression that uses an operator to compare a numeric field to a value. Returns all of the items for which the expression evaluates to true.

Parameters
- expression: NumericFieldExpression
  
  A numeric field expression.
  
  Returns QueryExpression: The QueryExpression instance.
addNumericRangeField: function

Adds an expression that returns all items for which the value of the numeric field is within the defined range.

Parameters
- expression: NumericRangeFieldExpression
  
  A numeric field expression.
  
  Returns QueryExpression: The QueryExpression instance.
addQueryExtension: function

Adds an expression that invokes a query extension.

Parameters
- expression: QueryExtensionExpression
  
  A query extension expression.
  
  Returns QueryExpression: The QueryExpression instance.
addStringFacetField: function

Adds an expression that uses an operator to compare a string facet field to a value. Returns all of the items for which the expression evaluates to true.

Parameters
- expression: StringFacetFieldExpression
  
  A string facet field expression.
  
  Returns QueryExpression: The QueryExpression instance.
addStringField: function

Adds an expression that uses an operator to compare a string field against certain values. Returns all of the items for which the expression evaluates to true.

Parameters
- expression: StringFieldExpression
  
  A string field expression.
  
  Returns QueryExpression: The QueryExpression instance.
joinUsing: function

Allows specifying a boolean operator join expressions with. Possible values are and and or.

Parameters
- operator: BooleanOperator
  
  The boolean operator to join individual expressions with.
  
  Returns QueryExpression: The QueryExpression instance.
toQuerySyntax: function

Joins all expressions using the configured boolean operator.

Returns string: A string representation of the configured expressions.

`QueryExtensionExpression`

Properties

name: string

The query extension name without the leading $ sign. See Standard query extensions for examples.
parameters: QueryExtensionParameters

The query extension parameters where applicable.

`StaticFilterValue`

Properties

caption: string

A human-readable caption for the expression (for example, Youtube).
expression: string

The query filter expression to apply when the value is selected (for example, @filetype=="youtubevideo").
state: 'idle' | 'selected'

The state of the static filter value.

`StaticFilterValueOptions`

Properties

caption: string

A human-readable caption for the expression (for example, Youtube).
expression: string

The query filter expression to apply when the value is selected (for example, @filetype=="youtubevideo").
state?: 'idle' | 'selected'

The state of the static filter value.

`StringFacetFieldExpression`

Properties

field: string

The field name.
operator: StringFacetFieldOperator

The operator to use when comparing field and value.
value: string

The value to match against the field.
negate?: boolean

If true, the inverse expression will be created.

`StringFieldExpression`

Properties

field: string

The field name.
operator: StringOperator

The operator to use when comparing field and values.
values: string[]

The values to match against the field.
negate?: boolean

If true, the inverse expression will be created.

`Unsubscribe`

Call signatures

(): void