Interface IAnalyticsFacetState

Describes the current condition of a single dynamic facet value.

Index

Properties

Properties

Optional displayValue

displayValue: string

The custom display name of the dynamic facet value that was interacted with.

Example: Alice R. Smith

Optional end

end: string

The maximum value of the dynamic range facet value.

Examples:

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

Optional endInclusive

endInclusive: boolean

Whether the end value is included in the dynamic range facet value.

Optional facetType

facetType: FacetType

The type of values displayed in the dynamic facet.

field

field: string

The name of the field the dynamic facet displaying the value is based on.

Example: author

id

id: string

The unique identifier of the dynamic facet displaying the value.

Example: author

Optional start

start: string

The minimum value of the dynamic range facet value.

Examples:

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

Optional state

state: FacetValueState

The new state of the dynamic facet value that was interacted with.

title

title: string

The title of the dynamic facet.

Example: Author

Optional value

value: string

The original name (i.e., field value) of the dynamic facet value.

Example: alice_r_smith

Optional valuePosition

valuePosition: number

The current 1-based position of the dynamic facet value, relative to other values in the same dynamic facet.

Hierarchy

  • IAnalyticsFacetState