Coveo DynamicFacet Component (CoveoDynamicFacet)

Index

Methods

collapse

  • collapse(): void

debugInfo

  • debugInfo(): any

deselectMultipleValues

  • deselectMultipleValues(values: string[]): void

deselectValue

  • deselectValue(value: string): void

disable

  • disable(): void

enable

  • enable(): void

enableFreezeCurrentValuesFlag

  • enableFreezeCurrentValuesFlag(): void

enableFreezeFacetOrderFlag

  • enableFreezeFacetOrderFlag(): void

expand

  • expand(): void

getBindings

getCaptionForStringValue

  • getCaptionForStringValue(value: string): string

hasSelectedValue

  • hasSelectedValue(value: string): boolean

reset

  • reset(): void

selectMultipleValues

  • selectMultipleValues(values: string[]): void

selectValue

  • selectValue(value: string): void

showLessValues

  • showLessValues(): void

showMoreValues

  • showMoreValues(additionalNumberOfValues?: number): void

toggleCollapse

  • toggleCollapse(): void

toggleSelectValue

  • toggleSelectValue(value: string): void

Static get

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

Properties

bind

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

componentStateModel

componentStateModel: ComponentStateModel

disabled

disabled: boolean

logger

logger: Logger

queryController

queryController: QueryController

queryStateModel

queryStateModel: QueryStateModel

root

root: HTMLElement

searchInterface

searchInterface: SearchInterface

Static ID

ID: string

Accessors

usageAnalytics

usageAnalytics:

Component Options

collapsedByDefault

collapsedByDefault: boolean
Markup configuration example(s) :
data-collapsed-by-default='true'
data-collapsed-by-default='false'

customSort

customSort: string[]

dependsOn

dependsOn: string
Markup configuration example(s) :
data-depends-on='document-type-facet'

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'

enableScrollToTop

enableScrollToTop: boolean
Markup configuration example(s) :
data-enable-scroll-to-top='true'
data-enable-scroll-to-top='false'

field

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

filterFacetCount

filterFacetCount: boolean
Markup configuration example(s) :
data-filter-facet-count='true'
data-filter-facet-count='false'

id

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

includeInBreadcrumb

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

injectionDepth

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

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'

sortCriteria

sortCriteria: FacetSortCriteria
Markup configuration example(s) :
data-sort-criteria='score'

title

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

useLeadingWildcardInFacetSearch

useLeadingWildcardInFacetSearch: boolean
Markup configuration example(s) :
data-use-leading-wildcard-in-facet-search='true'
data-use-leading-wildcard-in-facet-search='false'

valueCaption

valueCaption: IStringMap<string>
Markup configuration example(s) :
data-value-caption='{ "smith_alice": "Alice Smith", "jones_bob_r": "Bob R. Jones" }'

Constructors

constructor

Implements

  • IDynamicFacet