Interface IFacetResponseValue

A [values]{@link IFacetRequest.values} item in a Search API facet response.

Index

Properties

Properties

Optional children

children: IFacetResponseValue[]

The children of this hierarchical facet value.

Optional end

end: RangeType

The value to end the range at.

Examples:

  • 500
  • 2018-12-31T23:59:59.999Z

Optional endInclusive

endInclusive: boolean

Whether to include the end value in the range.

Optional isLeafValue

isLeafValue: boolean

When the hierarchical value has no children, this property is true.

Optional label

label: string

The label to associate with the range value.

Examples:

  • 0 - 500
  • In 2018

Optional moreValuesAvailable

moreValuesAvailable: boolean

Whether additional values are available for the facet.

numberOfResults

numberOfResults: number

The number of query result items matching the facet value.

Optional start

start: RangeType

The value to start the range at.

Examples:

  • 0
  • 2018-01-01T00:00:00.000Z

state

state: FacetValueState

The facet value state to display in the search interface.

Optional value

value: string

The facet value name.

Hierarchy