Coveo CategoryFacet Component (CoveoCategoryFacet)

The CategoryFacet component is a facet that renders values in a hierarchical fashion. It determines the filter to apply depending on the current selected path of values.

The path is a sequence of values that leads to a specific value in the hierarchy. It is an array listing all the parents of a file (e.g., ['c', 'folder1'] for the c:\folder1\text1.txt file).

This facet requires a field with a special format to work correctly (see Using the Category Facet Component).

Not supported in

Coveo for Salesforce Free

Available since

[January 2019 Release (v2.5395.12)]({{ site.baseurl }}/2938/)

Index

Methods

changeActivePath

  • changeActivePath(path: string[]): void

debugInfo

  • debugInfo(): any

debugValue

  • debugValue(value: string): Promise<void>
  • Goes through any value that contains the value parameter, and verifies whether there are missing parents. Issues are then logged in the console. If you do not want to specify a value, you can simply enable CategoryFacet.options.debug and do an empty query.

    Parameters

    • value: string

    Returns Promise<void>

deselectCurrentValue

  • deselectCurrentValue(): void
  • Deselects the last value in the hierarchy that is applied to the query. When at the top of the hierarchy, this method does nothing.

    Returns void

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

getAvailableValues

  • getAvailableValues(): object[]
  • Returns the values at the bottom of the hierarchy. These are the values that are not yet applied to the query.

    Returns object[]

    simple object with three fields: value, count and path.

getBindings

getCaption

  • getCaption(value: string): string
  • Parameters

    • value: string

      The string to find a caption for. Returns the caption for a value or the value itself if no caption is available.

    Returns string

getVisibleParentValues

  • getVisibleParentValues(): CategoryValueDescriptor[]

hide

  • hide(): void

reload

  • reload(): void

reset

  • reset(): void

selectValue

  • selectValue(value: string): void
  • Selects a value from the currently available values. If the given value to select is not in the available values, it will throw an error.

    Parameters

    • value: string

    Returns void

show

  • show(): void

showLess

  • showLess(): void

showMore

  • showMore(): void

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

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

basePath

basePath: string[]

The path to use as the path prefix for every query.

Example:

You have the following files indexed on a file system:

c:\
   folder1\
     text1.txt
   folder2\
     folder3\
       text2.txt

Setting the basePath to c would display folder1 and folder2 in the CategoryFacet, but omit c.

This options accepts an array of values. To specify a "deeper" starting path in your tree, you need to use comma-separated values.

For example, setting data-base-path="c,folder1" on the component markup would display folder3 in the CategoryFacet, but omit c and folder1.

Default

[]

debug

debug: boolean

Whether to activate field format debugging. This options logs messages in the console for any potential encountered issues. This option can have negative effects on performance, and should only be activated when debugging.

Default

false

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

delimitingCharacter

delimitingCharacter: string

The character that specifies the hierarchical dependency.

Example:

If your field has the following values:

@field: c; c>folder2; c>folder2>folder3;

The delimiting character is >.

Default value is |.

Default

|

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

dependsOn

dependsOn: string

The [id](@link Facet.options.id) of another facet in which at least one value must be selected in order for the dependent category facet to be visible.

Default: undefined and the category facet does not depend on any other facet to be displayed.

Available since

September 2019 Release (v2.7023)

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

dependsOnCondition

dependsOnCondition: IDependentFacetCondition

A function that verifies whether the current state of the dependsOn facet allows the dependent facet to be displayed.

If specified, the function receives a reference to the resolved dependsOn facet component instance as an argument, and must return a boolean. The function's argument should typically be treated as read-only.

By default, the dependent facet is displayed whenever one or more values are selected in its dependsOn facet.

Only effective when

dependsOn is set to true

Additional documentation

Defining Dependent Facets

displaySearchButton

displaySearchButton: boolean

Whether to display the facet search widget as a button instead of a search bar.

Default

true

Available since

July 2020 Release (v2.9373)

Markup configuration example(s) :
data-display-search-button='true'
data-display-search-button='false'

displaySearchOnTop

displaySearchOnTop: boolean

Whether to display the facet search widget above the facet values instead of below them.

Default

false

Available since

July 2020 Release (v2.9373)

Markup configuration example(s) :
data-display-search-on-top='true'
data-display-search-on-top='false'

enableFacetSearch

