Coveo Facet Component (CoveoFacet)

Index

Methods

collapse

  • collapse(): void

debugInfo

  • debugInfo(): any

deselectMultipleValues

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

deselectValue

disable

  • disable(): void

enable

  • enable(): void

excludeMultipleValues

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

excludeValue

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

reset

  • reset(): void

selectMultipleValues

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

selectValue

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): 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

additionalFilter

additionalFilter: string
Markup configuration example(s) :
data-additional-filter='foo'

allowedValues

allowedValues: string[]

availableSorts

availableSorts: string[] | ("occurrences" | "score" | "alphaascending" | "alphadescending" | "computedfieldascending" | "computedfielddescending" | "chisquare" | "nosort")[]

computedField

computedField: IFieldOption
Markup configuration example(s) :
data-computed-field='@foo'

computedFieldCaption

computedFieldCaption: string
Markup configuration example(s) :
data-computed-field-caption='foo'

computedFieldFormat

computedFieldFormat: "c0" | "n0" | "n2"

computedFieldOperation

computedFieldOperation: "sum" | "average" | "minimum" | "maximum"

customSort

customSort: string[]

dependsOn

dependsOn: string
Markup configuration example(s) :
data-depends-on='foo'

dependsOnCondition

dependsOnCondition: IDependentFacetCondition

enableCollapse

enableCollapse: boolean
Markup configuration example(s) :
data-enable-collapse='true'
data-enable-collapse='false'

enableFacetSearch

enableFacetSearch: boolean
Markup configuration example(s) :
data-enable-facet-search='true'
data-enable-facet-search='false'

enableMoreLess

enableMoreLess: boolean
Markup configuration example(s) :
data-enable-more-less='true'
data-enable-more-less='false'

enableSettings

enableSettings: boolean
Markup configuration example(s) :
data-enable-settings='true'
data-enable-settings='false'

enableSettingsFacetState

enableSettingsFacetState: boolean
Markup configuration example(s) :
data-enable-settings-facet-state='true'
data-enable-settings-facet-state='false'

enableTogglingOperator

enableTogglingOperator: boolean
Markup configuration example(s) :
data-enable-toggling-operator='true'
data-enable-toggling-operator='false'

facetSearchDelay

facetSearchDelay: number
Markup configuration example(s) :
data-facet-search-delay='10'

facetSearchIgnoreAccents

facetSearchIgnoreAccents: boolean
Markup configuration example(s) :
data-facet-search-ignore-accents='true'
data-facet-search-ignore-accents='false'

field

Markup configuration example(s) :
data-field='@foo'

id

id: string
Markup configuration example(s) :
data-id='foo'

includeInBreadcrumb

includeInBreadcrumb: boolean
Markup configuration example(s) :
data-include-in-breadcrumb='true'
data-include-in-breadcrumb='false'

includeInOmnibox

includeInOmnibox: boolean
Markup configuration example(s) :
data-include-in-omnibox='true'
data-include-in-omnibox='false'

injectionDepth

injectionDepth: number
Markup configuration example(s) :
data-injection-depth='10'

isMultiValueField

isMultiValueField: boolean
Markup configuration example(s) :
data-is-multi-value-field='true'
data-is-multi-value-field='false'

lookupField

lookupField: IFieldOption
Markup configuration example(s) :
data-lookup-field='@foo'

numberOfValues

numberOfValues: number
Markup configuration example(s) :
data-number-of-values='10'

numberOfValuesInBreadcrumb

numberOfValuesInBreadcrumb: number
Markup configuration example(s) :
data-number-of-values-in-breadcrumb='10'

numberOfValuesInFacetSearch

numberOfValuesInFacetSearch: number
Markup configuration example(s) :
data-number-of-values-in-facet-search='10'

numberOfValuesInOmnibox

numberOfValuesInOmnibox: number
Markup configuration example(s) :
data-number-of-values-in-omnibox='10'

paddingContainer

paddingContainer: HTMLElement

pageSize

pageSize: number
Markup configuration example(s) :
data-page-size='10'

preservePosition

preservePosition: boolean
Markup configuration example(s) :
data-preserve-position='true'
data-preserve-position='false'

scrollContainer

scrollContainer: HTMLElement

sortCriteria

sortCriteria: "occurrences" | "score" | "alphaascending" | "alphadescending" | "computedfieldascending" | "computedfielddescending" | "chisquare" | "nosort"

title

title: string
Markup configuration example(s) :
data-title='foo'

useAnd

useAnd: boolean
Markup configuration example(s) :
data-use-and='true'
data-use-and='false'

useWildcardsInFacetSearch

useWildcardsInFacetSearch: boolean
Markup configuration example(s) :
data-use-wildcards-in-facet-search='true'
data-use-wildcards-in-facet-search='false'

valueCaption

valueCaption: IStringMap<string>

Constructors

constructor

  • new Facet(element: HTMLElement, options: IFacetOptions, bindings?: IComponentBindings, facetClassId?: string): Facet

Implements

  • IFieldValueCompatibleFacet