Skip to main content

Glossary: Facet

Properties

NameTypeDescription
ModeFacetModeThe facet mode
AggregationFacetAggregationThe aggregation mode
AggregationFieldstringAggregation field
AggregationTypestringAggregation type (i.e type of decimal, int, float, etc)
NamestringThe aggregation name
DisplayNamestringThe display name
RangesList<string>Facet ranges
MaxResultsint?Maximum results
TermSortModeFacetTermSortModeThe facet term sorting mode
IncludeRemainingTermsboolwhether to include remaining terms

FacetMode (enum)

Members

NameDescription
DefaultDefault facet mode
RangesCreate facets using supplied ranges

FacetAggregation (enum flags)

Members

NameValue
None0
Count1
Max2
Min4
Average8
Sum16

FacetTermSortMode (enum)

Members

NameDescription
ValueAscSort by value ascending
ValueDescSort by value descending
HitsAscSort by hits ascending
HitsDescSort by hits descending