Skip to main content

Glossary: FacetResults

Properties

NameTypeDescription
ResultsDictionary<string, FacetResult>A list of results for the facet. One entry for each term/range as specified in the facet setup document.
DurationTimeSpanOperation duration

FacetResult

Properties

NameTypeDescription
ValuesList<FacetValue>The facet terms and hits up to a limit of MaxResults items (as specified in the facet setup document), sorted in TermSortMode order (as indicated in the facet setup document).
RemainingTermsCountintThe number of remaining terms outside of those covered by the Values terms.
RemainingHitsintThe number of remaining hits outside of those covered by the Values terms.

FacetValue

Properties

NameTypeDescription
RangestringFacet range
HitsintNumber of terms that are covered by this facet.
Countint?Used for storing count
Sumdouble?Used for storing sum
Maxdouble?Used for storing max
Mindouble?Used for storing min
Averagedouble?Used for storing average

Methods

SignatureDescription
double? GetAggregation(FacetAggregation aggregation)Returns aggregation by given type