Coveo HierarchicalFacet Component (CoveoHierarchicalFacet)

Index

Methods

close

  • close(value: FacetValue | IValueHierarchy | string): void

collapse

  • collapse(): void

debugInfo

  • debugInfo(): any

deselectMultipleValues

  • deselectMultipleValues(values: FacetValue[] | string[], deselectChildren?: boolean): void

deselectValue

  • deselectValue(value: FacetValue | string, deselectChildren?: boolean): void

disable

  • disable(): void

enable

  • enable(): void

excludeMultipleValues

  • excludeMultipleValues(values: FacetValue[] | string[]): void

excludeValue

  • excludeValue(value: FacetValue | string, excludeChildren?: boolean): void

expand

  • expand(): void

getBindings

getCaptionForStringValue

  • getCaptionForStringValue(value: string): string

getDisplayedFacetValues

  • getDisplayedFacetValues(): FacetValue[]

getDisplayedValues

  • getDisplayedValues(): string[]

getEndpoint

  • getEndpoint(): ISearchEndpoint

getExcludedValues

  • getExcludedValues(): string[]

getSelectedValues

  • getSelectedValues(): string[]

getValueCaption

hasSelectedValue

  • hasSelectedValue(value: string): boolean

hideWaitingAnimation

  • hideWaitingAnimation(): void

open

  • open(value: FacetValue | IValueHierarchy | string): void

reset

  • reset(): void

selectMultipleValues

  • selectMultipleValues(values: FacetValue[] | string[], selectChildren?: boolean): void

selectValue

  • selectValue(value: FacetValue | string, selectChildren?: boolean): void

showLess

  • showLess(): void

showMore

  • showMore(): void

showWaitingAnimation

  • showWaitingAnimation(): void

switchToAnd

  • switchToAnd(): void

switchToOr

  • switchToOr(): void

toggleExcludeValue

  • toggleExcludeValue(value: FacetValue | string): void

toggleSelectValue

  • toggleSelectValue(value: FacetValue | string): void

unexcludeMultipleValues

  • unexcludeMultipleValues(values: FacetValue[] | string[]): void

unexcludeValue

  • unexcludeValue(value: FacetValue | string, unexludeChildren?: boolean): void

updateSort

  • updateSort(criteria: string): void

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

Properties

bind

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

componentStateModel

componentStateModel: ComponentStateModel

disabled

disabled: boolean

facetSearch

facetSearch: FacetSearch

facetSettings

facetSettings: FacetSettings

logger

logger: Logger

queryController

queryController: QueryController

queryStateModel

queryStateModel: QueryStateModel

root

root: HTMLElement

searchInterface

searchInterface: SearchInterface

Static ID

ID: string

Accessors

usageAnalytics

usageAnalytics:

Component Options

delimitingCharacter

delimitingCharacter: string
Markup configuration example(s) :
data-delimiting-character='foo'

levelEnd

levelEnd: number
Markup configuration example(s) :
data-level-end='10'

levelStart

levelStart: number
Markup configuration example(s) :
data-level-start='10'

marginByLevel

marginByLevel: number
Markup configuration example(s) :
data-margin-by-level='10'

Constructors

constructor

Implements