Closes (collapses) a single value and hides all its children.
The value to close.
Collapses the facet.
Return the debug info about this component.
Deselects multiple values.
The array of values to deselect.
Specifies whether to also deselect all child values (if any). Default value is the opposite
of the useAnd option value set for this HierarchicalFacet.
Deselects a single value
The value to deselect.
Specifies whether to also deselect all child values (if any). Default value is true.
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.
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.
Excludes multiple values.
Does not trigger a query automatically.
Can be an array of FacetValue or an array of strings.
Excludes a single value.
The value to exclude.
Specifies whether to also exclude all child values (if any). Default value is the opposite
of the useAnd option value set for this HierarchicalFacet.
Expands the facet.
Return the bindings, or environment, for the current component.
Returns the configured caption for a desired facet value.
The string facet value whose caption the method should return.
Returns the currently displayed values as an array of FacetValue.
The currently displayed values.
Gets the values that the HierarchicalFacet is currently displaying.
An array containing all the values that the HierarchicalFacet is currently displaying.
Returns the endpoint for the facet.
The endpoint for the facet.
Returns the currently excluded values as an array of strings.
The currently excluded values.
Returns the currently selected values as an array of strings.
The currently selected values.
Gets the caption of a single value.
The value whose caption the method should return.
The caption of the value.
Determines whether the specified value is selected in the facet.
The name of the facet value to verify.
Hides the waiting animation in the facet header.
Opens (expands) a single value and shows all its children.
The value to open.
Resets the HierarchicalFacet state.
Selects multiple values
The array of values to select.
Specifies whether to also select all child values (if any). Default value is the opposite of
the useAnd option value set for this HierarchicalFacet.
Selects a single value.
The value to select.
Specifies whether to also select all child values (if any). Default value is the opposite of
the useAnd option value set for this HierarchicalFacet.
Shows less elements in the Facet (up to the original number of values).
See the enableMoreLess, and
numberOfValues options.
Shows the next page of results in the facet.
See the enableMoreLess, and pageSize
options.
Triggers a query if needed, or displays the already available values.
Shows a waiting animation in the facet header (a spinner).
Switches the facet to AND mode.
See the useAnd, and
enableTogglingOperator options.
Switches the facet to OR mode.
See the useAnd, and
enableTogglingOperator options.
Toggles the exclusion of a single value (excludes value if not excluded; un-excludes value if excluded).
The value to exclude or un-exclude.
Toggles the selection of a single value (selects value if not selected; deselects value if selected).
The value to select or deselect.
Unexcludes multiple values.
Does not trigger a query automatically.
Can be an array of FacetValue or an array of strings.
Un-excludes a single value.
The value to un-exclude.
Specifies whether to also un-exclude all child values (if any). Default value is the
opposite of the useAnd option value set for this HierarchicalFacet.
Updates the sort criteria for the HierarchicalFacet.
See the sortCriteria property of the [IGroupByRequest] interface for the
list and description of possible values.
The new sort criteria.
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.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for different components. Mainly used by ResultLink.
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.
A disabled component will not participate in the query, or listen to ComponentEvents.
Renders and handles the facet Search part of the component.
Renders and handles the facet Settings part of the component
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
The character that allows to specify 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 |.
data-delimiting-character='foo'
Specifies at which level (0-based index) of the hierarchy the HierarchicalFacet should stop displaying its
values.
Default value is undefined, which means the HierarchicalFacet component renders all hierarchical levels.
Minimum value is 0.
data-level-end='10'
Specifies at which level (0-based index) of the hierarchy the HierarchicalFacet should start displaying its
values.
Example:
If you have the following files indexed on a file system:
c:\
folder1\
text1.txt
folder2\
folder3\
text2.txt
Setting levelStart to 1 displays folder1 and folder2 in the HierarchicalFacet, but omits c:.
Default (and minimum) value is 0.
data-level-start='10'
Specifies the margin (in pixels) to display between each hierarchical level when expanding.
Default value is 10.
data-margin-by-level='10'
Creates a new HierarchicalFacet component.
The HTMLElement on which to instantiate the component.
The options for the HierarchicalFacet component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
This component is exposed for legacy reasons. Instead, use the CategoryFacet component, which is more performant and easier to use.
The
HierarchicalFacetcomponent inherits all of its options and behaviors from theFacetcomponent, but is meant to be used to render hierarchical values.Note:
The
HierarchicalFacetcomponent can be used to display files in a file system, or categories for items in a hierarchy.This facet requires a group by field with a special format to work correctly.
Example:
You have the following files indexed on a file system:
c:\ folder1\ text1.txt folder2\ folder3\ text2.txtThe
text1.txtitem would have a field with the following format:c; c|folder1;The
text2.txtitem would have a field with the following format:c; c|folder2; c|folder2|folder3;By default, the
|character determines the hierarchy (folder3insidefolder2insidec).Since both items contain the
cvalue, selecting it value in the facet would return both items.Selecting the
folder3value in the facet would only return thetext2.txtitem.Coveo for Salesforce Free
January 2019 Release (v2.5395.12)