FacetRequestOptions interface

The options for facet evaluation

Properties

filter

Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

sortBy

The column name or query expression to sort on. Defaults to count if not present.

sortOrder

The sorting order by the selected column (count by default). Possible values include: 'asc', 'desc'. Default value: 'desc'.

top

The maximum number of facet rows that should be returned.

Property Details

filter

Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

filter?: string

Property Value

string

sortBy

The column name or query expression to sort on. Defaults to count if not present.

sortBy?: string

Property Value

string

sortOrder

The sorting order by the selected column (count by default). Possible values include: 'asc', 'desc'. Default value: 'desc'.

sortOrder?: FacetSortOrder

Property Value

top

The maximum number of facet rows that should be returned.

top?: number

Property Value

number