Coveo DynamicFacetManager Component (CoveoDynamicFacetManager)

The DynamicFacetManager component is meant to be a parent for multiple DynamicFacet & DynamicFacetRange components. This component allows controlling a set of DynamicFacet and DynamicFacetRange as a group.

Available since

May 2019 Release (v2.6063)

Additional documentation

Using Dynamic Facets.

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void

  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

enable

  • enable(): void

  • Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

getBindings

Static get

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

  • Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
    If there is multiple component bound to the current HTMLElement, you must specify the component class.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

bind: ComponentEvents

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

Static ID

ID: string

The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton

Accessors

usageAnalytics

Component Options

compareFacets

compareFacets: IDynamicFacetManagerCompareFacet

A custom sort function to execute on facets on every successful query response @externaldocs Using Custom Dynamic Facet Sort Functions.

Note:

If specified, the function must implement the JavaScript compareFunction (see Array.prototype.sort. You cannot set this option directly in the component markup as an HTML attribute. You must either set it in the init call of your search interface (see Passing Component Options in the init Call), or before the init call, using the options top-level function (see Passing Component Options Before the init Call).

enableReorder

enableReorder: boolean

Whether to allow the reordering of facets based on Coveo ML and index ranking scores.

Default: true

Default

true

Markup configuration example(s) :
data-enable-reorder='true'
data-enable-reorder='false'

maximumNumberOfExpandedFacets

maximumNumberOfExpandedFacets: number

The maximum number of expanded facets inside the manager. Remaining facets are collapsed.

Note: Prioritizes facets with active values, and then prioritizes first facets. If the number of facets with active values exceeds the value of the maximumNumberOfExpandedFacets option, it overrides the option.

Using the value -1 disables the feature and keeps all facets expanded.

Default

4

Available since

September 2019 Release (v2.7023)

Markup configuration example(s) :
data-maximum-number-of-expanded-facets='10'

onUpdate

onUpdate: IDynamicFacetManagerOnUpdate

A function to execute whenever facets are updated in the query response @externaldocs Defining Custom Dynamic Facet Behaviors.

Note:

You cannot set this option directly in the component markup as an HTML attribute. You must either set it in the init call of your search interface (see Passing Component Options in the init Call), or before the init call, using the options top-level function (see Passing Component Options Before the init Call).

Constructors

constructor

  • new DynamicFacetManager(element: HTMLElement, options?: IDynamicFacetManagerOptions): DynamicFacetManager