enableFacetSearch: boolean

Whether to display a search box at the bottom of the facet for searching among the available facet field values.

See also the facetSearchDelay, and numberOfResultsInFacetSearch options.

Default value is true.

Default

true

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

enableMoreLess

enableMoreLess: boolean

Whether to enable the More and Less buttons in the Facet.

See also the pageSize option.

Default value is true.

Default

true

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

facetSearchDelay

facetSearchDelay: number

If the enableFacetSearch option is true, specifies the delay (in milliseconds) before sending a search request to the server when the user starts typing in the category facet search box.

Specifying a smaller value makes results appear faster. However, chances of having to cancel many requests sent to the server increase as the user keeps on typing new characters.

Default value is 100. Minimum value is 0.

Minimum

0

Default

100

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

field

The index field whose values the facet should use. The field values should have the form: the; the|path; the|path|to; the|path|to|given; the|path|to|given|item; where the delimiting character is |. This default delimiting character can be changed using the delimitingCharacter option.

To help you verify whether your fields are setup correctly, see the CategoryFacet.options.debug option and the CategoryFacet.debugValue method.

See Using the Category Facet Component.

Required

Specifying a value for this option is required for the component to work

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

id

id: string

A unique identifier for the facet. Among other things, this identifier serves the purpose of saving the facet state in the URL hash.

If you have two facets with the same field on the same page, you should specify an id value for at least one of those two facets. This id must be unique among the facets.

Default value is the field option value.

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

injectionDepth

injectionDepth: number

The injection depth to use.

The injection depth determines how many results to scan in the index to ensure that the category facet lists all potential facet values. Increasing this value enhances the accuracy of the listed values at the cost of performance.

Default value is 1000. Minimum value is 0.

Not supported in

Coveo for Salesforce Free

Minimum

0

Default

1000

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

maximumDepth

maximumDepth: number

The maximum number of levels to traverse in the hierarchy. This option does not count the length of the base path. The depth depends on what is shown in the interface.

Default value is Number.MAX_VALUE.

Minimum

1

Markup configuration example(s) :
data-maximum-depth='10'

numberOfResultsInFacetSearch

numberOfResultsInFacetSearch: number

If the enableFacetSearch option is true, specifies the number of values to display in the facet search results popup.

Default value is 15. Minimum value is 1.

Minimum

1

Default

15

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

numberOfValues

numberOfValues: number

The maximum number of field values to display by default in the facet before the user clicks the arrow to show more.

See also the enableMoreLess option.

Minimum

0

Default

5

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

pageSize

pageSize: number

If the enableMoreLess option is true, specifies the number of additional results to fetch when clicking the More button.

Default value is 10. Minimum value is 1.

Only effective when

enableMoreLess is set to true

Minimum

1

Default

10

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

title

title: string

The title to display at the top of the facet.

Default value is the localized string for NoTitle.

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

valueCaption

valueCaption: IStringMap<string>

Specifies a JSON object describing a mapping of facet values to their desired captions. See Normalizing Facet Value Captions.

Note: If this option is specified, the facet search box will be unavailable.

Examples:

You can set the option in the 'init' call:

var myValueCaptions = {
  "txt" : "Text files",
  "html" : "Web page",
  [ ... ]
};

Coveo.init(document.querySelector("#search"), {
  Facet : {
    valueCaption : myValueCaptions
  }
});

Or before the init call, using the 'options' top-level function:

Coveo.options(document.querySelector("#search"), {
  Facet : {
    valueCaption : myValueCaptions
  }
});

Or directly in the markup:

<!-- Ensure that the double quotes are properly handled in data-value-caption. -->
<div class='CoveoCategoryFacet' data-field='@myotherfield' data-value-caption='{"txt":"Text files","html":"Web page"}'></div>

Constructors

constructor

  • Create a new Component. Resolve all IComponentBindings if not provided.
    Create a new Logger for this component. Attach the component to the SearchInterface.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to create the component. Used to bind data on the element.

    • type: string

      The unique identifier for this component. See: IComponentDefinition.ID. Used to generate the unique Coveo CSS class associated with every component.

    • Default value bindings: IComponentBindings = {}

      The environment for every component. Optional, but omitting to provide one will impact performance.

    Returns CategoryFacet

Implements

  • IAutoLayoutAdjustableInsideFacetColumn