The AdvancedSearch component is meant to render a section in the Settings menu to allow the end\nuser to easily create complex queries to send to the index.\nNote:
\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.bind", "notSupportedIn": "", "comment": "You can write custom code to add new sections in the Advanced Search modal box generated by this component by\nattaching a handler to the
\nbuildingAdvancedSearchevent.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearch.options.includeDate", "notSupportedIn": "", "comment": "Specifies whether to include the built-in Date section.\nDefault value is true.
Specifies whether to include the built-in Document section.\nDefault value is true.
Specifies whether to include the built-in Keywords section.\nDefault value is true.
Creates a new AdvancedSearch component.\nTriggers the buildingAdvancedSearch event.
The Aggregate component allows to display the result on an aggregate operation on the index.\nIt hooks itself to the query to add a new IGroupByRequest, then displays the result.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Aggregate.options.field", "notSupportedIn": "", "comment": "Specifies the field on which to do the aggregate operation. This parameter is mandatory.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "Aggregate.options.format", "notSupportedIn": "", "comment": "Specifies how to format the value.\nThe available formats are defined in the Globalize library (see\nGlobalize.
\nThe most commonly used formats are:
\nc0 - Formats the value as a currency.n0 - Formats the value as an integer.n2 - Formats the value as a floating point with 2 decimal digits.Default value is c0.
Specifies the aggregate operation to perform.\nThe possible values are:
\nsum - Computes the sum of the computed field values.average - Computes the average of the computed field values.minimum - Finds the minimum value of the computed field values.maximum - Finds the maximum value of the computed field values.Default value is sum.
Creates a new Aggregate component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics", "notSupportedIn": "", "comment": "The Analytics component can log user actions performed in the search interface and send them to a REST web service\nexposed through the Coveo Cloud Platform.\nYou can use analytics data to evaluate how users are interacting with your search interface, improve relevance and\nproduce analytics dashboards within the Coveo Cloud Platform.
See JavaScript Search Framework Usage Analytics for an introduction.
\nSee also Logging Your Own Search Events for more advanced use cases.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.client", "notSupportedIn": "", "comment": "A reference to the AnalyticsClient, which performs the heavy duty part of sending the usage analytics events to\nthe Coveo Usage Analytics service.
Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.options", "notSupportedIn": "", "comment": "Options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Analytics.options.anonymous", "notSupportedIn": "", "comment": "Specifies whether to convert search user identities to unique hash when logging analytics data, so that\nanalytics reviewers and managers will not be able to clearly identify which user is performing which query.\nWhen you set this option to true, the Coveo Usage Analytics service can still properly differentiate sessions\nmade by anonymous users from sessions made by users authenticated in some way on the site containing the search\npage.
Default value is false.
Whether to automatically attempt to push Coveo usage analytics events to the Google Tag Manager data layer.\nSee also gtmDataLayerName.
Specifies the URL of the Usage Analytics service. You do not have to specify a value for this option, unless\nthe location of the service you use differs from the default Coveo Cloud Usage Analytics endpoint.\nBy default, the value is https://analytics.cloud.coveo.com/rest/ua, or\nhttps://analytics-<REGION_ABBREVIATION>.cloud.coveo.com/rest/ua if you have\nconfigured your search endpoint to implement\ndata residency outside of the United States.
The name of the Google Tag Manager data layer initialized in the page.\nSee also autoPushToGtmDataLayer.
Note:\nSetting this option is only useful if the GTM data layer was renamed in the page.
\nDefault: dataLayer
Specifies the organization bound to the access token. This is necessary when using an access token, because a\nsingle access token can be associated to more than one organization.\nDefault value is undefined, and the value of this parameter will fallback to the organization used for the\nsearch endpoint.
Sets the Search Hub dimension on the search events.\nThe Search Hub dimension is typically a name that refers to a specific search page. For example, you could use\nthe CommunitySite value to refer to a search page on a public community site.
Note:
\n\n\nIf you wish to use the search hub dimension for security reasons (e.g., to provide different query suggestions\nfor internal and external users), you should specify the search hub when generating the search token for the\nend user (in safe, server-side code), rather than setting it with this option (see\nSearch Token Authentication).
\n
Default value is default.
Specifies the name of the split test run that the search page is part of.\nYou can use this dimension to perform A/B testing using different search page layouts and features inside the\nCoveo Query pipeline.
\nDefault value is undefined and no split test run name is reported to the Coveo Usage Analytics service.
Specifies the version name for the page when a split test run is active.\nWhen reporting on A/B testing analytics data, this value specifies the test run version name that was\npresented to the user.
\nDefault value is undefined
Specifies the token to use to access the usage analytics endpoint.\nDefault value is undefined, and the component uses the search token.
Specifies the name of the user for the usage analytics logs.\nDefault value is undefined
Specifies the user display name for the usage analytics logs.\nDefault value is undefined
Creates a new Analytics component. Creates the AnalyticsClient.
The AnalyticsSuggestion component provides query suggestions based on the queries that a Coveo Analytics service most\ncommonly logs (see topQueries).\nThis component orders possible query suggestions by their respective number of successful item views, thus\nprioritizing the most relevant query suggestions. Consequently, when better options are available, this component\ndoes not suggest queries resulting in no clicks from users or requiring refinements.
The query suggestions appear in the Omnibox Component. The AnalyticsSuggestion component strongly\nrelates to the Analytics component. While a user is typing in a query box, the AnalyticsSuggestion component\nallows them to see and select the most commonly used and relevant queries.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsSuggestions.options.headerTitle", "notSupportedIn": "", "comment": "Specifies the title of the query suggestions group in the Omnibox component. This option is not available\nwhen using the default Lightning Friendly Theme.\nDefault value is the localized string for "Suggested Queries".
Specifies the number of query suggestions to request and display in the Omnibox component.\nDefault value is 5 and minimum value is 1.
Specifies the z-index position at which the query suggestions render themselves in the Omnibox\ncomponent. Higher values are placed first.\nDefault value is 52 and minimum value is 0.
Creates a new AnalyticsSuggestions component.\nAlso binds event handlers so that when a user selects a suggestion, an omniboxFromLink usage analytics event is\nlogged if the suggestion comes from a standalone search box, or an omniboxAnalytics usage analytics\nevent is logged otherwise.
The AuthenticationProvider component makes it possible to execute queries with an identity that the end user\ncan obtain using an authentication provider configured on the Coveo REST Search API\n(see Claims Authentication).\nWhen necessary, this component handles redirecting the browser to the address that starts the authentication process.
You can use the data-tab attribute to enable the AuthenticationProvider component only for the tabs of your\nsearch interface that require authentication (see the Tab component).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.options", "notSupportedIn": "", "comment": "The options for the component.
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.options.caption", "notSupportedIn": "", "comment": "Specifies the display name of the authentication provider. This is the name that you want to appear in the user\ninterface when the end user is logging in.\nDefault value is the name option value.
Specifies the name of the authentication provider.\nSee SAML Authentication.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "AuthenticationProvider.options.showIFrame", "notSupportedIn": "", "comment": "If the useIFrame option is true, specifies whether to make\nthe authentication <iframe> visible to the user (inside a popup).\nWhen the underlying authentication provider requires no user interaction (for example, when a user authenticates\nusing Windows authentication along with SharePoint claims), setting this option to false reduces the visual\nimpact of the authentication process.
Default value is true.
Specifies whether to use an <iframe> to host the chain of redirection that make up the authentication\nprocess.\nUsing an <iframe> prevents leaving the search page as part of the authentication process. However, some login\nproviders refuse to load in an <iframe>.
Default value is false.
Creates a new AuthenticationProvider component.
The Backdrop component renders an image URL (either passed as a direct URL or contained in a result field) as a\nbackground image. It is useful for displaying information in front of a dynamic background image.\nThe Backdrop component will automatically initialize components embedded within itself:
\n <div class=\"CoveoBackdrop\" data-image-field=\"ytthumbnailurl\">\n <div class=\"CoveoFieldValue\" data-field=\"somefield\"></div>\n </div>\nAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.options.imageField", "notSupportedIn": "", "comment": "Specifies the field from which the background image will be pulled.\nIf Backdrop.options.imageUrl is specified, it will override this option.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.options.imageUrl", "notSupportedIn": "", "comment": "Specifies a direct URL from which the background image will be sourced.\nHas priority over Backdrop.options.imageField.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "Backdrop.options.overlayColor", "notSupportedIn": "", "comment": "Specifies the color that will be overlaid on top of the background image.\nThis option needs to be declared as a CSS color. Be sure to use RGBA with an alpha value lower than 1 in order to\nbe able to see the image behind the overlay color.\nExample value : "rgba(101, 123, 76, 0.5)"
Specifies whether the overlay color should be instead be rendered as a top-to-bottom gradient from\nBackdrop.options.overlayColor to transparent.\nDefault value is false.
Creates a new Backdrop component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge", "notSupportedIn": "", "comment": "The Badge component outputs a field value with customizable colors and an icon preceding it.\nThis component is a result template component (see Result Templates). It\nextends the FieldValue component. Therefore all FieldValue options are also available for a Badge component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.options.colors", "notSupportedIn": "", "comment": "Specifies the colors for the Badge component.\nYou must specify the colors in a JSON format similar to what follows:
\n{\n \"values\":{\n \"foo\":{\n \"icon\":\"blue\",\n \"text\":\"#222\"\n },\n \"bar\":{\n \"icon\":\"green\",\n \"text\":\"lightgreen\"\n }\n },\n \"icon\":\"red\",\n \"text\":\"#9ab52b\"\n}\nThis format allows you to customize both the icon and text colors for each field value as well as the default\nvalues.
\nColors can be specified in HTML or hexadecimal format.
\n", "type": "IBadgeColors", "constrainedValues": [], "miscAttributes": {} }, { "name": "Badge.constructor", "notSupportedIn": "", "comment": "Creates a new Badge component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb", "notSupportedIn": "", "comment": "The Breadcrumb component displays a summary of the currently active query filters.\nFor example, when the user selects a Facet value, the breadcrumbs display this value.
\nThe active filters are obtained by the component by firing an event in the Breadcrumb component.
\nAll other components having an active state can react to this event by providing custom bits of HTML to display\ninside the breadcrumbs.
\nThus, it is possible to easily extend the Breadcrumb component using custom code to display information about custom\nstates and filters.
\nSee BreadcrumbEvents for the list of events and parameters sent when a Breadcrumb component is populated.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.options", "notSupportedIn": "", "comment": "The options for the Breadcrumb.
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Breadcrumb.options.headingLevel", "notSupportedIn": "", "comment": "The heading level to use for the heading before the breadcrumbs.\nA value of 0 will render a div element instead.
Creates a new Breadcrumb component. Binds event on QueryEvents.deferredQuerySuccess to draw the\nbreadcrumbs.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar", "notSupportedIn": "", "comment": "The CardActionBar component displays an action bar at the bottom of a card result (see\nResult Layouts). It is a simple container for buttons or complementary\ninformation.\nYou should place this component at the bottom of a card result template (i.e., as the last child of the surrounding\ncoveo-result-frame div).
See Using the CardActionBar Component
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardActionBar.options.hidden", "notSupportedIn": "", "comment": "Whether to hide the component by default and append a visual indicator to its parent query result.\nIf this option is set to true, the component will show itself when the user clicks its parent query result.
Default value is true.
Whether to open the CardActionBar when the cursor hovers over it.\nThis option is only meaningful when hidden is set to true.
Default value is true.
Creates a new CardActionBar component.
The CardOverlay component displays a button that the user can click to toggle the visibility of an overlay on top of\nan IQueryResult. While this component typically populates a CardActionBar component, it is actually\npossible to place a CardOverlay component anywhere in any result.\nThe primary purpose of the CardOverlay component is to display additional information about a result in a format that\nfits well within a card result layout (see Result Layouts).
\nWhen initialized, this component creates a <div class="coveo-card-overlay"> element as the last child of its parent\nIQueryResult, and displays a button which toggles the visibility of the overlay.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.options.icon", "notSupportedIn": "", "comment": "Specifies the icon to use for the overlay icon and for the button icon.\nThe name of the icon to use should be specified in dashed case. ie: facet-expand
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlay.options.title", "notSupportedIn": "", "comment": "Specifies the string to use for the overlay title and for the button text.\nSetting a value for this option is required for this component to work.
\n", "type": "string", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "CardOverlay.constructor", "notSupportedIn": "", "comment": "Creates a new CardOverlay component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet", "notSupportedIn": [ "salesforcefree" ], "comment": "The CategoryFacet component is a facet that renders values in a hierarchical fashion. It determines the filter to apply depending on the\ncurrent selected path of values.\nThe path is a sequence of values that leads to a specific value in the hierarchy.\nIt 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).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "CategoryFacet.options.basePath", "notSupportedIn": "", "comment": "The path to use as the path prefix for every query.\nExample:
\nYou have the following files indexed on a file system:
\nc:\\\n folder1\\\n text1.txt\n folder2\\\n folder3\\\n text2.txt\nSetting 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.
\nFor example, setting data-base-path="c,folder1" on the component markup would display folder3 in the CategoryFacet, but omit c and folder1.
Whether to activate field format debugging.\nThis options logs messages in the console for any potential encountered issues.\nThis option can have negative effects on performance, and should only be activated when debugging.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "CategoryFacet.options.delimitingCharacter", "notSupportedIn": "", "comment": "The character that specifies the hierarchical dependency.\nExample:
\nIf your field has the following values:
\n@field: c; c>folder2; c>folder2>folder3;
The delimiting character is >.
Default value is |.
The id of another facet in which at least one value must be selected in order\nfor the dependent category facet to be visible.\nDefault: undefined and the category facet does not depend on any other facet to be displayed.
A function that verifies whether the current state of the dependsOn facet allows the dependent facet to be displayed.\nIf specified, the function receives a reference to the resolved dependsOn facet component instance as an argument, and must return a boolean.\nThe 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.
Whether to display the facet search widget as a button instead of a search bar.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "true" } }, { "name": "CategoryFacet.options.displaySearchOnTop", "notSupportedIn": "", "comment": "Whether to display the facet search widget above the facet values instead of below them.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "CategoryFacet.options.enableFacetSearch", "notSupportedIn": "", "comment": "Whether to display a search box at the bottom of the facet for searching among the available facet\nfield values.\nSee also the facetSearchDelay, and\nnumberOfResultsInFacetSearch options.
Default value is true.
Whether to enable the More and Less buttons in the Facet.\nSee also the pageSize option.
Default value is true.
If the enableFacetSearch option is true, specifies the delay (in\nmilliseconds) before sending a search request to the server when the user starts typing in the category facet search box.\nSpecifying a smaller value makes results appear faster. However, chances of having to cancel many requests\nsent to the server increase as the user keeps on typing new characters.
Default value is 100. Minimum value is 0.
The index field whose values the facet should use. The field values should have the form:\nthe; the|path; the|path|to; the|path|to|given; the|path|to|given|item;\nwhere the delimiting character is |. This default delimiting character can be changed using the delimitingCharacter option.\nTo help you verify whether your fields are setup correctly, see the CategoryFacet.options.debug option\nand the CategoryFacet.debugValue method.
See Using the Category Facet Component.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "CategoryFacet.options.id", "notSupportedIn": "", "comment": "A unique identifier for the facet. Among other things, this identifier serves the purpose of saving\nthe facet state in the URL hash.\nIf you have two facets with the same field on the same page, you should specify an id value for at least one of\nthose two facets. This id must be unique among the facets.
Default value is the field option value.
The injection depth to use.\nThe injection depth determines how many results to scan in the index to ensure that the category facet lists all potential\nfacet values. Increasing this value enhances the accuracy of the listed values at the cost of performance.
\nDefault value is 1000. Minimum value is 1000.
The maximum number of levels to traverse in the hierarchy.\nThis option does not count the length of the base path. The depth depends on what is shown in the interface.\nDefault value is Number.MAX_VALUE.
If the enableFacetSearch option is true, specifies the number of\nvalues to display in the facet search results popup.\nDefault value is 15. Minimum value is 1.
The maximum number of field values to display by default in the facet before the user\nclicks the arrow to show more.\nSee also the enableMoreLess option.
If the enableMoreLess option is true, specifies the number of\nadditional results to fetch when clicking the More button.\nDefault value is 10. Minimum value is 1.
The title to display at the top of the facet.\nDefault value is the localized string for NoTitle.
Specifies a JSON object describing a mapping of facet values to their desired captions. See\nNormalizing Facet Value Captions.\nNote:\nIf this option is specified, the facet search box will be unavailable.
\nExamples:
\nYou can set the option in the 'init' call:
\nvar myValueCaptions = {\n \"txt\" : \"Text files\",\n \"html\" : \"Web page\",\n [ ... ]\n};\n\nCoveo.init(document.querySelector(\"#search\"), {\n Facet : {\n valueCaption : myValueCaptions\n }\n});\nOr before the init call, using the 'options' top-level function:
Coveo.options(document.querySelector(\"#search\"), {\n Facet : {\n valueCaption : myValueCaptions\n }\n});\nOr directly in the markup:
\n<!-- Ensure that the double quotes are properly handled in data-value-caption. -->\n<div class='CoveoCategoryFacet' data-field='@myotherfield' data-value-caption='{\"txt\":\"Text files\",\"html\":\"Web page\"}'></div>\nCreate a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
This component exposes options to handle commerce-related queries.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.options", "notSupportedIn": "", "comment": "The options for the CommerceQuery.
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "CommerceQuery.options.listing", "notSupportedIn": "", "comment": "The listing page identifier.\nIn a typical Coveo for Commerce solution, all listing pages should share the same searchHub/originLevel1 and be differentiated by setting this option to a unique, human-readable value.
When specified, this option sets the tab/originLevel2 parameter, as well as the listing property of the context/customData object of each query/usage analytics event originating from the listing page. This allows Coveo ML to provide relevant output for the listing page, and can also be useful for usage analytics reporting purposes.
Creates a new CommerceQuery component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean", "notSupportedIn": "", "comment": "The DidYouMean component is responsible for displaying query corrections. If this component is in the page and the\nquery returns no result but finds a possible query correction, the component either suggests the correction or\nautomatically triggers a new query with the suggested term.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "DidYouMean.options.enableAutoCorrection", "notSupportedIn": "", "comment": "Specifies whether the DidYouMean component automatically triggers a new query when a query returns no result and\na possible correction is available.\nDefault value is true.
Creates a new DidYouMean component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources", "notSupportedIn": "", "comment": "The DistanceResources component defines a field that computes the distance according to the current position of the\nend user.\nComponents relying on the current distance should be disabled until this component successfully provides a distance.
See also DistanceEvents.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.options", "notSupportedIn": "", "comment": "The possible options for a DistanceResources.
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceResources.options.cancelQueryUntilPositionResolved", "notSupportedIn": "", "comment": "Whether to cancel all the queries until the DistanceResources component successfully resolves a position.\nDefault value is true
The CSS class for components that need to be re-enabled when the DistanceResources component successfully\nprovides a distance.\nDefault value is coveo-distance-disabled.
Specifies the name of the field in which to store the distance value.\nSpecifying a value for this option is required for the DistanceResources component to work.
The API key to use to request the Google API geolocation service.\nIf you do not specify a value for this option, the DistanceResources component does not try to request the\nservice.
Specifies the name of the field that contains the latitude value.\nNote:
\n\n\nThe field you specify for this option must be an existing numerical field in your index (see\nAdding and Managing Fields. Otherwise, your query responses\nwill contain a
\nQueryExceptionInvalidQueryFunctionFieldor QueryExceptionInvalidQueryFunctionFieldType`\nexception, and the DistanceResources component will be unable to evaluate distances.
Specifying a value for this option is required for the DistanceResources component to work.
The latitude to use if no other position was provided.\nNote:
\n\n\n", "type": "number", "constrainedValues": [], "miscAttributes": { "float": "true" } }, { "name": "DistanceResources.options.longitudeField", "notSupportedIn": "", "comment": "You must also specify a
\nlongitudeValueif you specify a\nlatitudeValue.
Specifies the name of the field that contains the longitude value.\nNote:
\n\n\nThe field you specify for this option must be an existing numerical field in your index (see\nAdding and Managing Fields. Otherwise, your query responses\nwill contain a
\nQueryExceptionInvalidQueryFunctionFieldor QueryExceptionInvalidQueryFunctionFieldType`\nexception, and the DistanceResources component will be unable to evaluate distances.
Specifying a value for this option is required for the DistanceResources component to work.
The longitude to use if no other position was provided.\nNote:
\n\n\n", "type": "number", "constrainedValues": [], "miscAttributes": { "float": "true" } }, { "name": "DistanceResources.options.triggerNewQueryOnNewPosition", "notSupportedIn": "", "comment": "You must also specify a
\nlatitudeValueif you specify a\nlongitudeValue.
Whether to execute a new query when the DistanceResources component successfully provides a new position.\nDefault value is false.
The conversion factor to apply to the base distance unit (meter).\nNote:
\n\n\n\n
\n- If you want to convert distances to kilometers, you should set the
\nunitConversionFactorto1000.- If you want to convert distance to miles, you should set the
\nunitConversionFactorto1610(one mile is\napproximately equal to 1610 meters).
Default value is 1000.
Whether to request the geolocation service of the web browser.\nIf not defined, will not try to request the service.
\nNote:
\n\n\nRecent web browsers typically require a site to be in HTTPS to enable their geolocation service.
\n
If you do not specify a value for this option, the DistanceResources component does not try to request the\nservice.
Creates a new DistanceResources component.
The DynamicFacet component displays a facet of the results for the current query. A facet is a list of values for a\ncertain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).\nThe list of values is obtained using an array of FacetRequest operations performed at the same time\nas the main query.
The DynamicFacet component allows the end-user to drill down inside a result set by restricting the result to certain\nfield values.
This facet is more easy to use than the original Facet component. It implements additional Coveo Machine Learning (Coveo ML) features\nsuch as dynamic navigation experience (DNE).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.options", "notSupportedIn": "", "comment": "The options for the DynamicFacet
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.options.collapsedByDefault", "notSupportedIn": "", "comment": "Whether this facet should be collapsed by default.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "depend": "enableCollapse", "defaultValue": "false" } }, { "name": "DynamicFacet.options.customSort", "notSupportedIn": "", "comment": "Specifies a custom order by which to sort the dynamic facet values.\nCustom-ordered values won't necessarily retrieve values from the index.
\nExample:
\nYou could use this option to specify a logical order for support tickets, such as:
\n<div class=\"CoveoDynamicFacet\" data-field=\"@ticketstatus\" data-title=\"Ticket Status\" data-tab=\"All\" data-custom-sort=\"New,Opened,Feedback,Resolved\"></div>\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacet.options.dependsOn", "notSupportedIn": "", "comment": "The
\nDynamicFacetRangecomponent does not support this option.
The id of another facet in which at least one value must be selected in order for the dependent facet to be visible.\nBy default, the facet does not depend on any other facet to be displayed.
A function that verifies whether the current state of the dependsOn facet allows the dependent facet to be displayed.\nIf specified, the function receives a reference to the resolved dependsOn facet component instance as an argument, and must return a boolean.\nThe 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.
Whether to allow the end-user to expand and collapse this facet.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "true" } }, { "name": "DynamicFacet.options.enableFacetSearch", "notSupportedIn": "", "comment": "Whether to allow the end-user to search the facet values.\nNote: The DynamicFacetRange component does not support this option.
By default, the following behavior applies:
\nWhether to enable the Show more and Show less buttons in the facet.\nNote: The DynamicFacetRange component does not support this option.
Whether to scroll back to the top of the page whenever the end-user interacts with the facet.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "true" } }, { "name": "DynamicFacet.options.field", "notSupportedIn": "", "comment": "The name of the field on which to base this facet.\nThe field must of the string type.
Must be prefixed by @, and must reference an existing field whose\nFacet option is enabled.
Whether to exclude folded result parents when estimating result counts for facet values.\nNote: The target folding field must be a facet field with the Use cache for nested queries options enabled (see Add or Edit a Field).
\nSee also the Folding and FoldingForThread components.
Default: true.
The heading level to use for the heading above the facet.\nA value of 0 will render a div element instead.
Default: 2.
The unique identifier for this facet.\nAmong other things, this is used to record and read the facet\nstate in the URL fragment identifier (see the\nenableHistory SearchInterface\noption).
Tip: When several facets in a given search interface are based on\nthe same field, ensure that each of those facets has a distinct id.
If specified, must contain between 1 and 60 characters.\nOnly alphanumeric (A-Za-z0-9), underscore (_), and hyphen (-) characters are kept; other characters are automatically removed.
\nDefaults to the field option value.
Whether to notify the Breadcrumb component when toggling values in the facet.\nSee also the numberOfValuesInBreadcrumb option.
The number of items to scan for facet values.\nSetting this option to a higher value may enhance the accuracy of facet value counts at the cost of slower query performance.
\n", "type": "number", "constrainedValues": [], "miscAttributes": { "min": "1000", "defaultValue": "1000" } }, { "name": "DynamicFacet.options.numberOfValues", "notSupportedIn": "", "comment": "The number of values to request for this facet.\nAlso determines the default maximum number of additional values to request each time this facet is expanded,\nand the maximum number of values to display when this facet is collapsed (see the enableCollapse option).
The maximum number of selected values the Breadcrumb component can display before outputting a N more... link for the facet.
The sort criterion to use for this facet.\nSee FacetSortCriteria for the list and\ndescription of allowed values.
By default, the following behavior applies:
\nnumberOfValues\nis greater than or equal to the currently displayed number of values,\nthe alphanumeric criterion is\nused.numberOfValues is less than the currently displayed\nnumber of values and the facet is not currently expanded, the score\ncriterion is used.alphanumeric criterion is used.The title to display for this facet.\nDefaults to the localized string for NoTitle.
Whether to prepend facet search queries with a wildcard.\nNote: The DynamicFacetRange component does not support this option.
A mapping of facet values to their desired captions.\nNote: The DynamicFacetRange component does not support this option.
Creates a new DynamicFacet instance.
The DynamicFacetManager component is meant to be a parent for multiple DynamicFacet & DynamicFacetRange components.\nThis component allows controlling a set of DynamicFacet and DynamicFacetRange as a group.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.options", "notSupportedIn": "", "comment": "The options for the DynamicFacetManager
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.options.compareFacets", "notSupportedIn": "", "comment": "A custom sort function to execute on facets on every successful query response @externaldocs Using Custom Dynamic Facet Sort Functions.\nNote:
\n\n\n", "type": "IDynamicFacetManagerCompareFacet", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.options.enableReorder", "notSupportedIn": "", "comment": "If specified, the function must implement the JavaScript compareFunction (see Array.prototype.sort.\nYou cannot set this option directly in the component markup as an HTML attribute. You must either set it in the\n
\ninitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Whether to allow the reordering of facets based on Coveo ML and index ranking scores.\nDefault: true
The maximum number of expanded facets inside the manager.\nRemaining facets are collapsed.\nNote:\nPrioritizes facets with active values, and then prioritizes first facets.\nIf 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.
A function to execute whenever facets are updated in the query response @externaldocs Defining Custom Dynamic Facet Behaviors.\nNote:
\n\n\n", "type": "IDynamicFacetManagerOnUpdate", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetManager.constructor", "notSupportedIn": "", "comment": "You cannot set this option directly in the component markup as an HTML attribute. You must either set it in the\n
\ninitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Creates a new DynamicFacetManager instance.
A DynamicFacetRange is a facet whose values are expressed as ranges.\nYou must set the field option to a value targeting a numeric or date field\nin your index for this component to work.
This component extends the DynamicFacet component and supports all DynamicFacet options except:
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.options", "notSupportedIn": "", "comment": "The options for the DynamicFacetRange
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.options.currencySymbol", "notSupportedIn": "", "comment": "The currency symbol to use if the valueFormat is currency.\nBy default, the component uses the currency associated with the currently loaded culture file (see Changing the Language of Your Search Interface).
The number of decimals to display when the valueFormat is number\nBy default, the number of decimals is what's returned by the index.
The list of range values to request (see Requesting Specific FacetRange Values).\nThis value will override the numberOfValues value.
If this option is not defined, the index will try to generate automatic ranges.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRange.options.sortOrder", "notSupportedIn": "", "comment": "The sort order to use for this facet.\nCan be either ascending or descending.
Default: ascending.
The string format to apply to the minimum and maximum value of each range displayed in the facet.\nSee DynamicFacetRangeValueFormat for the list and\ndescription of allowed formats.
Default: If the field contains "date", the format will be date.\nElse, it will be number.
The label to insert between the minimum and maximum value of each range displayed in the facet.\nDefault: The localized string for to.
Creates a new DynamicFacetRange instance.
The DynamicHierarchicalFacet component is a facet that renders values in a hierarchical fashion. It determines the filter to apply depending on the\nselected path of values.\nThis facet requires a field with a special format to work correctly.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.options", "notSupportedIn": "", "comment": "The options for the DynamicHierarchicalFacet
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.options.basePath", "notSupportedIn": "", "comment": "The base path shared by all values to display in the hierarchical facet.\nIf you set this option, the specified base path will always be active on the facet.
\nThis implies that:
\nThe label to display to clear the facet when a value is selected.\nDefault value is the localized string for AllCategories.
Whether this facet should be collapsed by default.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "depend": "enableCollapse", "defaultValue": "false" } }, { "name": "DynamicHierarchicalFacet.options.customSort", "notSupportedIn": "", "comment": "Specifies a custom order by which to sort the dynamic hierarchical facet values.\nCustom-ordered values won't necessarily retrieve values from the index.
\nExample:
\n<div\n class=\"CoveoDynamicHierarchicalFacet\"\n data-field=\"@countries\"\n data-title=\"Countries\"\n data-tab=\"All\"\n data-clear-label=\"All Countries\"\n data-delimiting-character=\"|\"\n data-custom-sort=\"America, Asia|Japan, America|Mexico, America|Canada, Europe|Germany, Europe|France, Oceania\"\n></div>\nIf a custom sort is defined, this specifies the delimiter that separates paths from each other.\n*Example:**
\n<div\n class=\"CoveoDynamicHierarchicalFacet\"\n data-field=\"@countries\"\n data-title=\"Countries\"\n data-tab=\"All\"\n data-clear-label=\"All Countries\"\n data-delimiting-character=\"|\"\n data-custom-sort=\"America...Asia|Japan...America|Mexico...America|Canada...Europe|Germany...Europe|France...Oceania\"\n data-custom-sort-delimiting-character=\"...\"\n></div>\nThe character that specifies the hierarchical dependency.\nExample:
\nIf your field has the following values:
\nelectronics; electronics>laptops; electronics>laptops>gaming;
The delimiting character is >.
The id option value of another facet in which at least one value must be selected in order\nfor the dependent hierarchical facet to be visible.\nDefault: undefined and the hierarchical facet does not depend on any other facet to be displayed.
A function that verifies whether the current state of the dependsOn facet allows the dependent facet to be displayed.\nIf specified, the function receives a reference to the resolved dependsOn facet component instance as an argument, and must return a boolean.\nThe 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.
Whether to allow the end-user to expand and collapse this facet.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "true" } }, { "name": "DynamicHierarchicalFacet.options.enableFacetSearch", "notSupportedIn": "", "comment": "Whether to allow the end-user to search the facet values.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "DynamicHierarchicalFacet.options.enableMoreLess", "notSupportedIn": "", "comment": "Whether to enable the More and Less buttons in the Facet.\nSee also the numberOfValues option.
Whether to scroll back to the top of the page whenever the end-user interacts with a facet.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "true" } }, { "name": "DynamicHierarchicalFacet.options.field", "notSupportedIn": "", "comment": "The index field whose values the facet should use. The field values should have the form:\nthe; the|path; the|path|to; the|path|to|given; the|path|to|given|item;\nwhere the delimiting character is |. This default delimiting character can be changed using the delimitingCharacter option.\nTo help you verify whether your fields are setup correctly, use the debugInfo method.
Whether to exclude folded result parents when estimating result counts for facet values.\nNote: The target folding field must be a facet field with the Use cache for nested queries options enabled (see Add or Edit a Field).
\nSee also the Folding and FoldingForThread components.
Default: true.
The heading level to use for the heading above the facet.\nA value of 0 will render a div element instead.
Default: 2.
A unique identifier for the facet. Among other things, this identifier serves the purpose of saving\nthe facet state in the URL hash.\nIf you have two facets with the same field on the same page, you should specify an id value for at least one of\nthose two facets. This id must be unique among the facets.
Default value is the field option value.
Whether to notify the Breadcrumb component when toggling values in the facet.
The number of items to scan for facet values.\nSetting this option to a higher value may enhance the accuracy of facet value counts at the cost of slower query performance.
\n", "type": "number", "constrainedValues": [], "miscAttributes": { "min": "1000", "defaultValue": "1000" } }, { "name": "DynamicHierarchicalFacet.options.numberOfValues", "notSupportedIn": "", "comment": "The maximum number of field values to display by default in the facet before the user\nclicks the arrow to show more.\nSee also the enableMoreLess option.
The sort criterion to use for this facet.\nDefault (Search API): occurrences.
The title to display at the top of the facet.\nDefault value is the localized string for NoTitle.
A mapping of facet values to their desired captions.
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicHierarchicalFacet.constructor", "notSupportedIn": "", "comment": "Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The ErrorReport component takes care of handling fatal error when doing a query on the index / Search API.\nFor example, the ErrorReport component displays a message when the service responds with a 401 or 503 error. This\ncomponent also renders a small text area with the JSON content of the error response, for debugging purposes.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ErrorReport.options.showDetailedError", "notSupportedIn": "", "comment": "Specifies whether to display a detailed error message as a JSON in a text content area.\nDefault value is true.
Creates a new ErrorReport component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt", "notSupportedIn": "", "comment": "The Excerpt component renders an excerpt of its associated result and highlights the keywords from the query using\nthe appropriate template helpers.\nThis component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Excerpt.constructor", "notSupportedIn": "", "comment": "Creates a new Excerpt component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel", "notSupportedIn": "", "comment": "The ExportToExcel component renders an item in the Settings menu to allow the end user to export the current\nsearch results to the Microsoft Excel format (.xlsx).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.options", "notSupportedIn": "", "comment": "The options for the ExportToExcel
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExportToExcel.options.fieldsToInclude", "notSupportedIn": "", "comment": "Specifies the fields to include in the CSV output.\nNote that this does not affect top level properties such as the title, clickUri, printableUri and sysUri, for example.
\nDefault value is undefined, meaning all fields will be exported.
Specifies the number of results to include in the resulting Excel file.\nGenerating and downloading the Excel file should take a reasonably short amount of time when using the default\nvalue. However, this amount of time will increase exponentially as you set the value higher.
\nConsequently, you should avoid setting this value above the default index limit of 1000 search results.
\nNote that for HIPAA organizations, the export size limit is 5 MB, and for non-HIPAA organizations, the limit is 25 MB.
\nDefault value is 100. Minimum value is 1.
Creates a new ExportToExcel component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet", "notSupportedIn": "", "comment": "Note:
\n\n\nWe recommend using the simpler and more powerful
\nDynamicFacetcomponent instead.\nTheFacetcomponent displays a facet of the results for the current query. A facet is a list of values for a\ncertain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).
The list of values is obtained using a GroupByRequest operation performed at the same time\nas the main query.
The Facet component allows the end user to drill down inside a result set by restricting the result to certain\nfield values. It also allows filtering out values from the facet itself, and can provide a search box to look for\nspecific values inside larger sets.
This is probably the most complex component in the Coveo JavaScript Search Framework and as such, it allows for many\nconfiguration options.
\nSee also the FacetRange and TimespanFacet components (which\nextend this component), and the FacetSlider and CategoryFacet components (which do not extend this\ncomponent, but are very similar).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.facetSearch", "notSupportedIn": "", "comment": "Renders and handles the facet Search part of the component.
\n", "type": "FacetSearch", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.facetSettings", "notSupportedIn": "", "comment": "Renders and handles the facet Settings part of the component
\n", "type": "FacetSettings", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.options", "notSupportedIn": "", "comment": "The possible options for a facet
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.options.additionalFilter", "notSupportedIn": [ "salesforcefree" ], "comment": "Specifies an additional query expression (query override) to add to each\nGroupByRequest that this facet performs.\nExample: @date>=2014/01/01
Specifies an explicit list of allowedValues in the\nGroupByRequest.\nIf you specify a list of values for this option, the facet uses only these values (if they are available in\nthe current result set).
Example:
\nThe following facet only uses the Contact, Account, and File values of the @objecttype field. Even if the\ncurrent result set contains other @objecttype values, such as Message, or Product, the facet does not use\nthose other values.
\n<div class=\"CoveoFacet\" data-field=\"@objecttype\" data-title=\"Object Type\" data-tab=\"All\" data-allowed-values=\"Contact,Account,File\"></div>\nDefault value is undefined, and the facet uses all available values for its\nfield in the current result set.
If the enableSettings option is true, specifies the sort criteria\noptions to display in the facet Settings menu.\nPossible values are:
"occurrences""score""alphaascending""alphadescending""computedfieldascending""computedfielddescending""custom"See IGroupByRequest.sortCriteria for a description of each possible value.
\nNotes:
\n\n\n\n
\n- The
\nFacetRangecomponent does not support this option.
\n\n\n
\n- Using value captions will disable alphabetical sorts (see the valueCaption option).
\n
Default value is occurrences,score,alphaascending,alphadescending.
Specifies the name of a field on which to execute an aggregate operation for all distinct values of the facet\nfield.\nThe facet displays the result of the operation along with the number of occurrences for each value.
You can use this option to compute the sum of a field (like a money amount) for each listed facet value.
\nWorks in conjunction with the computedFieldOperation,\ncomputedFieldFormat, and\ncomputedFieldCaption options.
Specifies what the caption of the computedField should be in the facet\nSettings menu for sorting.\nFor example, setting this option to "Money" will display "Money Ascending" for computed field ascending.
Note:
\n\n\nThe
\nFacetRangecomponent does not support this option.
Default value is the localized string for ComputedField.
Specifies how to format the values resulting from a\ncomputedFieldOperation.\nThe Globalize library defines all available formats (see\nGlobalize).
The most commonly used formats are:
\nc0 - Formats the value as a currency.n0 - Formats the value as an integer.n2 - Formats the value as a floating point with 2 decimal digits.Default value is "c0".
Specifies the type of aggregate operation to perform on the computedField.\nThe possible values are:
sum - Computes the sum of the computed field values.average - Computes the average of the computed field values.minimum - Finds the minimum value of the computed field values.maximum - Finds the maximum value of the computed field values.Default value is sum.
Specifies a custom order by which to sort the facet values.\nExample:
\nYou could use this option to specify a logical order for support tickets, such as:
\n<div class=\"CoveoFacet\" data-field=\"@ticketstatus\" data-title=\"Ticket Status\" data-tab=\"All\" data-custom-sort=\"New,Opened,Feedback,Resolved\"></div>\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.options.dependsOn", "notSupportedIn": "", "comment": "The
\nFacetRangecomponent does not support this option.
Specifies whether this facet only appears when a value is selected in its "parent" facet.\nTo specify the parent facet, use its id.
Remember that by default, a facet id value is the same as its field option\nvalue.
Examples:
\nFirst case: the "parent" facet has no custom id:
<!-- \"Parent\" Facet: -->\n<div class='CoveoFacet' data-field='@myfield' data-title='My Parent Facet'></div>\n\n<!-- The \"dependent\" Facet must refer to the default `id` of its \"parent\" Facet, which is the name of its field. -->\n<div class='CoveoFacet' data-field='@myotherfield' data-title='My Dependent Facet' data-depends-on='@myfield'></div>\nSecond case: the "parent" facet has a custom id:
<!-- \"Parent\" Facet: -->\n<div class='CoveoFacet' data-field='@myfield' data-title='My Parent Facet' data-id='myParentCustomId'></div>\n\n<!-- The \"dependent\" Facet must refer to the custom `id` of its \"parent\" Facet, which is 'myParentCustomId'. -->\n<div class='CoveoFacet' data-field='@myotherfield' data-title='My Dependent Facet' data-depends-on='myParentCustomId'></div>\nDefault value is undefined
A function that verifies whether the current state of the dependsOn facet allows the dependent facet to be displayed.\nIf specified, the function receives a reference to the resolved dependsOn facet component instance as an argument, and must return a boolean.\nThe 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.
If the enableSettings option is true, specifies whether the\nCollapse \\ Expand menu option is available in the facet Settings menu.\nNote:
\n\nThe
\nFacetRangecomponent does not support this option.
Default value is true.
Specifies whether to display a search box at the bottom of the facet for searching among the available facet\nfield values.\nSee also the facetSearchDelay,\nfacetSearchIgnoreAccents, and\nnumberOfValuesInFacetSearch options.
Note:
\n\n\nThe
\nFacetRangecomponent does not support this option.
Default value is true.
Specifies whether to enable the More and Less buttons in the Facet.\nSee also the pageSize option.
Note:
\n\n\nThe
\nFacetRangecomponent does not support this option.
Default value is true.
Specifies whether to display the facet Settings menu.\nSee also the enableSettingsFacetState,\navailableSorts, and\nenableCollapse options.
Note:
\n\n\nThe
\nFacetRangecomponent does not support this option.
Default value is true.
If the enableSettings option is true, specifies whether the\nSave state menu option is available in the facet Settings menu.\nNote:
\n\nThe
\nFacetRangecomponent does not support this option.
Default value is false.
Specifies whether to allow the user to toggle between the OR and AND modes in the facet.\nSetting this option to true displays an icon in the top right corner of the facet. The user can click this icon\nto toggle between between the two modes.
Default value is false.
If the enableFacetSearch option is true, specifies the delay (in\nmilliseconds) before sending a search request to the server when the user starts typing in the facet search box.\nSpecifying a smaller value makes results appear faster. However, chances of having to cancel many requests\nsent to the server increase as the user keeps on typing new characters.
Note:
\n\n\nThe
\nFacetRangecomponent does not support this option.
Default value is 100. Minimum value is 0.
If the enableFacetSearch option is true, specifies whether to ignore\naccents in the facet search box.\nNote:
\n\nThe
\nFacetRangecomponent does not support this option.
Default value is false.
Specifies the index field whose values the facet should use.\nThe field must of the string type.
This requires the given field to be configured correctly in the index as a Facet field (see\nAdd or Edit Fields).
\nSpecifying a value for this option is required for the Facet component to work.
Specifies a unique identifier for the facet. Among other things, this identifier serves the purpose of saving\nthe facet state in the URL hash.\nIf you have two facets with the same field on the same page, you should specify an id value for at least one of\nthose two facets. This id must be unique among the facets.
Non-word characters except - @ $ _ . + ! ' ( ) , , ( `^a-zA-Z0-9-@$_.+!'(),,]+) are automatically removed from theid` value.
Default value is the field option value.
Specifies whether the facet should push data to the Breadcrumb component.\nSee also the numberOfValuesInBreadcrumb option.
Default value is true.
Specifies whether the Facet should push data to the Omnibox component.\nSee also Facet.options.numberOfValuesInOmnibox.
\nDefault value is false.
Specifies the injection depth to use for the GroupByRequest operation.\nThe injection depth determines how many results to scan in the index to ensure that the facet lists all potential\nfacet values. Increasing this value enhances the accuracy of the listed values at the cost of performance.
Default value is 1000. Minimum value is 1000.
Specifies whether the facet field is configured in the index as a multi-value\nfield (semicolon separated values such as abc;def;ghi).\nDefault value is false.
Specifies the field whose values the Facet should display.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.options.numberOfValues", "notSupportedIn": "", "comment": "Specifies the maximum number of field values to display by default in the facet before the user\nclicks the arrow to show more.\nSee also the enableMoreLess option.
If the includeInBreadcrumb option is true, specifies the maximum\nnumber of values that the facet should display in the Breadcrumb before outputting a\nmore... button.\nDefault value is 5 on a desktop computer and 3 on a mobile device. Minimum value is 0.
If the enableFacetSearch option is true, specifies the number of v\nalues to display in the facet search results popup.\nNote:
\n\nThe
\nFacetRangecomponent does not support this option.
Default value is 15. Minimum value is 1.
When Facet.options.includeInOmnibox is true, specifies the number of values to populate the\nBreadcrumb with.\nDefault value is 5 on desktop computer and 3 on a mobile device. Minimum value is 0.
Specifies the parent container of the facets.\nUsed by the preservePosition option.
Default value is element.parentElement.
If the enableMoreLess option is true, specifies the number of\nadditional results to fetch when clicking the More button.\nNote:
\n\nThe
\nFacetRangecomponent does not support this option.
Default value is 10. Minimum value is 1.
Specifies whether the facet should remain stable in its current position in the viewport while the mouse cursor\nis over it.\nWhenever the value selection changes in a facet, the search interface automatically performs a query. This new\nquery might cause other elements in the page to resize themselves (typically, other facets above or below the\none the user is interacting with).
\nThis option is responsible for adding the <div class='coveo-topSpace'> and\n<div class='coveo-bottomSpace'> around the Facet container. The Facet adjusts the scroll amount of the page to\nensure that it does not move relatively to the mouse when the results are updated.
In some cases, the facet also adds margins to the scrollContainer, if scrolling alone is not enough to\npreserve position.
See also the paddingContainer, and\nscrollContainer options.
Default value is true.
Specifies the HTML element (through a CSS selector) whose scroll amount the facet should adjust to preserve its\nposition when results are updated.\nUsed by the preservePosition option.
Default value is document.body.
Specifies the criteria to use to sort the facet values.\nSee IGroupByRequest.sortCriteria for the list and description of possible values.
\nDefault value is the first sort criteria specified in the availableSorts\noption, or occurrences if no sort criteria is specified.
Specifies the title to display at the top of the facet.\nDefault value is the localized string for NoTitle.
Specifies whether to use the AND operator in the resulting filter when multiple values are selected in the\nfacet.\nSetting this option to true means that items must have all of the selected values to match the resulting\nquery.
Default value is false, which means that the filter uses the OR operator. Thus, by default, items must\nhave at least one of the selected values to match the query.
Specifies whether wildcards are used as the allowedValuesPatternType\nin the groupBy for the facet search.\nEnabling this option returns results that end with the entered value. For example, searching for veo would match with Coveo.
Note:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "Facet.options.valueCaption", "notSupportedIn": "", "comment": "If you are experiencing slow facet search and/or timeouts when this option is set to
\ntrue, consider enabling the Use cache for nested queries\noption on your facet field in the Coveo Cloud Admninistration Console (see Add or Edit Fields)\">https://docs.coveo.com/en/1982/}).
Specifies a JSON object describing a mapping of facet values to their desired captions. See\nNormalizing Facet Value Captions.\nExamples:
\nYou can set the option in the 'init' call:
\nvar myValueCaptions = {\n \"txt\" : \"Text files\",\n \"html\" : \"Web page\",\n [ ... ]\n};\n\nCoveo.init(document.querySelector(\"#search\"), {\n Facet : {\n valueCaption : myValueCaptions\n }\n});\nOr before the init call, using the 'options' top-level function:
Coveo.options(document.querySelector(\"#search\"), {\n Facet : {\n valueCaption : myValueCaptions\n }\n});\nOr directly in the markup:
\n<!-- Ensure that the double quotes are properly handled in data-value-caption. -->\n<div class='CoveoFacet' data-field='@myotherfield' data-value-caption='{\"txt\":\"Text files\",\"html\":\"Web page\"}'></div>\nNote:
\n\n\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "Facet.constructor", "notSupportedIn": "", "comment": "Using value captions will disable alphabetical sorts (see the availableSorts option).
\n
Creates a new Facet component. Binds multiple query events as well.
A FacetRange is a facet whose values are expressed as ranges.\nYou must set the field option to a value targeting a numeric or date field in your index for this component to work.
This component extends the Facet component and supports all Facet options except:
enableMoreLesspageSizeAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.facetSearch", "notSupportedIn": "", "comment": "Renders and handles the facet Search part of the component.
\n", "type": "FacetSearch", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.facetSettings", "notSupportedIn": "", "comment": "Renders and handles the facet Settings part of the component
\n", "type": "FacetSettings", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.options.dateField", "notSupportedIn": "", "comment": "Whether the specified field option value targets a date field in your index.\nThis allows the component to correctly build the outgoing Group By.
Default: false.
The list of range values to request (see Requesting Specific FacetRange Values).\nBy default, the index automatically generates range values.
\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetRange.options.valueFormat", "notSupportedIn": "", "comment": "The index cannot automatically generate range values for a
\nFacetRangewhosefieldoption value references a dynamic field generated by a query function. In such a case, you must use therangesoption.
The format to apply to the range values. Only works for numeric values.\nSome of the most commonly used formats are:
\nc0: format a numeric value as currency.n0: formats a numeric value as an integer.n2: formats a numeric value as a floating point number with two decimal digits.The available formats are defined in the Globalize library.
\nNote: This option is ignored when the valueCaption is defined.
Creates a new FacetRange.
The FacetSlider component creates a facet which contains a slider widget that allows the end user to filter results\nbased on a range of numerical values (e.g., a date range, a price range, etc.).\nNote:
\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.bind", "notSupportedIn": "", "comment": "This component does not inherit from the
\nFacetcomponent. Consequently, it does not offer the\nsame configuration options. Moreover, some of theFacetSlideroptions (see\ngetStepsandvalueCaption)\ncannot be configured asdata-attributes in the markup. If you wish to configure those options, you must either\ndo so in theinitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.options", "notSupportedIn": "", "comment": "The component options
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.options.dateField", "notSupportedIn": "", "comment": "Specifies whether the field for which you are requesting a range is a date\nfield. This allows the FacetSlider to correctly build the outgoing GroupByRequest and\nrender itself properly.\nDefault value is false.
Specifies the format to use when displaying date values.\nSee also the dateField option.
Default value is MMM dd, yyyy.
Specifies the percentage caption options to use when displaying the field values.\nAvailable options are:
\ndata-display-as-percent-enable): boolean; specifies whether to display the caption as a percentage.\nDefault value is false.\nseparator (data-display-as-percent-separator): string; specifies the character(s) to use as a separator in the\ncaption. Default value is "-".Specifies the caption options to use when displaying the field values.\nAvailable options are:
\ndata-display-as-value-enable): boolean; specifies whether to display the caption as a value. Default\nvalue is true.data-display-as-value-unit-sign): string; specifies the unit sign for this value (e.g., $).\nDefault value is undefined.data-display-as-value-separator): string; specifies the character(s) to use as a separator in the\ncaption. Default value is "-".Specifies the ending boundary of the slider.\nDate values are rounded to the nearest year when you set the dateField\noption to true.
Default value is the highest available field value in the index.
\n", "type": "any", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.options.excludeOuterBounds", "notSupportedIn": "", "comment": "Specifies whether to exclude the outer bounds of the slider in the generated query when they are not active.\nDefault value is false.
Specifies the index field whose values the FacetSlider should use.\nThe field must be configured correctly as a Facet field in the index (see\nAdding and Managing Fields).
Specifying a value for this option is required for the FacetSlider component to work.
Specifies a function to generate the FacetSlider steps (see the steps\noption). This function receives the FacetSlider boundaries (see the start\nand end options), and must return an array of numbers (the steps).\nNote:
\n\nYou cannot set this option directly in the component markup as an HTML attribute. You must either set it in the\n
\ninitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Example:
\n\nvar myGetStepsFunction = function(start, end) {\n var result = [];\n for (i = start; i < end; i += 2) {\n result.push(i);\n }\n return result;\n}\n\n// You can set the option in the 'init' call:\nCoveo.init(document.querySelector(\"#search\"), {\n FacetSlider: {\n getSteps: myGetStepsFunction\n }\n});\n\n// Or before the 'init' call, using the 'options' top-level function:\n// Coveo.options(document.querySelector(\"#search\"), {\n// FacetSlider : {\n// valueCaption : myGetStepsFunction\n// }\n// });\nSpecifies whether to display a small graph on top of the slider.\nAvailable options are:
\ndata-graph-steps): number; specifies the number of steps/columns to display in your graph. Default\nvalue is 10. Minimum value is 2.Specifies a unique identifier for the FacetSlider. Among other things, this identifier serves the purpose of\nsaving the facet state in the URL hash.\nIf you have two facets with the same field in the same page, you should specify a unique id value for at least\none of those two facets. This id must be unique in the page.
Default value is the field option value.
Specifies a query to filter automatic minimum and maximum values for the slider range.\nThis is especially useful in the case of date ranges since the index may contain values which are not set, and\nthus return values from the year 1400 (the earliest date from the boost C++ library).
\nExample:
\nThe query override in the following markup filters out any @date value anterior to January 1st 2000.
<div class=\"CoveoFacetSlider\" data-field=\"@date\" data-date-field=\"true\" data-query-override=\"@date>2000/01/01\"></div>\nSpecifies whether you want a slider with two buttons instead of a slider with a single button.\nBy default, only one button appears in the slider.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.options.rounded", "notSupportedIn": "", "comment": "Specifies the number of decimal places to round the displayed numerical values to.\nDefault (and minimum) value is 0.
Specifies the starting boundary of the slider.\nDate values are rounded to the nearest year when you set the dateField\noption to true.
Default value is the lowest available field value in the index.
\n", "type": "any", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSlider.options.steps", "notSupportedIn": "", "comment": "Specifies the number of steps to split the slider into.\nFor example, if your range is [ 0 , 100 ] and you specify 10 steps, then the end user can move the slider only\nto the values [ 0, 10, 20, 30 ... , 100 ].
For performance reasons, the maximum value for this option is 100
Default value is undefined, and the slider allows up to 100 steps. Minimum value is 2.
Specifies the title to display on top of the FacetSlider.\nDefault value is the localized string for NoTitle.
Specifies a function to generate the value caption for the FacetSlider. This function receives the current\nslider values (number[]), and must return the caption (string).\nNote:
\n\nYou cannot set this option directly in the component markup as an HTML attribute. You must either set it in the\n
\ninitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Example:
\n\nvar myValueCaptionFunction = function(values) {\n return \"From \" + values[0] + \" to \" + values[1];\n}\n\n// You can set the option in the 'init' call:\nCoveo.init(document.querySelector(\"#search\"), {\n FacetSlider: {\n valueCaption: myValueCaptionFunction\n }\n});\n\n// Or before the 'init' call, using the 'options' top-level function:\n// Coveo.options(document.querySelector(\"#search\"), {\n// FacetSlider : {\n// valueCaption : myValueCaptionFunction\n// }\n// });\nCreates a new FacetSlider component. Binds multiple query events as well.
This component provides Omnibox query suggestions scoped to distinct categories based on the values of a\nspecific field whose Facet option is enabled.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueSuggestions.options.categoryFieldDelimitingCharacter", "notSupportedIn": "", "comment": "The delimiting character used for the multi-value field referenced by the field option.
Whether to display an estimate of the number of results for each scoped query suggestions.\nNotes:
\ntrue has no effect when the templateHelper options is set.An advanced query expression to add when requesting facet value suggestions.\nSet this option to ensure that the suggestions are properly scoped when using the component with a standalone search box. For instance, if a certain tab is automatically selected in the search interface the standalone search box is redirecting its queries to, you should set this option to that tab's expression.
The field on whose values the scoped query suggestions should be based.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "FacetValueSuggestions.options.isCategoryField", "notSupportedIn": "", "comment": "Whether the field option references a multi-value field.\nSetting this option to true if appropriate will allow the corresponding CategoryFacet or DynamicHierarchicalFacet component (if present) to properly handle the filter format.
See also the categoryFieldDelimitingCharacter option.
The maximum number of suggestions to render in the Omnibox.
The template helper function to execute when rendering each scoped query suggestion.\nIf specified, the function must have the following signature: (row: IFacetValueSuggestionRow, omnibox: Omnibox) => string
\nIf not specified, a default function will be used.
\nNote: You cannot set this option directly in the component markup as an HTML attribute. You must either set it:
\ninit call of your search interface (see Passing Component Options in the init Callinit call, using the options top-level function (see Passing Component Options Before the init Call).Example:
\nCoveo.init(document.getElementById('search'), {\n FacetValueSuggestions: {\n templateHelper: (row, omnibox) => { return `Searching for <strong>${row.keyword}</strong> in category <em>${row.value}</em>`; }\n }\n})\nWhether to get scoped query suggestions from the current Coveo ML query suggestions.\nNotes:
\ntrue, the enableQuerySuggestAddon option of the Omnibox component must be set to true as well.true, an additional POST HTTP request is sent to https://platform.cloud.coveo.com/rest/search/v2/querySuggest.Whether to get scoped query suggestions from the current user query entered in the search box.\nDefault: true if useQuerySuggestions is false; false otherwise
Creates a new FacetValueSuggestions component.
This component lets you customize the mobile responsive behavior of facets in your search interface.\nNotes:
\nAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.options.breakpoint", "notSupportedIn": "", "comment": "The screen width (in number of pixels) at which facets should enter mobile responsive mode and be collapsed under a single button.\nDefault: 800
Whether to display an overlay behind the facets when the end user expands them in mobile responsive mode.\nBy default, the following behavior applies:
\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileMode.options.isModal", "notSupportedIn": "", "comment": "Whether to display the facets in a modal instead of a pop-up when the end user expands them in mobile responsive mode.\nSet this option to false in order to keep the old behaviour.
Whether to disable vertical scrolling on the specified or resolved scrollContainer while facets are expanded in mobile responsive mode.\nBy default, the following behavior applies:
The HTML element whose vertical scrolling should be locked while facets are expanded in mobile responsive mode.\nBy default, the component tries to detect and use the first ancestor element whose CSS overflow-y attribute is set to scroll, starting from the FacetsMobileMode's element itself. If no such element is found, the document.body element is used.
Since this heuristic is not perfect, we strongly recommend that you manually set this option by explicitly specifying the desired CSS selector.
\nExample: data-scroll-container-selector='#someCssSelector'
Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The FieldSuggestions component provides query suggestions based on a particular facet field. For example, you could\nuse this component to provide auto-complete suggestions while the end user is typing the title of an item.\nThe query suggestions provided by this component appear in the Omnibox component.
Note: Consider providing Coveo ML query suggestions\nrather than field suggestions, as the former yields better performance and relevance.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldSuggestions.options.field", "notSupportedIn": "", "comment": "Specifies the facet field from which to provide suggestions.\nSpecifying a value for this option is required for the FieldSuggestions component to work.
Specifies the title of the result suggestions group in the Omnibox component.\nIf not provided, the component will simply not output any title.\nDefault value is null.
Specifies the number of suggestions to render in the Omnibox.\nDefault value is 5. Minimum value is 1.
Specifies the z-index position at which the suggestions render themselves in the Omnibox.\nWhen there are multiple suggestion providers, components with higher omniboxZIndex values render themselves\nfirst.
Default value is 51. Minimum value is 0.
Specifies the event handler function to execute when the end user selects a suggested value in the\nOmnibox. By default, the query box text is replaced by what the end user selected and a new\nquery is executed. You can, however, replace this default behavior by providing a callback function to execute\nwhen the value is selected.\nNote:
\n\nYou cannot set this option directly in the component markup as an HTML attribute. You must either set it in the\n
\ninitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Example:
\n\nvar myOnSelectFunction = function(selectedValue, populateOmniboxEventArgs) {\n\n // Close the suggestion list when the user clicks a suggestion.\n populateOmniboxEventArgs.closeOmnibox();\n\n // Search for matching title results in the default endpoint.\n Coveo.SearchEndpoint.endpoints[\"default\"].search({\n q: \"@title==\" + selectedValue\n }).done(function(results) {\n\n // If more than one result is found, select a result that matches the selected title.\n var foundResult = Coveo._.find(results.results, function(result) {\n return selectedValue == result.raw.title;\n });\n\n // Open the found result in the current window, or log an error.\n if (foundResult) {\n window.location = foundResult.clickUri;\n }\n else {\n new Coveo.Logger.warn(\"Selected suggested result '\" + selectedValue + \"' not found.\");\n }\n });\n};\n\n// You can set the option in the 'init' call:\nCoveo.init(document.querySelector(\"#search\"), {\n FieldSuggestions : {\n onSelect : myOnSelectFunction\n }\n});\n\n// Or before the 'init' call, using the 'options' top-level function:\n// Coveo.options(document.querySelector(\"#search\"), {\n// FieldSuggestions : {\n// onSelect : myOnSelectFunction\n// }\n// });\nSpecifies a query override to apply when retrieving suggestions. You can use any valid query expression (see\nCoveo Query Syntax Reference).\nDefault value is the empty string, and the component applies no query override.
\n", "type": "string", "constrainedValues": [], "miscAttributes": { "defaultValue": "" } }, { "name": "FieldSuggestions.constructor", "notSupportedIn": "", "comment": "Creates a new FieldSuggestions component.
The FieldTable component displays a set of FieldValue components in a table that can optionally be\nexpandable and minimizable. This component automatically takes care of not displaying empty field values.\nThis component is a result template component (see Result Templates).
\nExample:
\n// This is the FieldTable component itself, which holds a list of table rows.\n// Each row is a FieldValue component.\n<table class='CoveoFieldTable'>\n // Items\n <tr data-field='@sysdate' data-caption='Date' data-helper='dateTime' />\n <tr data-field='@sysauthor' data-caption='Author' />\n <tr data-field='@clickuri' data-html-value='true' data-caption='URL' data-helper='anchor' data-helper-options='{text: \\\"<%= raw.syssource %>\\\" , target:\\\"_blank\\\"}'>\n</table>\nAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldTable.options.allowMinimization", "notSupportedIn": "", "comment": "Specifies whether to allow the minimization (collapsing) of the FieldTable.\nIf you set this option to false, the component will not create the Minimize / Expand toggle links.
See also FieldTable.options.expandedTitle, FieldTable.options.minimizedTitle and\nFieldTable.options.minimizedByDefault.
\nDefault value is true.
If FieldTable.options.allowMinimization is true, specifies the caption to show on the Minimize link\n(the link that appears when the FieldTable is expanded).\nDefault value is "Details".
If FieldTable.options.allowMinimization is true, specifies whether to minimize the table by default.\nDefault value is undefined, and the FieldTable will collapse by default if the result it is associated with has\na non-empty excerpt.
If FieldTable.options.allowMinimization is true, specifies the caption to show on the Expand link\n(the link that appears when the FieldTable is minimized).\nDefault value is "Details".
Creates a new FieldTable.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue", "notSupportedIn": "", "comment": "The FieldValue component displays the value of a field associated to its parent search result. It is normally usable\nwithin a FieldTable.\nThis component is a result template component (see Result Templates).
\nA common use of this component is to display a specific field value which also happens to be an existing\nFacet.options.field. When the user clicks on the FieldValue component, it activates the corresponding Facet.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.options.conditions", "notSupportedIn": "", "comment": "A field-based condition that must be satisfied by the query result item for the component to be rendered.\nNote: This option uses a distinctive markup configuration syntax allowing multiple conditions to be expressed. Its underlying logic is the same as that of the field value conditions mechanism used by result templates.
\nExamples:\nRender the component if the query result item's @documenttype field value is Article or Documentation.
\n<div class=\"CoveoFieldValue\" data-field=\"@author\" data-condition-field-documenttype=\"Article, Documentation\"></div>\nRender the component if the query result item's @documenttype field value is anything but Case.
\n<div class=\"CoveoFieldValue\" data-field=\"@author\" data-condition-field-not-documenttype=\"Case\"></div>\nRender the component if the query result item's @documenttype field value is Article, and if its @author field value is anything but Anonymous.
\n<div class=\"CoveoFieldValue\" data-field=\"@author\" data-condition-field-documenttype=\"Article\" data-condition-field-not-author=\"Anonymous\"></div>\nDefault value is undefined.
If FieldValue.options.splitValues is true, specifies the string to use when displaying multi-value\nfields in the UI.\nThe component will insert this string between each value it displays from a multi-value field.
See also FieldValue.options.separator.
\nDefault value is ", ".
Specifies the Facet component to toggle when the end user clicks the FieldValue.\nDefault value is the value of FieldValue.options.field.
\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.options.field", "notSupportedIn": "", "comment": "If the target Facet.options.id is is not the same as its Facet.options.field), you must specify\nthis option manually in order to link to the correct Facet.
\n
Specifies the field that the FieldValue should display.\nSpecifying a value for this parameter is required in order for the FieldValue component to work.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true", "defaultValue": "@field" } }, { "name": "FieldValue.options.helper", "notSupportedIn": "", "comment": "Specifies the helper that the FieldValue should use to display its content.\nWhile several helpers exist by default (see ICoreHelpers), it is also possible for you to create your own\ncustom helpers (see TemplateHelpers).
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "FieldValue.options.helperOptions", "notSupportedIn": "", "comment": "Specifies the options to call on the specified helper.
\n", "type": "any", "constrainedValues": [], "miscAttributes": { "min": "0", "defaultValue": "true" } }, { "name": "FieldValue.options.htmlValue", "notSupportedIn": "", "comment": "Specifies whether the content to display is an HTML element.\nDefault value is false.
If FieldValue.options.splitValues is true, specifies the separator string which separates multi-value\nfields in the index.\nSee FieldValue.options.displaySeparator.
Default value is ";".
Specifies whether to split the FieldValue at each FieldValue.options.separator.\nThis is useful for splitting groups using a Facet.options.field.
\nWhen this option is true, the displayed values are split by the FieldValue.options.displaySeparator.
Default value is false.
Specifies a caption to display before the value.\nDefault value is undefined.
Creates a new FieldValue.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding", "notSupportedIn": "", "comment": "The Folding component makes it possible to render hierarchic representations of search results sharing a common\nfield.\nThis component has no visual impact on its own. It simply folds certain search results so that the\nResultFolding and ResultAttachments components can then nicely\nrender them within result templates (see Result Templates).
A typical use case of the Folding component is to fold email conversations and message board threads results in a\nresult set in order to display them in a convenient format. Messages belonging to a single conversation typically\nhave a unique conversation ID. By indexing this ID on a field, you can use it to fold search results (see\nFolding Results).
Note:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.bind", "notSupportedIn": "", "comment": "There can only be one
\nFoldingcomponent perTabcomponent.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options.child", "notSupportedIn": "", "comment": "Specifies the field that determines whether a certain result is a child of another top result.\nNote:
\n\n\nIn the index, the values of the corresponding field must:
\n\n
\n- Contain alphanumerical characters only.
\n- Contain no more than 60 characters.
\n
Default value is @foldingchild.
This option is deprecated. Instead, use the Folding.options.parent option.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options.enableExpand", "notSupportedIn": "", "comment": "Specifies whether to add a callback function on the top result, allowing to make an additional query to load all\nof its child results (e.g., to load all conversations of a given thread).\nConcretely, the ResultFolding component uses this for its Show More link.
See also the expandExpression and\nmaximumExpandedResults options.
Default value is true.
If the enableExpand option is true, specifies a custom constant\nexpression to send when querying the expanded results.\nDefault value is undefined.
Specifies the name of the field on which to do the folding.\nSpecifying a value for this option is required for this component to work.
\nNote:
\n\n\nIn an Elasticsearch index, the corresponding field must be configured as a Facet field\n(see Add or Edit Fields).\nThis limitation does not apply to Coveo indexes.
\n
Default value is @foldingcollection.
Specifies the function that manages the folding of all results.\nDefault value is:
\nCoveo.Folding.defaultGetMoreResults = function(results) {\n // The results are flat, just do the folding.\n return Coveo.Folding.foldWithParent(results);\n}\nSpecifies the function that manages the individual folding of each result.\nDefault value is:
\nvar results = result.childResults || [];\n// Add the top result at the top of the list.\nresults.unshift(result);\n// Empty childResults just to clean it.\nresult.childResults = [];\n// Fold those results.\nresults = Coveo.Folding.foldWithParent(results);\n// The first result is the top one.\nvar topResult = results.shift();\n// All other results are childResults.\ntopResult.childResults = results;\nreturn topResult;\nYou can pre-process all the result with this option in the init call of your search interface:
Coveo.init(document.querySelector('#search'), {\n Folding: {\n getResult: function(result) {\n result = Coveo.Folding.defaultGetResult(result);\n // Your code here\n }\n }\n})\nIf the enableExpand option is true, specifies the maximum number of\nresults to load when expanding.\nDefault value is 100. Minimum value is 1.
Specifies the field that determines whether a certain result is a top result containing other child results.\nNote:
\n\n\nIn the index, the values of the corresponding field must:
\n\n
\n- Contain alphanumerical characters only.
\n- Contain no more than 60 characters.
\n
Default value is @foldingparent.
This option is deprecated. Instead, use the Folding.options.child option.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options.range", "notSupportedIn": "", "comment": "Specifies the maximum number of child results to fold.\nExample:
\n\n\nFor an email thread with a total of 20 messages, using the default value of
\n2means that the component loads\nup to a maximum of 2 child messages under the original message, unless the end user expands the entire\nconversation using the Show More link (see theenableExpand\noption).
Default value is 2. Minimum value is 0.
Specifies the sort criteria to apply to the top result and its child results (e.g., date ascending,\n@myfield descending, etc.). See sortCriteria.\nThis option works from the results returned by the index. This means that if only the three most relevant folded results are returned by the index\nand you choose to rearrange the folded results by date, then the three most relevant results will be rearranged by date,\nmeaning that the first folded result is not necessarily the oldest or newest item.
However, since clicking on the Show More button triggers a new query, you would receive new results based on the sort criteria of this option.
Example
\n\n\nIf you are folding email results by conversation and you specify
\ndate descendingas therearrangevalue of\ntheFoldingcomponent, the component re-arranges email conversations so that the newest email is always the\ntop result. Specifyingdate ascendinginstead always makes the original email the top result, as it is also\nnecessarily the oldest.
By default, the component displays the results in the order that the index returns them.
\n", "type": "SortCriteria", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options.options.child", "notSupportedIn": "", "comment": "Specifies the field that determines whether a certain result is a child of another top result.\nNote:
\n\n\nIn the index, the values of the corresponding field must:
\n\n
\n- Contain alphanumerical characters only.
\n- Contain no more than 60 characters.
\n
Default value is @foldingchild.
This option is deprecated. Instead, use the Folding.options.parent option.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options.options.enableExpand", "notSupportedIn": "", "comment": "Specifies whether to add a callback function on the top result, allowing to make an additional query to load all\nof its child results (e.g., to load all conversations of a given thread).\nConcretely, the ResultFolding component uses this for its Show More link.
See also the expandExpression and\nmaximumExpandedResults options.
Default value is true.
If the enableExpand option is true, specifies a custom constant\nexpression to send when querying the expanded results.\nDefault value is undefined.
Specifies the name of the field on which to do the folding.\nSpecifying a value for this option is required for this component to work.
\nNote:
\n\n\nIn an Elasticsearch index, the corresponding field must be configured as a Facet field\n(see Add or Edit Fields).\nThis limitation does not apply to Coveo indexes.
\n
Default value is @foldingcollection.
Specifies the function that manages the folding of all results.\nDefault value is:
\nCoveo.Folding.defaultGetMoreResults = function(results) {\n // The results are flat, just do the folding.\n return Coveo.Folding.foldWithParent(results);\n}\nSpecifies the function that manages the individual folding of each result.\nDefault value is:
\nvar results = result.childResults || [];\n// Add the top result at the top of the list.\nresults.unshift(result);\n// Empty childResults just to clean it.\nresult.childResults = [];\n// Fold those results.\nresults = Coveo.Folding.foldWithParent(results);\n// The first result is the top one.\nvar topResult = results.shift();\n// All other results are childResults.\ntopResult.childResults = results;\nreturn topResult;\nYou can pre-process all the result with this option in the init call of your search interface:
Coveo.init(document.querySelector('#search'), {\n Folding: {\n getResult: function(result) {\n result = Coveo.Folding.defaultGetResult(result);\n // Your code here\n }\n }\n})\nIf the enableExpand option is true, specifies the maximum number of\nresults to load when expanding.\nDefault value is 100. Minimum value is 1.
Specifies the field that determines whether a certain result is a top result containing other child results.\nNote:
\n\n\nIn the index, the values of the corresponding field must:
\n\n
\n- Contain alphanumerical characters only.
\n- Contain no more than 60 characters.
\n
Default value is @foldingparent.
This option is deprecated. Instead, use the Folding.options.child option.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.options.options.range", "notSupportedIn": "", "comment": "Specifies the maximum number of child results to fold.\nExample:
\n\n\nFor an email thread with a total of 20 messages, using the default value of
\n2means that the component loads\nup to a maximum of 2 child messages under the original message, unless the end user expands the entire\nconversation using the Show More link (see theenableExpand\noption).
Default value is 2. Minimum value is 0.
Specifies the sort criteria to apply to the top result and its child results (e.g., date ascending,\n@myfield descending, etc.). See sortCriteria.\nThis option works from the results returned by the index. This means that if only the three most relevant folded results are returned by the index\nand you choose to rearrange the folded results by date, then the three most relevant results will be rearranged by date,\nmeaning that the first folded result is not necessarily the oldest or newest item.
However, since clicking on the Show More button triggers a new query, you would receive new results based on the sort criteria of this option.
Example
\n\n\nIf you are folding email results by conversation and you specify
\ndate descendingas therearrangevalue of\ntheFoldingcomponent, the component re-arranges email conversations so that the newest email is always the\ntop result. Specifyingdate ascendinginstead always makes the original email the top result, as it is also\nnecessarily the oldest.
By default, the component displays the results in the order that the index returns them.
\n", "type": "SortCriteria", "constrainedValues": [], "miscAttributes": {} }, { "name": "Folding.constructor", "notSupportedIn": "", "comment": "Creates a new Folding component.
The FollowItem component renders a widget that the end user can click to follow a particular item. A user following\nan item receives email notifications when the item changes.\nNote:
\n\n\nA SearchAlerts component must be present in the page for this component to work. It is also necessary to\nmeet certain requirements to be able to use this component (see\nDeploying Search Alerts on a Coveo JS Search Page).
\n
This component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.options", "notSupportedIn": "", "comment": "The options for the follow item component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "FollowItem.options.modifiedDateField", "notSupportedIn": "", "comment": "Specifies the ISubscriptionItemRequest.modifiedDateField to use when sending the\nISubscriptionItemRequest.\nDefault value is undefined.
Specifies the ISubscriptionItemRequest.watchedFields to use when sending the\nISubscriptionItemRequest.\nDefault value is undefined.
Creates a new FollowItem component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery", "notSupportedIn": "", "comment": "The HiddenQuery component handles a "hidden" query parameter (hq) and its description (hd).\nConcretely, this means that if a HiddenQuery component is present in your page and you load your search interface\nwith hq=foo&hd=bar in the URL hash, the component adds foo as an expression to the query (hq is the hidden\nquery) and renders bar in the Breadcrumb (hd is the hidden query description).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "HiddenQuery.options", "notSupportedIn": "", "comment": "Possible options for the HiddenQuery component
Specifies the maximum number of characters from the hidden query description (hd) to display in the\nBreadcrumb.\nBeyond this length, the HiddenQuery component slices the rest of the description and replaces it by ....
Default value is 100. Minimum value is 0.
Specifies the title that should appear in the Breadcrumb when the HiddenQuery populates it.\nDefault value is the localized string f\nor "Additional filters:"
Creates a new HiddenQuery component, which binds multiple events (QueryEvents.buildingQuery,\nBreadcrumbEvents.populateBreadcrumb and BreadcrumbEvents.clearBreadcrumb).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.facetSearch", "notSupportedIn": "", "comment": "Renders and handles the facet Search part of the component.
\n", "type": "FacetSearch", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.facetSettings", "notSupportedIn": "", "comment": "Renders and handles the facet Settings part of the component
\n", "type": "FacetSettings", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "HierarchicalFacet.options.delimitingCharacter", "notSupportedIn": "", "comment": "The character that allows to specify the hierarchical dependency.\nExample:
\nIf your field has the following values:
\n@field: c; c>folder2; c>folder2>folder3;
The delimiting character is >.
Default value is |.
Specifies at which level (0-based index) of the hierarchy the HierarchicalFacet should stop displaying its\nvalues.\nDefault value is undefined, which means the HierarchicalFacet component renders all hierarchical levels.\nMinimum value is 0.
Specifies at which level (0-based index) of the hierarchy the HierarchicalFacet should start displaying its\nvalues.\nExample:
If you have the following files indexed on a file system:
\nc:\\\n folder1\\\n text1.txt\n folder2\\\n folder3\\\n text2.txt\nSetting levelStart to 1 displays folder1 and folder2 in the HierarchicalFacet, but omits c:.
Default (and minimum) value is 0.
Specifies the margin (in pixels) to display between each hierarchical level when expanding.\nDefault value is 10.
Creates a new HierarchicalFacet component.
The Icon component outputs the corresponding icon for a given file type. The component searches for a suitable icon\nfrom those available in the Coveo JavaScript Search Framework. If the component finds no suitable icon, it instead\noutputs a generic icon.\nThis component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.options", "notSupportedIn": "", "comment": "The options for the Icon
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Icon.options.conditions", "notSupportedIn": "", "comment": "A field-based condition that must be satisfied by the query result item for the component to be rendered.\nNote: This option uses a distinctive markup configuration syntax allowing multiple conditions to be expressed. Its underlying logic is the same as that of the field value conditions mechanism used by result templates.
\nExamples:\nRender the component if the query result item's @documenttype field value is Article or Documentation.
\n<div class=\"CoveoIcon\" data-field=\"@author\" data-condition-field-documenttype=\"Article, Documentation\"></div>\nRender the component if the query result item's @documenttype field value is anything but Case.
\n<div class=\"CoveoIcon\" data-field=\"@author\" data-condition-field-not-documenttype=\"Case\"></div>\nRender the component if the query result item's @documenttype field value is Article, and if its @author field value is anything but Anonymous.
\n<div class=\"CoveoIcon\" data-field=\"@author\" data-condition-field-documenttype=\"Article\" data-condition-field-not-author=\"Anonymous\"></div>\nDefault value is undefined.
Specifies what text to display as the icon caption/label.\nDefault value is undefined, which means that the Coveo JavaScript Search Framework determines what text the icon\nneeds to display depending on the result file type.
Specifies whether the Icon component should output the smaller version of the icon instead of the regular one.\nDefault value is undefined.
Specifies the value that the Icon component should output as its CSS class instead of the auto-selected value.\nDefault value is undefined, which means that the Coveo JavaScript Search Framework outputs a suitable icon\ndepending on the result file type.
Specifies whether the Icon component should force the output icon to display its caption/label.\nNote:
\n\n\nDue to limited screen real estate, setting this option to
\ntruehas no effect on icons used inside Coveo for\nSalesforce Insight Panels.
Default value is undefined, which means that the Coveo JavaScript Search Framework determines whether the icon\nneeds to display a caption/label depending on the result file type.
Creates a new Icon component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue", "notSupportedIn": "", "comment": "This component renders an image from a URL retrieved in a given field.\nA typical use case of this component is to display product images in the context of commerce.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ImageFieldValue.options.field", "notSupportedIn": "", "comment": "Required. The name of a field whose value is the URL of the image to display.\nNote: The component uses the value of this field to set the src attribute of the img HTML tag it generates.
The height of the image (in pixels).\nNote: The component uses this value to set the height attribute of the img HTML tag it generates.
A template literal\nfrom which to generate the img tag's src attribute value.\nThis option overrides the field option value.
The template literal can reference any number of fields from the parent result. It can also reference global\nscope properties.
\nExamples:
\nsrc value such as http://uri.com?id=itemTitle:<a class='CoveoImageFieldValue' data-src-template='${clickUri}?id=${raw.title}'></a>\nsrc value such as localhost/fooBar:<a class='CoveoImageFieldValue' data-src-template='${window.location.hostname}/{Foo.Bar}'></a>\nDefault value is undefined.
The width of the image (in pixels).\nNote: The component uses this value to set the width attribute of the img HTML tag it generates.
Creates a new ImageFieldValue.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo", "notSupportedIn": "", "comment": "The Logo component adds a clickable Coveo logo in the search interface.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.options", "notSupportedIn": "", "comment": "The possible options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Logo.options.target", "notSupportedIn": "", "comment": "Specifies how the link to the Coveo website should be opened.\nValid values supported are _top, _blank, _self, _parent.
Default value is undefined, meaning standard browser behaviour for links will be respected.
Creates a new Logo component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix", "notSupportedIn": [ "salesforcefree" ], "comment": "The Matrix component uses the values of two fields (row and column) to display the results of the specified computed\nfield in a table.\nThe user specifies the values to use for the columns. An IGroupByRequest operation performed at the same time\nas the main query retrieves the values to use for the rows.
\nIn a way that is similar to the Facet component, selecting a Matrix cell allows the end user to drill down\ninside the results by restricting the row field and the column field to match the values of the selected cell.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.data", "notSupportedIn": "", "comment": "Holds the data for the Matrix.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.selectedColumnValue", "notSupportedIn": "", "comment": "The currently selected column value, or undefined if nothing is selected.
The currently selected row value, or undefined if nothing is selected.
The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.options", "notSupportedIn": "", "comment": "The possible options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.options.cellFontSize", "notSupportedIn": "", "comment": "Specifies the font-size to use for displaying text inside the cells.\nThis option is mainly useful to prevent a Matrix containing many columns from cropping some of its values.
\nHowever, instead of using this option to solve this kind of issue, you could also remove some of the less\nimportant columns from your Matrix or modify the CSS of your page to allow the Matrix to occupy a larger space.
\nDefault value is ''.
Specifies the field to use for the columns.\nSpecifying a value for this options is required for this component to work.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "Matrix.options.columnFieldValues", "notSupportedIn": "", "comment": "Specifies the field values to use for each column.\nSee also Matrix.options.columnLabels.
\nDefault value is [], which means that the Matrix will not generate any column (except the Total column, if\nMatrix.options.enableRowTotals is true).
Specifies the label for the first column on the left as a description of the Matrix.options.columnField.\nDefault value is undefined.
Specifies the label values to use for each column.\nDefault value is []. The array set for this options should match the Matrix.options.columnFieldValues.
Specifies the field whose computed values you want to display in the cells.\nSpecifying a value for this options is required for this component to work.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "Matrix.options.computedFieldFormat", "notSupportedIn": "", "comment": "Specifies how to format the values resulting from a Matrix.options.computedFieldOperation.\nThe Globalize library defines all available formats (see\nGlobalize).
\nThe most commonly used formats are:
\nc0 - Formats the value as a currency.n0 - Formats the value as an integer.n2 - Formats the value as a floating point with 2 decimal digits.Default value is c0.
Specifies the type of aggregate operation to perform on the Matrix.options.computedField.\nThe possible values are:
\nsum - Computes the sum of the computed field values.average - Computes the average of the computed field values.minimum - Finds the minimum value of the computed field values.maximum - Finds the maximum value of the computed field values.Default value is sum.
Specifies whether to add a Total row containing the total of each column.\nDefault value is true
Specifies whether to show a preview popup of cell results when hovering over a cell.\nSee also Matrix.options.previewSortCriteria, Matrix.options.previewMaxWidth,\nMatrix.options.previewMinWidth, Matrix.options.previewDelay and\nMatrix.options.previewTemplate.
\nDefault value is true.
Specifies whether to display a Total column containing the sum of each row.\nDefault value is true.
Specifies the maximum number of rows to display in the Matrix.\nDefault value is 10. Minimum value is 0.
Specifies the maximum number of results to include in the IGroupByRequest for the columns.\nThis value should always be greater than the Matrix.options.maximumNumberOfRows. If it is too small, some\nof the results will not be displayed in the Matrix.
\nDefault value is 100. Minimum value is 0.
If Matrix.options.enableHoverPreview is true, specifies the delay (in milliseconds) before sending the\nquery to get the preview results.\nDefault value is 500.
If Matrix.options.enableHoverPreview is true, specifies the maximum width (in pixels) of the preview\npopup.\nDefault value is 500px.
If Matrix.options.enableHoverPreview is true, specifies the minimum width (in pixels) of the preview\npopup.\nDefault value is 0.
If Matrix.options.enableHoverPreview is true, specifies the criteria to use for sorting the results of\nthe hover preview.\nThe available sort criteria values are the same as those of the IQuery.
The possible values are:
\nrelevancy: Uses all configured ranking weights and any specified ranking expressions to sort the results.dateascending / datedescending: Sorts the results using the @date field value, which is typically the\nlast modification date of an item in the index.qre: Sorts the results using only the weights applied by ranking expressions. Using qre is much like using\nrelevancy, except that qre does not compute automatic weights, such as weights based on keyword proximity.nosort: Does not sort the results. Using nosort returns the items in an essentially random order.fieldascending / fielddescending: Sorts the results using the value of a custom field.fieldascending / fielddescending: Sorts the results using the value of a custom field.See also Matrix.options.previewSortField.
\nDefault value is FieldDescending.
If Matrix.options.previewSortCriteria is fieldascending or fielddescending, specifies the field to\nuse for sorting the results of the hover preview.\nDefault value is the value of Matrix.options.computedField.
If Matrix.options.enableHoverPreview is true, specifies the template ID or CSS selector of the template\nto use to render the results of the hover preview.\nYou must use either data-template-id or data-template-selector in the markup to specify a value for this\noption.
Examples:
\nSpecifying what template to use by referring to its template ID:
\n<div class='CoveoMatrix' data-template-id='TemplateId'></div>\nSpecifying what template to use by referring to its CSS selector:
\n<div class='CoveoMatrix' data-template-selector='.templateSelector'></div>\nSpecifies the field to use for the rows.\nSpecifying a value for this options is required for this component to work.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "Matrix.options.sortCriteria", "notSupportedIn": "", "comment": "Specifies the criteria to use for sorting the rows.\nSee IGroupByRequest.sortCriteria for the list of possible values.
\nDefault value is computedfielddescending.
Specifies the text to display at the top of the Matrix.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "Matrix.constructor", "notSupportedIn": "", "comment": "Creates a new Matrix. Also verifies whether options are valid and coherent. Binds query events.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms", "notSupportedIn": "", "comment": "This result template component renders a list of query terms\nthat were not matched by the associated result item.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Returns all original basic query expression terms and phrases that were not matched by the result item the component instance is associated with.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.usageAnalytics", "notSupportedIn": "", "comment": "A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "MissingTerms.options.caption", "notSupportedIn": "", "comment": "The text to display before missing terms.\nDefault: The localized string for Missing.
Whether to allow the end-user to click a missing term to filter out items that do not match this term.\nDefault: true
The maximum number of missing term to be displayed\nDefault: 5\nMinimum value: 1
Creates a new MissingTerms component instance.
The Omnibox component extends the Querybox, and thus provides the same basic options and\nbehaviors. Furthermore, the Omnibox adds a type-ahead capability to the search input.\nYou can configure the type-ahead feature by enabling or disabling certain addons, which the Coveo JavaScript Search\nFramework provides out-of-the-box (see the enableFieldAddon,\nenableQueryExtension, and\nenableQuerySuggestAddon options).
Custom components and external code can also extend or customize the type-ahead feature and the query completion\nsuggestions it provides by attaching their own handlers to the\npopulateOmniboxSuggestions event.
See also the Searchbox component, which can automatically instantiate an Omnibox along with an\noptional SearchButton.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.options", "notSupportedIn": "", "comment": "The options for the omnibox
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.options.clearFiltersOnNewQuery", "notSupportedIn": "", "comment": "Whether to clear all active query filters when the end user submits a new query from the search box.\nNote: This does not include the filter expression enforced by the currently selected tab, if any.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "Omnibox.options.enableFieldAddon", "notSupportedIn": "", "comment": "The field addon makes the Omnibox highlight and complete field syntax. Setting this option to true automatically sets\nthe enableQuerySyntax option to true as a side effect.\nExample:
\n\nSuppose you want to search for PDF files. You start typing
\n@fin the search box. TheOmniboxprovides\nyou with several matching fields. You select the@filetypefield. Then, you start typing=pin the input.\nThis time, theOmniboxprovides you with several matching values for the@filetypefield. You select the\nenableQuerySyntaxoption is set totrue, the\nCoveo Search API interprets the basic expression as query syntax and returns the items whose@filetypefield\nmatches the
Default value is false.
If Querybox.options.enableQuerySyntax is true, specifies whether to enable the query extension addon.\nThe query extension addon allows the Omnibox to complete the syntax for query extensions.
Default value is false.
Whether to display Coveo Machine Learning (Coveo ML) query suggestions in the Omnibox.\nA Coveo ML query suggestions (QS) model must be properly configured in your Coveo Cloud organization, otherwise this\noption has no effect (see\nCreate a QS Model).
Note:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "true" } }, { "name": "Omnibox.options.enableQuerySyntax", "notSupportedIn": "", "comment": "When you set this option and the
\nenableSearchAsYouTypeoption\ntotrue, the query suggestion feature returns the auto-completion of the currently typed keyword as its first\nquery suggestion.
Specifies whether the Coveo Platform should try to interpret special query syntax such as field references in the\nquery that the user enters in the Querybox (see\nCoveo Query Syntax Reference).\nSetting this option to true also causes the query syntax in the Querybox to highlight.
Default value is false.
Whether to automatically trigger a new query whenever the end user types additional text in the search box input.\nSee also the searchAsYouTypeDelay option.
Note:
\n\n\nIf you set this option and the
\nenableQuerySuggestAddon\noption totrue, the query suggestion feature returns the auto-completion of the currently typed keyword as\nits first suggestion.
Default value is false.
Specifies whether query completion suggestions appearing in the Omnibox should push the result list and facets\ndown, rather than rendering themselves over them (and partially hiding them).\nSet this option as well as Omnibox.options.enableSearchAsYouType and\nOmnibox.options.enableQuerySuggestAddon to true for a cool effect!
Default value is false.
Specifies the number of suggestions that should appear in standard ML-powered query suggestions.\nThis option only affects the number of suggestions that appear with the Omnibox.options.enableQuerySuggestAddon option.
\nThis options does not affect the AnalyticsSuggestions or the FieldSuggestions component, which expose their own dedicated options for this parameter.
\nDefault value is 5.
Minimum value is 1.
Specifies a timeout (in milliseconds) before rejecting suggestions in the Omnibox.\nDefault value is 2000. Minimum value is 0.
Specifies a placeholder for the input.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "Omnibox.options.querySuggestCharacterThreshold", "notSupportedIn": "", "comment": "The minimum number of characters required in the in the text input before displaying available query suggestions when focus is on the component.\nNote: Only effective when enableQuerySuggestAddon is true.
\ndepend: 'enableQuerySuggestAddon'
\nDefault (and minimum): 0, meaning that trending query suggestions are displayed when focus is on the component, even if its text input is empty.
\n", "type": "number", "constrainedValues": [], "miscAttributes": { "min": "0", "defaultValue": "0" } }, { "name": "Omnibox.options.searchAsYouTypeDelay", "notSupportedIn": "", "comment": "If Omnibox.options.enableSearchAsYouType is true, specifies the delay (in milliseconds) before\ntriggering a new query when the end user types in the Omnibox.\nDefault value is 2000. Minimum value is 0.
Creates a new Omnibox component. Also enables necessary addons and binds events on various query events.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList", "notSupportedIn": "", "comment": "The OmniboxResultList component behaves exactly like the ResultList component (which it extends), except that\nit renders itself inside the Omnibox component.\nThis component can provide a kind of search-as-you-type functionality, allowing you to easily render complex Result\nTemplates inside the Omnibox component.
\nExample:
\n<div class=\"CoveoOmniboxResultList\">\n <script class=\"result-template\" type=\"text/x-underscore\"></script>\n</div>\nAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Specifies a list a css class that should be ignored when the end user click result in the omnibox\nAny element that is specified here should normally be able to handle the standard click event.
\nAny element that does not match this css class and that is clicked will trigger a redirection by the OmniboxResultList.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.usageAnalytics", "notSupportedIn": "", "comment": "A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxResultList.options.headerTitle", "notSupportedIn": "", "comment": "Specifies the title to use for this section.\nDefault value is the localized string for Suggested Results.
Specifies the z-index at which to render the ResultList inside the Omnibox.\nDefault value is 51. Minimum value is 16 (Facet components are at 50 by default)
Specifies the function to execute when the user selects a result suggestion.\nThe default function opens the corresponding result URI in the browser.
\nIt is only possible to specify a value for this option in the init call of your search interface. You\ncannot set it directly as an HTML attribute.
\nExample:
\n// You can call the init script using \"pure\" JavaScript:\nCoveo.init(document.querySelector('#search'), {\n OmniboxResultList : {\n //Close the omnibox, change the selected HTMLElement background color and alert the result title.\n onSelect : function(result, resultElement, omniBoxObject) {\n omniBoxObject.close();\n resultElement.css('background-color', 'red');\n alert(result.title);\n }\n }\n})\n\n// Or you can call the init script using the jQuery extension:\n$(\"#search\").coveo(\"init\", {\n OmniboxResultList : {\n //Close the Omnibox, change the selected HTMLElement background color and alert the result title.\n onSelect : function(result, resultElement, omniBoxObject) {\n omniBoxObject.close();\n resultElement.css('background-color', 'red');\n alert(result.title);\n }\n }\n})\nSpecifies the override to use on the query sent to the OmniboxResultList component.\nDefault value is undefined, which means no default override is specified.
Creates a new OmniboxResultList component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager", "notSupportedIn": "", "comment": "The Pager component attaches itself to a div element and renders widgets that allow the end user to navigate\nthrough the different result pages.\nThis component takes care of triggering a query with the correct result range whenever the end user selects a page or\nuses the navigation buttons (Previous and Next).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
The current page (1-based index).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.usageAnalytics", "notSupportedIn": "", "comment": "A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.options", "notSupportedIn": "", "comment": "The options for the Pager
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Pager.options.enableNavigationButton", "notSupportedIn": "", "comment": "Specifies whether the Previous and Next buttons should appear at each end of the pager when appropriate.\nThe default value is true.
Specifies the maximum number of pages to display if enough results are available.\nThis property is typically set when the default number of accessible results from the index has been changed from its default value of 1000 (10 results per page X 100 maxNumberOfPages).\nDefault value is 100
Specifies the maximum number of results that the index can return for any query.\nDefault value is 1000 in a Coveo index.
If this value was modified in your Coveo index, you must specify the new value in this option for the Pager component to work properly
\n", "type": "number", "constrainedValues": [], "miscAttributes": { "defaultValue": "1000" } }, { "name": "Pager.options.numberOfPages", "notSupportedIn": "", "comment": "Specifies how many page links to display in the pager.\nDefault value is 5 on a desktop computers and 3 on a mobile device. Minimum value is 1.
Creates a new Pager. Binds multiple query events (QueryEvents.newQuery, QueryEvents.buildingQuery,\nQueryEvents.querySuccess, QueryEvents.queryError and QueryEvents.noResults. Renders itself\non every query success.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext", "notSupportedIn": "", "comment": "The PipelineContext component injects custom contextual information into the search requests and usage analytics search events sent from a search interface.\nThis component is meant to be initialized on a script HTML tag whose type attribute is set to text/context and whose optional JSON content defines the custom information to send (each value can be set to a string or array of strings).
See Sending Custom Context Information.\nNote: To customize the context sent on all usage analytics events, see Sending Custom Metadata with Search, Click, or Custom Events.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PipelineContext.constructor", "notSupportedIn": "", "comment": "Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The PreferencesPanel component renders a Preferences item inside the Settings component which the end\nuser can click to access a panel from which it is possible to specify certain customization options for the search\ninterface. These customization options are then saved in the browser local storage.\nThis component should be used inside the Settings component.
\nSee also the ResultsFiltersPreferences and ResultsPreferences components.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PreferencesPanel.constructor", "notSupportedIn": "", "comment": "Creates a new PreferencesPanel.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri", "notSupportedIn": "", "comment": "The PrintableUri component inherits from the ResultLink component and supports all of its options.\nThis component displays the URI, or path, to access a result.
This component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PrintableUri.constructor", "notSupportedIn": "", "comment": "Creates a new PrintableUri.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge", "notSupportedIn": "", "comment": "Depending on its configuration, this component will render badges on query result items whose ranking scores were increased by featured results query pipeline rules and/or Coveo ML ART.\nThis component can be put anywhere in the markup configuration of a search interface. However, it is meant to be initialized only once, and should thus never be included in a result template.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "PromotedResultsBadge.options.captionForFeatured", "notSupportedIn": "", "comment": "The caption to show on the badge for results promoted by a featured results query pipeline rule.\nDefault value is the localized string for Featured.
The caption to show on the badge for results promoted by Coveo ML ART.\nDefault value is the localized string for Recommended.
The badge color for results promoted by a featured results query pipeline rule.\nCan be specified using:
\nDefault value is controlled through the default stylesheet of the framework.
\n", "type": "string", "constrainedValues": [], "miscAttributes": { "depend": "showBadgeForFeaturedResults" } }, { "name": "PromotedResultsBadge.options.colorForRecommendedResults", "notSupportedIn": "", "comment": "The badge color for results promoted by Coveo ML ART.\nCan be specified using:
\nDefault value is controlled through the default stylesheet of the framework.
\n", "type": "string", "constrainedValues": [], "miscAttributes": { "depend": "showBadgeForRecommendedResults" } }, { "name": "PromotedResultsBadge.options.showBadgeForFeaturedResults", "notSupportedIn": "", "comment": "Whether to show a badge when a result was promoted by a featured results query pipeline rule.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "true" } }, { "name": "PromotedResultsBadge.options.showBadgeForRecommendedResults", "notSupportedIn": "", "comment": "Whether to show a badge when a result was promoted by Coveo ML ART.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "PromotedResultsBadge.constructor", "notSupportedIn": "", "comment": "Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The QueryDuration component displays the duration of the last query execution.\nWhen a QueryEvents.querySuccess event is triggered, the QueryDuration component becomes visible. It also\ndisplays the global duration, the index duration, and the client duration in a single tooltip.
\nIf a QueryEvents.queryError event is triggered, the QueryDuration component becomes hidden.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryDuration.constructor", "notSupportedIn": "", "comment": "Creates a new QueryDuration component.\nBinds handlers on the QueryEvents.querySuccess and QueryEvents.queryError events.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview", "notSupportedIn": "", "comment": "This component renders previews of the top query results matching the currently focused query suggestion in the search box.\nAs such, this component only works when the search interface can\nprovide Coveo Machine Learning query suggestions.
\nThis component should be initialized on a div which can be nested anywhere inside the root element of your search interface.
See Rendering Query Suggestion Result Previews.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.options.executeQueryDelay", "notSupportedIn": "", "comment": "The amount of focus time (in milliseconds) required on a query suggestion before requesting a preview of its top results.
\n", "type": "number", "constrainedValues": [], "miscAttributes": { "defaultValue": "200" } }, { "name": "QuerySuggestPreview.options.numberOfPreviewResults", "notSupportedIn": "", "comment": "The maximum number of query results to render in the preview.
\n", "type": "number", "constrainedValues": [], "miscAttributes": { "min": "1", "max": "6", "defaultValue": "4" } }, { "name": "QuerySuggestPreview.options.resultTemplate", "notSupportedIn": "", "comment": "The HTML id attribute value, or CSS selector of the previously registered\nresult template to apply when rendering the\nquery suggestion result previews.\nExamples
id attribute of the target result template:<div class=\"CoveoQuerySuggestPreview\" data-result-template-id=\"myTemplateId\"></div>\n<div class=\"CoveoQuerySuggestPreview\" data-result-template-selector=\"#myTemplateId\"></div>\nIf you specify no previously registered template through this option, the component uses its default template.
\n", "type": "Template", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySuggestPreview.constructor", "notSupportedIn": "", "comment": "Creates a new QuerySuggestPreview component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary", "notSupportedIn": "", "comment": "The QuerySummary component can display information about the currently displayed range of results (e.g., "Results\n1-10 of 123").\nWhen the query does not match any items, the QuerySummary component can instead display information to the end users.
\nThe information displayed to the end user is customizable through this component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.options", "notSupportedIn": "", "comment": "Options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummary.options.enableCancelLastAction", "notSupportedIn": "", "comment": "Specifies whether to display the Cancel last action link when there are no search results.\nWhen clicked, the link restores the previous query that contained results.
Default value is true.
Specifies whether to display the QuerySummary.options.noResultsFoundMessage message when there are no search results.\nDefault value is true.
Specifies whether to display search tips when there are no search results.\nDefault value is true.
Specifies a custom message to display when there are no search results.\nYou can refer to the query the end user has entered using the ${query} query tag.
Example
\n\n\nFor the
\nnoResultFoundMessageoption, you enterThere were no results found for "${query}".\nYour end user searches forquery without results, which does not return any result.\nOn your page, they see this message:There were no results found for "query without results".
Default value is No results for ${query}.
Note
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": { "depend": "enableNoResultsFoundMessage" } }, { "name": "QuerySummary.options.onlyDisplaySearchTips", "notSupportedIn": "", "comment": "If there is no query, the value will fallback to
\nNo results.
Specifies whether to hide the number of returned results.\nWhen this option is set to true, the number of returned results will be hidden from the page, meaning that your end users will not know how many results were returned for their query.
\nDefault value is false.
Creates a new QuerySummary component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox", "notSupportedIn": "", "comment": "The Querybox component renders an input which the end user can interact with to enter and submit queries.\nWhen the end user submits a search request, the Querybox component triggers a query and logs the corresponding\nusage analytics data.
For technical reasons, it is necessary to instantiate this component on a div element rather than on an input\nelement.
See also the Searchbox component, which can automatically instantiate a Querybox along with an\noptional SearchButton component.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.options", "notSupportedIn": "", "comment": "The options for the Querybox.
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Querybox.options.enableLowercaseOperators", "notSupportedIn": "", "comment": "If the enableQuerySyntax option is true, specifies whether to\ninterpret the AND, NOT, OR, and NEAR keywords in the Querybox as query operators in the query, even if\nthe end user types those keywords in lowercase.\nThis option applies to all query operators (see\nCoveo Query Syntax Reference).
Example:
\n\n\nIf this option and the
\nenableQuerySyntaxoption are bothtrue, the Coveo Platform interprets thenear\nkeyword in a query such asservice center near meas theNEARquery operator (not as a query term).
\n\nOtherwise, if the
\nenableQuerySyntaxoption istrueand this option isfalse, the end user has to type the\nNEARkeyword in uppercase for the Coveo Platform to interpret it as a query operator.
Default value is false.
Whether to convert a basic expression containing at least a certain number of keywords (see the\npartialMatchKeywords option) to partial match expression, so\nthat items containing at least a certain number of those keywords (see the\npartialMatchThreshold option) will match the expression.\nNotes:
q) can be converted to a partial match expression.enableQuerySyntax option is set to true, this feature has no effect if the basic expression contains advanced query syntax (field expressions, operators, etc.).Specifies whether to interpret special query syntax (e.g., @objecttype=message) when the end user types\na query in the Querybox (see\nCoveo Query Syntax Reference). Setting this\noption to true also causes the Querybox to highlight any query syntax.\nRegardless of the value of this option, the Coveo Cloud REST Search API always interprets expressions surrounded\nby double quotes (") as exact phrase match requests.
See also enableLowercaseOperators.
Notes:
\n\n\n\n
\n- End user preferences can override the value you specify for this option.
\nIf the end user selects a value other than Automatic for the Enable query syntax setting (see\nthe
\nenableQuerySyntaxoption of the\nResultsPreferencescomponent), the end user preference takes precedence over this\noption.\n
\n- On-premises versions of the Coveo Search API require this option to be set to
\ntruein order to interpret\nexpressions surrounded by double quotes (") as exact phrase match requests.
Default value is false.
If enableWildcards is true, specifies whether to expand basic\nexpression keywords containing question mark characters (?) to the possible matching keywords in order to\nbroaden the query (see\nUsing Wildcards in Queries).\nNote:
\n\nIf you are using an on-premises version of the Coveo Search API, you also need to set the\n
\nenableQuerySyntaxoption totruein order to be able to set\nenableQuestionMarkstotrue.
Default value is false.
Whether to enable the search-as-you-type feature.\nNote: Enabling this feature can consume lots of queries per month (QPM), especially if the searchAsYouTypeDelay option is set to a low value.
Default value is false.
Specifies whether to expand basic expression keywords containing wildcards characters (*) to the possible\nmatching keywords in order to broaden the query (see\nUsing Wildcards in Queries).\nSee also enableQuestionMarks.
Note:
\n\n\nIf you are using an on-premises version of the Coveo Search API, you need to set the\n
\nenableQuerySyntaxoption totrueto be able to set\nenableWildcardstotrue.
Default value is false.
The minimum number of keywords that need to be present in the basic expression to convert it to a partial match expression.\nSee also the partialMatchThreshold option.
Notes:
\npartialMatchKeywords count.partialMatchKeywords count.An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the expression.\nSee also the partialMatchKeywords option.
Notes:
\npartialMatchThreshold.partialMatchThreshold does not yield a whole integer, the fractional part is truncated (e.g., 3.6 becomes 3).If the enableSearchAsYouType option is true, specifies how\nlong to wait (in milliseconds) between each key press before triggering a new query.\nDefault value is 50. Minimum value is 0
Whether to trigger a query when clearing the Querybox.\nDefault value is false.
Creates a new Querybox component. Creates a new Coveo.Magicbox instance and wraps the Magicbox methods\n(onblur, onsubmit etc.). Binds event on buildingQuery and before redirection (for standalone box).
The Quickview component renders a button/link which the end user can click to open a modal box containing certain\ninformation about a result. Most of the time, this component references a\nQuickviewDocument in its contentTemplate.\nNotes:
\n\n\n
\n- \n
Quickviewis not meant to replace a ResultLink to access an item; it has certain limitations (e.g., custom styles and embedded\nimages/links may not work as expected in aQuickview).- You can change the appearance of the
\nQuickviewlink/button by adding elements in the inner HTML of itsdiv.- You can change the content of the
\nQuickviewmodal box link by specifying a templateidor CSS selector (see\nthecontentTemplateoption).- When using Coveo for Salesforce 3.16, in an environment compliant with LockerService, ensure you use
\nCoveoSalesforceQuickview(see Changing the Default Quick View in Coveo for Salesforce).
Example:
\n[ ... ]\n\n<script class='result-template' type='text/underscore' id='myContentTemplateId'>\n <div>\n <span>This content will be displayed when then end user opens the quickview modal box. It could also include other Coveo component, and use core helpers.</span>\n <table class=\"CoveoFieldTable\">\n <tr data-field=\"@liboardshorttitle\" data-caption=\"Board\" />\n <tr data-field=\"@licategoryshorttitle\" data-caption=\"Category\" />\n <tr data-field=\"@sysauthor\" data-caption=\"Author\" />\n </table>\n </div>\n</script>\n\n[ ... ]\n\n<div class='CoveoResultList'>\n <script class='result-template' type='text/underscore' id='myResultTemplateId'></script>\n\n [ ... ]\n\n<!-- Note that simply including `<div class='CoveoQuickview'></div>` in the markup will be enough most of the time, since the component includes a default template and a default button appearance. -->\nThis component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.options.alwaysShow", "notSupportedIn": "", "comment": "Specifies whether to always show the Quickview button/link, even when the index body of an item is empty.\nIn such cases, the contentTemplate defines what appears in the\nQuickview modal box. Consequently, if there is no quickview for the item, you MUST specify a custom\ncontentTemplate, otherwise the component will throw an error when opened.
Default value is false.
Specifies a custom template to use when displaying content in the Quickview modal box.\nNote:
\n\nYou can use
\nCoreHelpersmethods in your content template.
You can specify a previously registered template to use either by referring to its HTML id attribute or to a\nCSS selector (see TemplateCache).
Example:
\nid attribute:<div class=\"CoveoQuickview\" data-template-id=\"myContentTemplateId\"></div>\n<div class='CoveoQuickview' data-template-selector=\".myContentTemplateSelector\"></div>\nIf you do not specify a custom content template, the component uses its default template.
\n", "type": "Template", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.options.enableLoadingAnimation", "notSupportedIn": "", "comment": "Specifies whether to enable the loading animation.\nSee also [loadingAnimation]{Quickview.options.loadingAnimation}.
Default value is true.
If enableLoadingAnimation is true, specifies a custom\nanimation to display while the content of the quickview modal window is loading. You can either specify the CSS\nselector of the HTML element you wish to display, or the id of a previously registered template (see\nTemplateCache).\nExamples:
<div class=\"CoveoQuickview\" data-loading-animation-selector=\".my-loading-animation\"></div>\nid of a previously registered template:<div class=\"CoveoQuickview\" data-loading-animation-template-id=\"my-loading-animation-template\"></div>\nBy default, the loading animation is a Coveo animation, which you can customize with CSS (see\nStyling the Coveo JavaScript Search Framework).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Quickview.options.showDate", "notSupportedIn": "", "comment": "Specifies whether to display the item date in the Quickview modal box header.\nDefault value is true.
Specifies the title that should appear in the Quickview modal box header.\nDefault value is undefined, which is equivalent to the empty string.
Specifies the emplacement of the tooltip in relation to the Quickview HTML element.\nExample:
\n\n", "type": "", "constrainedValues": [ "auto,auto-start,auto-end,top-start,top,top-end,right-start,right,right-end,bottom-end,bottom,bottom-start,left-end,left,left-start" ], "miscAttributes": { "defaultValue": "bottom" } }, { "name": "Quickview.constructor", "notSupportedIn": "", "comment": "Setting this option to
\ntop-startwill make the tooltip appear on top of theQuickviewbutton, aligned to the left.
Creates a new Quickview component.
The QuickviewDocument component normally exists within a Quickview component. The sole purpose\nof this component is to add an <iframe> which loads the correct HTML version of the current item.\nThe default contentTemplate of the\nQuickview component includes the QuickviewDocument component.
This component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewDocument.options.maximumDocumentSize", "notSupportedIn": "", "comment": "Specifies the maximum preview size that the index should return.\nDefault value is 0, and the index returns the entire preview. Minimum value is 0.
Creates a new QuickviewDocument component.
The Recommendation component is a SearchInterface that displays recommendations typically based on user\nhistory.\nThis component usually listens to the main SearchInterface. When the main SearchInterface generates a query, the\nRecommendation component generates another query to get the recommendations at the same time.
\nTo get history-based recommendations, you will likely want to include the pageview script in your page (see\ncoveo.analytics.js). However, including this script is not mandatory.\nFor instance, you could use the Recommendation component without the Coveo Machine Learning service to create a\nsimple "recommended people" interface.
It is possible to include this component inside another SearchInterface, but it is also possible to instantiate it as\na "standalone" search interface, without even instantiating a main SearchInterface component. In any case, a\nRecommendation component always acts as a full-fledged search interface. Therefore, you can include any component\ninside the Recommendation component (Searchbox, Facet, Sort, etc.), just as you would inside the main SearchInterface\ncomponent.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.getComponents", "notSupportedIn": "", "comment": "Gets all the components of a given type.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.responsiveComponents", "notSupportedIn": "", "comment": "Allows to get and set the different breakpoints for mobile and tablet devices.\nThis is useful, amongst other, for Facet, Tab and ResultList
\n", "type": "ResponsiveComponents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
The options for the recommendation component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.options.dropdownHeaderLabel", "notSupportedIn": "", "comment": "If Recommendation.options.enableResponsiveMode is true for all Recommendation components, specifies the\nlabel of the dropdown button that allows to display the Recommendation components when in responsive mode.\nIf more than one Recommendation component in the search interface specifies a value for this option, then the\nframework uses the first occurrence of the option.
Default value is Recommendations.
Specifies whether to enable responsive mode for Recommendation components. Setting this options to false on\nany Recommendation component in a search interface disables responsive mode for all other Recommendation\ncomponents in the search interface.\nResponsive mode displays all Recommendation components under a single dropdown button whenever the width of the\nHTML element which the search interface is bound to reaches or falls behind a certain threshold (see\nRecommendation.options.responsiveBreakpoint).
See also Recommendation.options.dropdownHeaderLabel.
\nDefault value is true.
Specifies whether to hide the Recommendations component if no result or recommendation is available.\nDefault value is true.
Specifies the ID of the interface.\nThe usage analytics use the interface ID to know which recommendation interface was selected.\nDefault value is Recommendation for the first one and Recommendation_{number}, where {number} depends on the\nnumber of Recommendation interfaces with default IDs in the page for the others.
Specifies the main SearchInterface to listen to.
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.options.optionsToUse", "notSupportedIn": "", "comment": "Specifies which options from the main QueryBuilder to use in the triggered query.\nPossible values are:
\nexpressionadvancedExpressionconstantExpressiondisjunctionExpressionExample:
\nAdding the expression (q) and the advanced expression (aq) parts of the main query in the triggered query:
data-options-to-use="expression,advancedExpression"
Default value is expression.
If Recommendation.options.enableResponsiveMode is true for all Recommendation components, specifies the\nwidth threshold (in pixels) of the search interface at which Recommendation components go in responsive mode.\nRecommendation components go in responsive mode when the width of the search interface is equal to or lower than\nthis value.
The search interface corresponds to the HTML element with the class CoveoSearchInterface.
If more than one Recommendation component in the search interface specifies a value for this option, then the\nframework uses the last occurrence of the option.
\nDefault value is 1000.
Specifies whether to send the actions history along with the triggered query.\nSetting this option to false makes it impossible for this component to get Coveo Machine Learning\nrecommendations.
However, setting this option to false can be useful to display side results in a search page.
Default value is true.
Specifies the user context to send to Coveo usage analytics.\nThe component sends this information with the query alongside the user history to get the recommendations.
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "Recommendation.constructor", "notSupportedIn": "", "comment": "Creates a new Recommendation component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu", "notSupportedIn": "", "comment": "The ResultActionsMenu component adds a floating result action menu, meant to be used inside result templates (see Result Templates).\nIt is designed to contain other components that can execute actions related to the result,\ntypically the Quickview and AttachToCase components, available in the Coveo for Salesforce and Coveo for Dynamics integrations.
\n<script type=\"text/html\" class=\"result-template\" [...]\n <div class=\"coveo-result-frame\">\n <div class=\"CoveoResultActionsMenu\">\n <div class=\"CoveoQuickview\"></div>\n </div>\n [...]\n</script>\nAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.menuItems", "notSupportedIn": "", "comment": "A list containing menu items for this menu.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.parentResult", "notSupportedIn": "", "comment": "The rendered result that contains this menu.
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultActionsMenu.options.openOnMouseOver", "notSupportedIn": "", "comment": "Specifies whether the menu should open when the user hovers over the result.\nWhen set to false, the menu opens only when clicking on the result.
\nDefault value is true.
Creates a new ResultActionsMenu component.
The ResultAttachments component renders attachments in a result set, for example when displaying emails. This\ncomponent is usable inside a result template when there is an active Folding component in the\npage.\nThis component is a result template component (see Result Templates).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.options.maximumAttachmentLevel", "notSupportedIn": "", "comment": "Specifies the maximum nesting depth. Beyond this depth, the component stops rendering sub-attachments.\nDefault value is 5. Minimum value is 0.
Specifies the template to use to render each attachment for a top result.\nYou can specify a previously registered template to use either by referring to its HTML id attribute or to a\nCSS selector (see TemplateCache).
Examples:
\nSpecifying a previously registered template by referring to its HTML id attribute:
<div class=\"CoveoResultAttachments\" data-result-template-id=\"Foo\"></div>\nSpecifying a previously registered template by referring to a CSS selector:
\n<div class='CoveoResultAttachments' data-result-template-selector=\".Foo\"></div>\nIf you do not specify a custom folding template, the component uses the default result attachment template.
\n", "type": "Template", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultAttachments.options.subResultTemplate", "notSupportedIn": "", "comment": "Specifies the template to use to render sub-attachments, which are attachments within attachments, for example\nwhen multiple files are embedded within a .zip attachment.\nSub-attachments can themselves contain sub-attachments, and so on up to a certain level (see the\nmaximumAttachmentLevel option).
You can specify a previously registered template to use either by referring to its HTML id attribute or to a\nCSS selector (see TemplateCache).
Example:
\nSpecifying a previously registered template by referring to its HTML id attribute:
<div class=\"CoveoResultAttachments\" data-sub-result-template-id=\"Foo\"></div>\nSpecifying a previously registered template by referring to a CSS selector:
\n<div class=\"CoveoResultAttachments\" data-sub-result-template-selector=\".Foo\"></div>\nBy default, this option uses the same template you specify for the\nresultTemplate option.
Creates a new ResultAttachments component.
The ResultFolding component renders folded result sets. It is usable inside a result template when there is an\nactive Folding component in the page. This component takes care of rendering the parent result and\nits child results in a coherent manner.\nThis component is a result template component (see Result Templates).
See Folding Results.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.options.expandedCaption", "notSupportedIn": "", "comment": "Specifies the caption to display at the top of the child results when the folding result set is expanded.\nDefault value is undefined, which displays no caption.
Specifies the caption to display on the link to shrink the loaded folding result set back to only the top result.\nDefault value is the localized string for ShowLess.
Specifies the caption to display on the link to expand / show child results.\nDefault value is the localized string for ShowMore.
Specifies the caption to display at the top of the child results when the folding result set is not expanded.\nDefault value is undefined, which displays no caption.
Specifies the caption to display when there is only one result in a folding result set.\nDefault value is the localized string for DisplayingTheOnlyMessage
Specifies the template to use to render each of the child results for a top result.\nYou can specify a previously registered template to use either by referring to its HTML id attribute or to a\nCSS selector (see TemplateCache).
Example:
\nSpecifying a previously registered template by referring to its HTML id attribute:
<span class=\"CoveoResultFolding\" data-result-template-id=\"Foo\"></span>\nSpecifying a previously registered template by referring to a CSS selector:
\n<span class='CoveoResultFolding' data-result-template-selector=\"#Foo\"></span>\nIf you do not specify a custom folding template, the component uses the default result folding template.
\n", "type": "Template", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultFolding.constructor", "notSupportedIn": "", "comment": "Creates a new ResultFolding component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector", "notSupportedIn": "", "comment": "The ResultLayoutSelector component allows the end user to switch between multiple ResultList components that have\ndifferent ResultList.options.layout values.\nThis component automatically populates itself with buttons to switch between the ResultList components that have a\nvalid layout value (see the ValidLayout type).
\nSee also the Result Layouts documentation.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.options", "notSupportedIn": "", "comment": "The component options
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLayoutSelector.options.desktopLayouts", "notSupportedIn": "", "comment": "Specifies the layouts that should be available when the search page is displayed in desktop mode.\nBy default, the desktop mode breakpoint is any screen size over 800 px.
\nTo change this default value, use the responsiveMediumBreakpoint option.
\nWhen the breakpoint is reached, layouts that are not specified becomes inactive and the linked result list will be disabled.
\nThe possible values for layouts are list, card, table.
The default value is list, card, table.
Specifies the layouts that should be available when the search page is displayed in mobile mode.\nBy default, the mobile mode breakpoint is at 480 px screen width.
\nTo change this default value, use the responsiveSmallBreakpoint option.
\nWhen the breakpoint is reached, layouts that are not specified becomes inactive and the linked result list will be disabled.
\nThe possible values for layouts are list, card, table.
The default value is card, table.
Specifies the layouts that should be available when the search page is displayed in tablet mode.\nBy default, the tablet mode breakpoint is at 800 px screen width.
\nTo change this default value, use the responsiveMediumBreakpoint option.
\nWhen the breakpoint is reached, layouts that are not specified becomes inactive and the linked result list will be disabled.
\nThe possible values for layouts are list, card, table.
The default value is list, card, table.
Creates a new ResultLayoutSelector component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink", "notSupportedIn": "", "comment": "The ResultLink component automatically transform a search result title into a clickable link pointing to the\noriginal item.\nThis component is a result template component (see Result Templates).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.options", "notSupportedIn": "", "comment": "The options for the ResultLink
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultLink.options.alwaysOpenInNewWindow", "notSupportedIn": "", "comment": "Specifies whether the component should open its link in a new window instead of opening it in the current\ncontext.\nIf this option is true, clicking the ResultLink calls the\nopenLinkInNewWindow method instead of the\nopenLink method.
Note:
\n\n\nIf a search page contains a
\nResultPreferencescomponent whose\nenableOpenInNewWindowoption istrue, and the end\nuser checks the Always open results in new window box,ResultLinkcomponents in this page will always\nopen their links in a new window when the end user clicks them, no matter what the value of their\nalwaysOpenInNewWindowoption is.
Default value is false.
Specifies the field to use to output the component href attribute value.\nTip:
\n\nInstead of specifying a value for the
\nfieldoption, you can directly add anhrefattribute to the\nResultLinkHTML element. Then, you can use a custom script to generate thehrefvalue.
Examples:
\nResultLink outputs its href value using the @uri field (rather than the\ndefault field):<a class=\"CoveoResultLink\" data-field=\"@uri\"></a>\ngetMyKBUri() function provides the href value:<script id=\"KnowledgeArticle\" type=\"text/underscore\" class=\"result-template\">\n <div class='CoveoIcon>'></div>\n <a class=\"CoveoResultLink\" href=\"<%= getMyKBUri(raw) %>\"></a>\n <div class=\"CoveoExcerpt\"></div>\n</script>\nSee also hrefTemplate, which can override this option.
By default, the component uses the @clickUri field of the item to output the value of its href attribute.
Specifies a template literal from which to generate the ResultLink href attribute value (see\nTemplate literals).\nThis option overrides the field option value.
The template literal can reference any number of fields from the parent result. It can also reference global\nscope properties.
\nExamples:
\nhref value such as http://uri.com?id=itemTitle:<a class='CoveoResultLink' data-href-template='${clickUri}?id=${raw.title}'></a>\nhref value such as localhost/fooBar:<a class='CoveoResultLink' data-href-template='${window.location.hostname}/{Foo.Bar}'></a>\nDefault value is undefined.
Specify this option to log additional analytics when this result link is pressed.\nExample:
\nconst resultLink = new Coveo.ResultLink(\n linkElement,\n {\n logAnalytics: (href) => Coveo.logCustomEvent(\n Coveo.analyticsActionCauseList.openSmartSnippetSource,\n {\n searchQueryUid: searchInterface.queryController.lastSearchUid,\n documentTitle: result.title,\n author: Utils.getFieldValue(result, 'author'),\n documentURL: href\n },\n element\n )\n },\n searchInterface.getBindings(),\n result\n)\nSpecifies an event handler function to execute when the user clicks the ResultLink component.\nThe handler function takes a JavaScript Event object and\nan IQueryResult as its parameters.
Overriding the default behavior of the onClick event can allow you to execute specific code instead.
Note:
\n\n\nYou cannot set this option directly in the component markup as an HTML attribute. You must either set it in the\n
\ninitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Example:
\n// You can set the option in the 'init' call:\nCoveo.init(document.querySelector(\"#search\"), {\n ResultLink : {\n onClick : function(e, result) {\n e.preventDefault();\n // Custom code to execute with the item URI and title.\n openUriInASpecialTab(result.clickUri, result.title);\n }\n }\n});\n\n// Or before the 'init' call, using the 'options' top-level function:\n// Coveo.options(document.querySelector('#search'), {\n// ResultLink : {\n// onClick : function(e, result) {\n// e.preventDefault();\n// // Custom code to execute with the item URI and title.\n// openUriInASpecialTab(result.clickUri, result.title);\n// }\n// }\n// });\nSpecifies whether the component should try to open its link in Microsoft Outlook.\nSetting this option to true is normally useful for ResultLink instances related to Microsoft Exchange emails.
If this option is true, clicking the ResultLink calls the\nopenLinkInOutlook method instead of the\nopenLink method.
Default value is false.
Specifies whether the component should open its link in the Quickview component rather than\nloading through the original URL.\nDefault value is false.
Specifies a template literal from which to generate the ResultLink display title (see\nTemplate literals).\nThis option overrides the default ResultLink display title behavior.
The template literal can reference any number of fields from the parent result. However, if the template literal\nreferences a key whose value is undefined in the parent result fields, the ResultLink title displays the\nname of this key instead.
This option is ignored if the ResultLink innerHTML contains any value.
Examples:
\nResultLink display title such as Case number: 123456 if both the\nraw.objecttype and raw.objectnumber keys are defined in the parent result fields:<a class=\"CoveoResultLink\" data-title-template=\"${raw.objecttype} number: ${raw.objectnumber}\"></a>\n${myField} as a ResultLink display title if the myField key is undefined\nin the parent result fields:<a class=\"CoveoResultLink\" data-title-template=\"${myField}\"></a>\nFoobar as a ResultLink display title, because the ResultLink innterHTML is\nnot empty:<a class=\"CoveoResultLink\" data-title-template=\"${will} ${be} ${ignored}\">Foobar</a>\nDefault value is undefined.
Creates a new ResultLink component.
The ResultList component is responsible for displaying query results by applying one or several result templates\n(see Result Templates).\nIt is possible to include multiple ResultList components along with a single ResultLayout\ncomponent in a search page to provide different result layouts (see\nResult Layouts).
This component supports infinite scrolling (see the\nenableInfiniteScroll option).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.options", "notSupportedIn": "", "comment": "The options for the ResultList
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultList.options.autoSelectFieldsToInclude", "notSupportedIn": "", "comment": "Whether the ResultList should scan its result templates to discover which fields it must request to\nbe able to render all results.\nSetting this option to true ensures that the Coveo Search API does not return fields that are unnecessary for\nthe UI to function.
If you set this option to true, the fields referenced in your result folding templates won't be automatically resolved.\nIn such a case, you must manually specify those fields using the fieldsToInclude option.
Notes:
\ntrue.true in the Coveo for Sitecore integration.Whether to automatically retrieve an additional page of results and append it to the\nresults that the ResultList is currently displaying when the user scrolls down to the bottom of the\ninfiniteScrollContainer.\nSee also the infiniteScrollPageSize and\nenableInfiniteScrollWaitingAnimation options.
It is important to specify the infiniteScrollContainer option manually if you want the scrolling element to be\nsomething else than the default window element. Otherwise, you might find yourself in a strange state where the\nframework rapidly triggers multiple successive query.
Whether to display the waitingAnimation while fetching additional\nresults.
Whether to scroll back to the top of the page when the end-user:
\ninfiniteScrollContainer is set to truePager component when infiniteScrollContainer is set to false\nNote: Setting this option to false has no effect on dynamic facets. To disable this behavior on a DynamicFacet component, you must set its own enableScrollToTop option to false.A list of fields to include in the query results.\nIf you set the autoSelectFieldsToInclude option to\ntrue, the Coveo Search API returns the fields you specify for this option (if those fields are available) in\naddition to the fields which the ResultList automatically requests. Note that the autoSelectFieldsToInclude\noption doesn't automatically request fields for folding templates; in such a case, you must manually specify\nfields using this option to avoid empty results.
If you set the autoSelectFieldsToInclude option to\nfalse, the Coveo Search API only returns the fields you specify for this option (if those fields are\navailable).
If you set the autoSelectFieldsToInclude option to\nfalse and leave this option undefined, the Coveo Search API returns all available fields.
The element that triggers fetching additional results when the end user scrolls down to its bottom.\nYou can change the container by specifying its selector (e.g.,\ndata-infinite-scroll-container-selector='#someCssSelector').
By default, the framework uses the first vertically scrollable parent element it finds, starting from the\nResultList element itself. A vertically scrollable element is an element whose CSS overflow-y attribute is\nscroll.
This implies that if the framework can find no scrollable parent, it uses the window itself as a scrollable\ncontainer.
This heuristic is not perfect, for technical reasons. There are always some corner case CSS combination which the\nframework will not be able to correctly detect as 'scrollable'.
\nIt is highly recommended that you manually set this option if you wish something else than the window to be the\nscrollable element.
The number of additional results to fetch when the user scrolls down to the bottom of the\ninfiniteScrollContainer.
Specifies the layout to use when displaying results in this ResultList (see\nResult Layouts). Specifying a value for this option automatically\npopulates a ResultLayout component with a switcher for the layout.\nFor example, if there are two ResultList components in the page, one with its layout set to list and the\nother with the same option set to card, then the ResultLayout component will render two buttons respectively\nentitled List and Card.
See the ValidLayout type for the list of possible values.
The element inside which to insert the rendered result templates.\nPerforming a new query clears the content of this element.
\nYou can change the container by specifying its selector (e.g.,\ndata-result-container-selector='#someCssSelector').
If you specify no value for this option, a div element will be dynamically created and appended to the result\nlist. This element will then be used as a result container.
The type of animation to display while waiting for a query to return.\nThe possible values are:
\nfade: Fades out the current list of results while the query is executing.spinner: Shows a spinning animation while the query is executing.none: Use no animation during queries.See also the waitAnimationContainer option.
The element inside which to display the waitAnimation.\nYou can change this by specifying a CSS selector (e.g.,\ndata-wait-animation-container-selector='#someCssSelector').
Defaults to the value of the resultsContainer option.
Creates a new ResultList component. Binds various event related to queries (e.g., on querySuccess ->\nrenderResults). Binds scroll event if the enableInfiniteScroll\noption is true.
Note:
\n\n\nThe Coveo Cloud V2 platform does not support collaborative rating. Therefore, this component is obsolete in Coveo Cloud V2.
\n
The ResultRating component renders a 5-star rating widget. Interactive rating is possible if\nthe enableCollaborativeRating option of your\nsearch interface is true, and if collaborative rating is enabled on your Coveo index.
This component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultRating.constructor", "notSupportedIn": "", "comment": "Creates a new ResultRating component.
The ResultTagging component lists the current tag field values of its associated result and renders a control that\nallows the end user to add values to a tag field.\nThis component is a result template component (see Result Templates).
\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.bind", "notSupportedIn": "", "comment": "The ResultTagging component is not supported with Coveo Cloud V2. To implement the ResultTagging component in Coveo Cloud V1, contact Coveo Support.
\n
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultTagging.options.autoCompleteTimer", "notSupportedIn": "", "comment": "Specifies how much time (in milliseconds) it takes for the list of suggested items to disappear when it loses\nfocus.\nDefault value is 2000. Minimum value is 0.
Specifies the tag field that the component will use.\nSpecifying a value for this options is necessary for this component to work.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "ResultTagging.options.suggestBoxSize", "notSupportedIn": "", "comment": "Specifies the number of items to show in the list of suggested items.\nDefault value is 5. Minimum value is 0.
Creates a new ResultTagging component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences", "notSupportedIn": "", "comment": "The ResultFiltersPreferences component allows end users to create custom filters to apply to queries. These filters\nare saved to local storage.\nOnly advanced end users who understand the Coveo query syntax should use this feature (see\nCoveo Query Syntax Reference).
This component is normally accessible through the Settings menu. Its usual location in the DOM is\ninside the PreferencesPanel element.
See also the ResultsPreferences component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsFiltersPreferences.options.filters", "notSupportedIn": "", "comment": "Specifies the default filters which all end users can apply.\nEnd users cannot modify or delete these filters. These filters do not count as "user-made" filters, but rather as\n"built-in" filters created by the developer of the search page.
\nNote:
\n\n\nYou cannot set this option directly in the component markup as an HTML attribute. You must either set it in the\n
\ninitcall of your search interface (see\nPassing Component Options in the init Call),\nor before theinitcall, using theoptionstop-level function (see\nPassing Component Options Before the init Call).
Filters should follow this definition:
\nfilters : { [caption : string] : { expression : string, tab? : string[] } };
Example:
\nvar myFilters = {\n "Only Google Drive Items" : {\n expression : "@connectortype == 'GoogleDriveCrawler'",\n tab : ["Tab1", "Tab2"]\n },
\n"Another Filter" : {\n expression : [ ... another expression ... ]\n },
\n[ ... ]\n};
\n// You can set the option in the 'init' call:\nCoveo.init(document.querySelector(\"#search\"), {\n ResultsFiltersPreferences : {\n filters : myFilters\n }\n});\n\n// Or before the 'init' call, using the 'options' top-level function:\n// Coveo.options(document.querySelector(\"#search\"), {\n// ResultsFiltersPreferences : {\n filters : myFilters\n }\n// });\nDefault value is undefined.
Specifies whether to display the active filter(s) in the Breadcrumb.\nDefault value is true.
Specifies whether to show the Create button that allows the end user to create filters.\nIf you set this option to false, only the pre-populated\nfilters are available to the end user.
Default value is true.
Creates a new ResultsFiltersPreferences component.
The ResultsPerPage component attaches itself to a div and allows the end user to choose how many results to\ndisplay per page.\nNote: Adding a ResultPerPage component to your page overrides the value of\nSearchInterface.options.resultsPerPage.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Returns the current number of results per page.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.usageAnalytics", "notSupportedIn": "", "comment": "A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.options", "notSupportedIn": "", "comment": "The options for the ResultsPerPage
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.options.choicesDisplayed", "notSupportedIn": "", "comment": "Specifies the possible values of number of results to display per page that the end user can select from.\nSee also ResultsPerPage.options.initialChoice.
\nDefault value is [10, 25, 50, 100].
Specifies the value to select by default for the number of results to display per page.\nDefault value is the first value of ResultsPerPage.options.choicesDisplayed.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPerPage.constructor", "notSupportedIn": "", "comment": "Creates a new ResultsPerPage. The component renders itself on every query success.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences", "notSupportedIn": "", "comment": "The ResultsPreferences component allows the end user to select preferences related to the search results. These\npreferences are then saved in the local storage of the end user.\nThis component is normally accessible through the Settings menu. Its usual location in the DOM is inside the\nPreferencesPanel component.
\nSee also the ResultsFiltersPreferences component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultsPreferences.options.enableOpenInNewWindow", "notSupportedIn": "", "comment": "Specifies whether to make the option to open results in a new window available.\nDefault value is true
Specifies whether to make the option to open results in Microsoft Outlook available.\nDefault value is false
Specifies whether to make the option to allow end users to turn query syntax on or off available.\nIf query syntax is enabled, the Coveo Platform tries to interpret special query syntax (e.g.,\n@objecttype=message) when the end user types a query in the Querybox (see\nCoveo Query Syntax Reference). Enabling query\nsyntax also causes the Querybox to highlight any query syntax.
Selecting On for the Enable query syntax setting enables query syntax, whereas selecting Off disables\nit. Selecting Automatic uses the Querybox enableQuerySyntax\noption value (which is false by default).
Default value is false
Creates a new ResultsPreference component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts", "notSupportedIn": "", "comment": "The Search Alerts component renders items in the Settings menu that allow the end user to follow queries\nand to manage search alerts. A user following a query receives email notifications when the query results change.\nNote:
\n\n\nIt is necessary to meet certain requirements to be able to use this component (see\nDeploying Search Alerts on a Coveo JS Search Page).
\n
See also the FollowItem component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.message", "notSupportedIn": "", "comment": "A reference to a SearchAlertsMessage component that the SearchAlerts component uses to display messages.
\n", "type": "SearchAlertsMessage", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.options", "notSupportedIn": "", "comment": "The options for the search alerts
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlerts.options.enableFollowQuery", "notSupportedIn": "", "comment": "Specifies whether to add the Follow Query item in the Settings menu to allow the end user to follow\nthe last query.\nClicking the Follow Query item calls the SearchAlerts.followQuery method.
\nDefault value is true.
Specifies whether to add the Manage Alerts item in the Settings menu to allow the end user to manage\nsearch alerts.\nClicking the Manage Alerts item calls the SearchAlerts.openPanel method.
\nDefault value is true.
Specifies whether to display info and error messages when performing search alerts actions.\nIf this options is true, the SearchAlerts constructor will automatically instantiate a\nSearchAlertsMessage component and set it to the SearchAlerts.message attribute.
See also SearchAlerts.options.messageCloseDelay.
\nDefault value is true.
If SearchAlerts.options.enableMessage is true, specifies how long to display the search alert messages\n(in milliseconds).\nDefault value is 2000. Minimum value is 0.
Specifies which field to use to represent the modification date when sending the\nISubscriptionQueryRequest.\nDefault value is undefined.
Creates a new SearchAlerts component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage", "notSupportedIn": "", "comment": "The SearchAlertsMessage component allows the SearchAlerts component to display messages.\nYou should not include this component in your page. Instead, use a SearchAlerts component, and access the\nSearchAlerts.message attribute.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.options", "notSupportedIn": "", "comment": "The options for the SearchAlertsMessage component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchAlertsMessage.options.closeDelay", "notSupportedIn": "", "comment": "Specifies how long to display the search alerts messages (in milliseconds).\nDefault value is 2000. Minimum value is 0.
Creates a new SearchAlertsMessage component
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton", "notSupportedIn": "", "comment": "The SearchButton component renders a search icon that the end user can click to trigger a new query.\nSee also the Searchbox component, which can automatically instantiate a SearchButton component along with a\nQuerybox component or an Omnibox component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchButton.constructor", "notSupportedIn": "", "comment": "Creates a new SearchButton. Binds a click event on the element. Adds a search icon on the element.
The SearchInterface component is the root and main component of your Coveo search interface. You should place all\nother Coveo components inside the SearchInterface component.\nIt is also on the HTMLElement of the SearchInterface component that you call the init function.
\nIt is advisable to specify a unique HTML id attribute for the SearchInterface component in order to be able to\nreference it easily.
Example:
\n<head>\n\n[ ... ]\n\n<script>\n document.addEventListener('DOMContentLoaded', function() {\n\n [ ... ]\n // The init function is called on the SearchInterface element, in this case, the body of the page.\n Coveo.init(document.body);\n\n [ ... ]\n\n });\n</script>\n\n[ ... ]\n</head>\n\n<!-- Specifying a unique HTML id attribute for the SearchInterface component is good practice. -->\n<body id='search' class='CoveoSearchInterface' [ ... other options ... ]>\n\n [ ... ]\n\n <!-- You should place all other Coveo components here, inside the SearchInterface component. -->\n\n [ ... ]\n\n</body>\nGets all the components of a given type.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchInterface.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchInterface.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchInterface.responsiveComponents", "notSupportedIn": "", "comment": "Allows to get and set the different breakpoints for mobile and tablet devices.\nThis is useful, amongst other, for Facet, Tab and ResultList
\n", "type": "ResponsiveComponents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchInterface.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
The options for the search interface
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchInterface.options.allowQueriesWithoutKeywords", "notSupportedIn": "", "comment": "Specifies if the search interface should perform queries when no keywords are entered by the end user.\nWhen this option is set to true, the interface will initially only load with the search box, as long as you have a search box component in your interface.
\nOnce the user submits a query, the full search interface loads to display the results.
\nWhen using the Coveo for Salesforce Free edition, this option is automatically set to false, and should not be changed.
\nThis option interacts closely with the SearchInterface.options.autoTriggerQuery option, as the automatic query is not triggered when there are no keywords.
\nIt also modifies the IQuery.allowQueriesWithoutKeywords query parameter.
\nDefault value is true, except in Coveo for Salesforce Free edition in which it is false.
Specifies whether to trigger the first query automatically when the page finishes loading.\nDefault value is true.
Specifies whether to enable automatic responsive mode (i.e., automatically placing Facet and Tab\ncomponents in dropdown menus under the search box when the width of the SearchInterface HTML element reaches or\nfalls behind a certain pixel threshold).\nYou might want to set this option to false if automatic responsive mode does not suit the specific design needs\nof your implementation.
Note:
\n\n\nIf this option is
\ntrue, you can also specify whether to enable responsive mode for Facet components (see\nFacet.options.enableResponsiveMode) and for Tab components (see\nTab.options.enableResponsiveMode).In addition, you can specify the label you wish to display on the dropdown buttons (see\nFacet.options.dropdownHeaderLabel and Tab.options.dropdownHeaderLabel).
\n
Default value is true.
Note:
\n\n\nThe Coveo Cloud V2 platform does not support collaborative rating. Therefore, this option is obsolete in Coveo Cloud V2.
\n
Specifies whether to enable collaborative rating, which you can leverage using the\nResultRating component.
Setting this option to true has no effect unless collaborative rating is also enabled on your Coveo index.
Default value is false.
Specifies whether to enable the feature that allows the end user to ALT + double click any result to open a debug\npage with detailed information about all properties and fields for that result.\nEnabling this feature causes no security concern; the entire debug information is always visible to the end user\nthrough the browser developer console or by calling the Coveo API directly.
\nDefault value is true.
Whether to filter out duplicates, so that items resembling one another only appear once in the query results.\nNotes:
\nTab component. When this is the case, the Tab configuration prevails.Whether to allow the end user to navigate search history using the Back and Forward buttons\nof the browser.\nIf this option is set to true, the state of the current query will be saved in the hash portion\nof the URL when the user submits the query.
Example:
\n\n\nIf the
\nenableHistoryoption istrueand the current query isfoobar, the SearchInterface component\nsavesq=foobarin the URL hash when the user submits the query.
Note: Avoid setting this option to true on a search interface that relates to a Coveo for Salesforce Full Search or Insight Panel component, otherwise the component won't initialize correctly.
Specifies whether to restore the last scroll position when navigating back\nto the search interface.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "SearchInterface.options.excerptLength", "notSupportedIn": "", "comment": "Specifies the number of characters to get at query time to create an excerpt of the result.\nThis setting is global and cannot be modified on a per-result basis.
\nSee also the Excerpt component.
\nDefault value is 200. Minimum value is 0.
Specifies an expression to add to each query.\nYou might want to use this options to add a global filter to your entire search interface that applies for all\ntabs.
\nYou should not use this option to address security concerns (it is JavaScript, after all).
\nNote:
\n\n\nIt also is possible to set this option separately for each Tab component\n(see Tab.options.expression).
\n
Default value is ''.
Specifies the name of a field to use as a custom filter when executing the query (also referred to as\n"folding").\nSetting a value for this option causes the index to return only one result having any particular value inside the\nfilter field. Any other matching result is "folded" inside the childResults member of each JSON query result.
\nThis feature is typically useful with threaded conversations to include only one top-level result per\nconversation. Thus, the field you specify for this option will typically be value unique to each thread that is\nshared by all items (e.g., posts, emails, etc) in the thread.
\nFor more advanced features, see the Folding component.
\nDefault value is the empty string ('').
Specifies the animation that you wish to display while your interface is loading.\nYou can either specify the CSS selector of an HTML element that matches the default CSS class\n(coveo-first-loading-animation), or add -selector to the markup attribute of this option to specify the CSS\nselector of an HTML element that matches any CSS class.
See also the hideUntilFirstQuery option.
\nExamples:
\nIn this first case, the SearchInterface uses the HTML element whose id attribute is MyAnimation as the\nloading animation only if the class attribute of this element also matches coveo-first-loading-animation.\nDefault loading animation CSS, which you can customize as you see fit, applies to this HTML element.
<div class='CoveoSearchInterface' data-first-loading-animation='#MyAnimation'>\n <div id='MyAnimation' class='coveo-first-loading-animation'>\n <!-- ... -->\n </div>\n <!-- ... -->\n</div>\nIn this second case, the SearchInterface uses the HTML element whose id attribute is MyAnimation as the\nloading animation no matter what CSS class it matches. However, if the class attribute of the HTML element does\nnot match coveo-first-loading-animation, no default loading animation CSS applies to this HTML element.\nNormally, you should only use data-first-loading-animation-selector if you want to completely override the\ndefault loading animation CSS.
<div class='CoveoSearchInterface' data-first-loading-animation-selector='#MyAnimation'>\n <div id='MyAnimation' class='my-custom-loading-animation-class'>\n <!-- ... -->\n </div>\n <!-- ... -->\n</div>\nBy default, the loading animation is a Coveo CSS animation (which you can customize with CSS).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchInterface.options.hideUntilFirstQuery", "notSupportedIn": "", "comment": "Specifies whether to display a loading animation before the first query successfully returns.\nNote:
\n\n\nIf you do not set this options to
\nfalse, the loading animation will still run until the first query\nsuccessfully returns even if the autoTriggerQuery option is\nfalse.
See also the firstLoadingAnimation option.
\nDefault value is true.
Specifies the maximum age (in milliseconds) that cached query results can have to still be usable as results\ninstead of performing a new query on the index. The cache is located in the Coveo Search API (which resides\nbetween the index and the search interface).\nIf cached results that are older than the age you specify in this option are available, the framework will not\nuse these results; it will rather perform a new query on the index.
\nOn high-volume public web sites, specifying a higher value for this option can greatly improve query response\ntime at the cost of result freshness.
\nNote:
\n\n\nIt also is possible to set this option separately for each Tab component\n(see Tab.options.maximumAge).
\n
Default value is undefined, which means that the search interface lets the Coveo Search API determine the\nmaximum cache age. This is typically equivalent to 30 minutes (see\nmaximumAge).
Specifies the HTMLElement to which Modals components of the search interface will be attached to. You can\neither specify a CSS selector or pass an HTMLElement in the options when calling Coveo.init.\nDefault value is element.ownerDocument.body.
Example in attribute:
\n<div class=\"CoveoSearchInterface\" data-modal-container=\"#my-modal-container\"></div>\nExample in init options:
\nvar myContainer = document.getElementById('my-modal-container');\nCoveo.init(root, {\n SearchInterface: {\n modalContainer: myContainer\n }\n});\nSpecifies the name of the query pipeline to use for the queries.\nYou can specify a value for this option if your index is in a Coveo Cloud organization in which pipelines have\nbeen created (see Adding and Managing Query Pipelines).
\nNote:
\n\n\nIt also is possible to set this option separately for each Tab component\n(see Tab.options.pipeline).
\n
Default value is undefined, which means that the search interface uses the default pipeline.
Specifies the search interface width that should be considered "medium" size, in pixels.\nWhen the width of the window/device that displays the search page reaches or falls short of this threshold (but still exceeds the responsiveSmallBreakpoint value), the search page layout will change so that, for instance, facets within the element that has the coveo-facet-column class will be accessible from a dropdown menu on top of the result list rather than being fully rendered next to the result list.
\nThis option is only taken into account when enableAutomaticResponsiveMode is set to true.
\nDefault value is 800.
Specifies the search interface responsive mode that should be used.\nWhen the mode is auto, the width of the window/device that displays the search page is used to determine which layout the search page should use\n(see enableAutomaticResponsiveMode, responsiveMediumBreakpoint\nand [responsiveSmallBreakpointSearchInterface.options.responsiveSmallBreakpoint])
\nWhen it's not on auto, the width is ignored and the the layout used depends on this option\n(e.g. If set to "small", then the search interface layout will be the same as if it was on a narrow window/device)
\n", "type": "", "constrainedValues": [ "auto,small,medium,large" ], "miscAttributes": { "defaultValue": "auto" } }, { "name": "SearchInterface.options.responsiveSmallBreakpoint", "notSupportedIn": "", "comment": "Specifies the search interface width that should be considered "small" size, in pixels.\nWhen the width of the window/device that displays the search page reaches or falls short of this threshold, the search page layout will change so that, for instance, some result list layouts which are not suited for being rendered on a small screen/area will be disabled.
\nThis option is only taken into account when enableAutomaticResponsiveMode is set to true.
\nDefault value is 480.
Specifies the number of results to display on each page.\nFor more advanced features, see the ResultsPerPage component.
\nNote:
\n\n\nWhen the ResultsPerPage component is present in the page, this option gets overridden and is useless.
\n
Default value is 10. Minimum value is 0.
Specifies the search page you wish to navigate to when instantiating a standalone search box interface.\nDefault value is undefined, which means that the search interface does not redirect.
Specifies the timezone in which the search interface is loaded. This allows the index to recognize some special\nquery syntax.\nThis option must have a valid IANA zone info key (AKA the Olson time zone database) as its value.
\nExample: America/New_York.
By default, the search interface allows a library to try to detect the timezone automatically.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchInterface.options.useLocalStorageForHistory", "notSupportedIn": "", "comment": "Specifies whether to save the interface state in the local storage of the browser.\nYou might want to set this option to true for reasons specifically important for your implementation.
Default value is false.
Creates a new SearchInterface. Initialize various singletons for the interface (e.g., usage analytics, query\ncontroller, state model, etc.). Binds events related to the query.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox", "notSupportedIn": "", "comment": "The Searchbox component allows you to conveniently instantiate two components which end users frequently use to\nenter and submit queries.\nThis component attaches itself to a div element and takes care of instantiating either a\nQuerybox or an Omnibox component (see the\nenableOmnibox option). Optionally, the Searchbox can also instantiate a\nSearchButton component, and append it inside the same div (see the\naddSearchButton option).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.searchButton", "notSupportedIn": "", "comment": "The SearchButton component instance.
A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.searchbox", "notSupportedIn": "", "comment": "The component instance which allows end users to input queries.\nCan be either a Querybox or an Omnibox component, depending on the value of\nenableOmnibox.
The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.options", "notSupportedIn": "", "comment": "Possible options for the Searchbox
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Searchbox.options.addSearchButton", "notSupportedIn": "", "comment": "Specifies whether to instantiate a SearchButton component.\nDefault value is true.
Specifies whether to instantiate an Omnibox component.\nWhen this option is false, the Searchbox instantiates a Querybox component instead.
Note:
\n\n\nYou can use configuration options specific to the component you choose to instantiate with the
\nSearchbox.
Examples:
\nIn this first case, the Searchbox instantiates a Querybox component. You can configure this Querybox\ninstance using any of the Querybox component options, such as\ntriggerQueryOnClear.
<div class='CoveoSearchbox' data-trigger-query-on-clear='true'></div>\nIn this second case, the Searchbox instantiates an Omnibox component. You can configure this Omnibox\ninstance using any of the Omnibox component options, such as\nplaceholder.\nMoreover, since the Omnibox component inherits all of the Querybox component options, the\ndata-trigger-query-on-clear option from the previous example would also work on this Omnibox instance.
<div class='CoveoSearchbox' data-enable-omnibox='true' data-placeholder='Please enter a query'></div>\nDefault value is true.
A custom height for the search box (in pixels).\nNote: Avoid setting this option if you want to modify the search box styling through custom CSS.
\nMinimum value is 25
Default behavior: The most specific CSS rules targeting HTML elements generated by the Searchbox component are used\n(e.g., if you are only using the default CoveoFullSearch.css stylesheet with no further styling customizations,\nthe search box height will be set to 50 pixels by default).
\n", "type": "number", "constrainedValues": [], "miscAttributes": { "min": "25" } }, { "name": "Searchbox.constructor", "notSupportedIn": "", "comment": "Creates a new Searchbox component. Creates a new Coveo.Magicbox instance and wraps magic box methods (onblur,\nonsubmit, etc.). Binds event on buildingQuery and on redirection (for standalone box).
The Settings component renders a Settings button that the end user can click to access a popup menu from which\nit is possible to perform several contextual actions. The usual location of the Settings button in the page is to\nthe right of the Searchbox.\nThis component can reference several components to populate its popup menu:
\nAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.options", "notSupportedIn": "", "comment": "The options for Settings
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Settings.options.menuDelay", "notSupportedIn": "", "comment": "Specifies the delay (in milliseconds) before hiding the popup menu when the cursor is not hovering over it.\nDefault value is 300. Minimum value is 0.
Creates a new Settings component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery", "notSupportedIn": "", "comment": "The ShareQuery component populates the Settings popup menu with the Share Query menu item. When the end\nuser clicks this item, it displays a panel containing two input boxes: one containing a shareable link and the other\ncontaining the complete current query expression.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ShareQuery.constructor", "notSupportedIn": "", "comment": "Creates a new ShareQuery component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter", "notSupportedIn": "", "comment": "The SimpleFilter component displays a dropdown menu containing field values which the end user can select to filter\nthe query results.\nThe list of available field values in the dropdown menu can either be static (defined through the\nvalues option), or dynamic (automatically obtained through a\nGroupByRequest operation performed at the same time as the main query).
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.options", "notSupportedIn": "", "comment": "The possible options for the SimpleFilter.
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "SimpleFilter.options.enableClearButton", "notSupportedIn": "", "comment": "Whether to show a button to clear all selected values.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "SimpleFilter.options.field", "notSupportedIn": "", "comment": "Specifies the field whose values the SimpleFilter should output result filters from.\nSpecifying a value for this option is required for the SimpleFilter component to work.
Specifies the maximum number of field values to display in the SimpleFilter dropdown menu.\nDefault value is 5. Minimum value is 0.
string?\nThe sort criteria to use.\nDefault: score
Allowed values:
\nscore: sort using the score value which is computed from the number of occurrences of a field value, as well as from the position\nwhere query result items having this field value appear in the ranked query result set. When using this sort criterion, a field value\nwith 100 occurrences might appear after one with only 10 occurrences, if the occurrences of the latter field value tend to appear higher\nin the ranked query result set.
occurrences: sort by number of occurrences, with field values having the highest number of occurrences appearing first.
alphaascending/alphadescending: sort alphabetically on the field values.
chisquare: sort based on the relative frequency of field values in the query result set compared to their frequency in the entire index. This means that a field value that does\nnot appear often in the index, but does appear often in the query result set will tend to appear higher.
Specifies the title to display for the SimpleFilter.\nDefault value is the localized string for NoTitle.
Specifies a JSON object describing a mapping of SimpleFilter values to their desired captions.\nExamples:
`javascript\nvar myValueCaptions = {\n"txt" : "Text files",\n"html" : "Web page",\n[ ... ]\n};Coveo.init(document.querySelector("#search"), {\n SimpleFilter : {\n valueCaption : myValueCaptions\n }\n});
\n\n* Or before the `init` call, using the ['options']{@link options} top-level function:\n```javascript\nCoveo.options(document.querySelector(\"#search\"), {\n SimpleFilter : {\n valueCaption : myValueCaptions\n }\n});\n<!-- Ensure that the double quotes are properly handled in `data-value-caption`. -->\n<div class='CoveoSimpleFilter' data-field='@myotherfield' data-value-caption='{\"txt\":\"Text files\",\"html\":\"Web page\"}'></div>\nSpecifies a static list of field values to display in the SimpleFilter dropdown menu.\nThis option is undefined by default, which means that the component generates a dynamic list of field values\nby performing a GroupByRequest operation at the same time as the main query.
Creates a new SimpleFilter component. Binds multiple query events as well.
The SmartSnippet component displays the excerpt of a document that would be most likely to answer a particular query.\nThis excerpt can be visually customized using inline styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.options", "notSupportedIn": "", "comment": "The options for the SmartSnippet
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippet.options.alwaysOpenInNewWindow", "notSupportedIn": "", "comment": "Specifies whether the component should open its links in a new window instead of opening them in the current\ncontext.\nDefault value is false.
Specifies a template literal from which to generate the title and URI's href attribute value (see\nTemplate literals).\nThis option overrides the field option value.
The template literal can reference any number of fields from the parent result. It can also reference global\nscope properties.
\nExamples:
\nhref value such as http://uri.com?id=itemTitle:<a class='CoveoSmartSnippet' data-href-template='${clickUri}?id=${raw.title}'></a>\nhref value such as localhost/fooBar:<a class='CoveoSmartSnippet' data-href-template='${window.location.hostname}/{Foo.Bar}'></a>\nDefault value is undefined.
The maximum height an answer can have in pixels.\nAny part of an answer exceeding this height will be hidden by default and expendable via a "show more" button.\nDefault value is 250.
The field to display for the title.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "defaultValue": "@title" } }, { "name": "SmartSnippet.options.useIFrame", "notSupportedIn": "", "comment": "Specify if the SmartSnippet should be displayed inside an iframe or not.\nUse this option in specific cases where your environment has limitations around iframe usage.
\nExamples:
\n<div class='CoveoSmartSnippet' data-use-i-frame='true'></div>\nDefault value is true.
Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The SmartSnippetSuggestions component displays additional queries for which a Coveo Smart Snippets model can provide relevant excerpts.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.options", "notSupportedIn": "", "comment": "The options for the SmartSnippetSuggestions
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "SmartSnippetSuggestions.options.alwaysOpenInNewWindow", "notSupportedIn": "", "comment": "Specifies whether the component should open its links in a new window instead of opening them in the current\ncontext.\nDefault value is false.
Specifies a template literal from which to generate the title and URI's href attribute value (see\nTemplate literals).\nThis option overrides the field option value.
The template literal can reference any number of fields from the parent result. It can also reference global\nscope properties.
\nExamples:
\nhref value such as http://uri.com?id=itemTitle:<a class='CoveoSmartSnippet' data-href-template='${clickUri}?id=${raw.title}'></a>\nhref value such as localhost/fooBar:<a class='CoveoSmartSnippet' data-href-template='${window.location.hostname}/{Foo.Bar}'></a>\nDefault value is undefined.
The field to display for the title.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": { "defaultValue": "@title" } }, { "name": "SmartSnippetSuggestions.options.useIFrame", "notSupportedIn": "", "comment": "Specify if the SmartSnippetSuggestion snippet should be displayed inside an iframe or not.\nUse this option in specific cases where your environment has limitations around iframe usage.
\nExamples:
\n<div class='CoveoSmartSnippetSuggestions' data-use-i-frame='true'></div>\nDefault value is true.
Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The Sort component renders a widget that the end user can interact with to select the criterion to use when sorting query results.\nTo improve accessibility, it's recommended to group Sort components in a container with role="radiogroup".
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.options", "notSupportedIn": "", "comment": "Options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Sort.options.caption", "notSupportedIn": "", "comment": "The caption to display on this component instance.\nBy default, the component uses the text content of the element it is instanciated on.
\n", "type": "string", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "Sort.options.sortCriteria", "notSupportedIn": "", "comment": "The sort criterion/criteria the end user can select/toggle between when interacting with this component instance.\nThe available sort criteria are:
\nrelevancydate ascending/date descendingqre@field ascending/@field descending, where you must replace field with the name of a sortable field in your index (e.g., data-sort-criteria="@size ascending").You can specify a comma separated list of sort criteria to toggle between when interacting with this component instance (e.g., data-sort-criteria="date descending,date ascending").
You can specify multiple sort criteria to be used in the same request by separating them with a semicolon (e.g., data-sort-criteria="@size ascending;date ascending" ).
Interacting with this component instance will cycle through those criteria in the order they are listed in.\nTypically, you should only specify a list of sort criteria when you want the end user to be able to to toggle the direction of a date or @field sort criteria.\nOtherwise, you should configure a distinct Sort component instance for each sort criterion you want to make available in your search page.
You must specify a valid value for this option in order for this component instance to work correctly.
\nExamples:
\ndata-sort-criteria="date ascending" createes a Sort component that allows to sort on date ascending, without being able to toggle the order.data-sort-criteria="date ascending, date descending" creates a Sort component that allows end users to toggle between date ascending and date descending on click.data-sort-criteria="@size ascending; date descending" creates a Sort component that only allows end users to sort on @size ascending. The index then applies a second sort on date descending when two items are of equal value.data-sort-criteria="@size ascending; date descending, @size descending; date descending" creates a Sort component that allows end users to toggle between @size ascending and @size descending. For each value, the index applies a second sort on date descending when two items are of equal value.Creates a new Sort component instance.
The SortDropdown component renders a dropdown that the end user can interact with to select the criteria to use when sorting query results.\nIt is meant to be a parent of regular Sort components. Example:
<div class=\"CoveoSortDropdown\">\n <span class=\"CoveoSort\" data-sort-criteria=\"relevancy\" data-caption=\"Relevance\"></span>\n <span class=\"CoveoSort\" data-sort-criteria=\"date descending\" data-caption=\"Newest\"></span>\n <span class=\"CoveoSort\" data-sort-criteria=\"date ascending\" data-caption=\"Oldest\"></span>\n</div>\nEach one of the children Sort components should have only one sort criteria to prevent the regular toggle behaviour.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "SortDropdown.constructor", "notSupportedIn": "", "comment": "Creates a new SortDropdown component instance.
The StarRating component renders a five-star rating widget for use in commerce result templates.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "StarRating.options.numberOfRatingsField", "notSupportedIn": "", "comment": "A numeric field whose value should be used to display the total number of ratings label for the result item.\nIf unspecified, no number of ratings label is displayed. If the numberOfRatingsField's value is 0 or less, a (No Ratings) label is displayed.
Specifies the rating to be displayed as stars. If the rating is on a different scale than 0-5, a ratingScale value must be provided.
The scale to apply to the ratingField's value. Must be smaller than or equal to the highest possible ratingField's value.\nExample: If the ratingScale is 100 and the current ratingField's value is 75, the component will render 3 stars (i.e., 75 * (5 / 100), rounded down).
Creates a new StarRating component.
The Tab component renders a widget that allows the end user to select a specific search interface.\nThis component attaches itself to a div element. It is in charge of adding an advanced expression to the outgoing\nquery in order to refine the results.
The Tab component can also hide and show different parts of the UI. For each individual component in the UI, you can\nspecify whether you wish to include or exclude that component when the user selects a certain Tab (see Using Components\nOnly on Specific Tabs).
\nSetting a New Endpoint for a Tab:
\nA Tab can use a custom endpoint when performing a query. Of course, you need to make sure that the endpoint exists in\nthe array of Coveo.SearchEndpoint.endpoints (see SearchEndpoint.endpoints).
\nCoveo.SearchEndpoint.endpoints[\"specialEndpoint\"] = new Coveo.SearchEndpoint({\n restUri : 'https://somewhere.com/rest/search'\n})\n\n[ ... ]\n\n<div class='CoveoTab' data-endpoint='specialEndpoint'></div>\n\nAllows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.options", "notSupportedIn": "", "comment": "The options for a Tab
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.options.caption", "notSupportedIn": "", "comment": "Specifies the caption of the Tab.\nSpecifying a value for this option is necessary for this component to work.
\n", "type": "string", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "Tab.options.constant", "notSupportedIn": "", "comment": "Specifies whether to include the Tab.options.expression in the constant part of the query.\nThe index specially optimizes the constant part of the query to execute faster. However, you must be careful not\nto include dynamic query expressions, otherwise the cache will lose its efficiency.
\nDefault value is true.
Specifies the label of the button that allows to show the hidden tabs when in responsive mode.\nIf more than one Tab in the search interface specifies a value for this option, then the framework uses the first\noccurrence of the option.
\nThe default value is "More".
Whether to filter out duplicates, so that items resembling one another only appear once in the query results.\nNotes:
\nSpecifies whether to enable responsive mode for tabs. Responsive mode makes overflowing tabs disappear, instead\nmaking them available using a dropdown button. Responsive tabs are enabled either when tabs overflow or when the\nwidth of the search interface becomes too small.\nDisabling responsive mode for one Tab also disables it for all tabs. Therefore, you only need to set this option\nto false on one Tab to disable responsive mode.
Default value is true.
Specifies the SearchEndpoint to point to when performing queries from within the Tab.\nBy default, the Tab uses the "default" endpoint.
\n", "type": "SearchEndpoint", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.options.expression", "notSupportedIn": "", "comment": "Specifies an advanced expression or filter that the Tab should add to any outgoing query.\nExample:
\n@objecttype==Message
Default value is undefined and the Tab applies no additional expression or filter to the query.
Specifies an icon to use for the Tab.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "Tab.options.id", "notSupportedIn": "", "comment": "Specifies a unique ID for the Tab.\nSpecifying a value for this option is necessary for this component to work.
\n", "type": "string", "constrainedValues": [], "miscAttributes": { "required": "true" } }, { "name": "Tab.options.layout", "notSupportedIn": "", "comment": "Specifies the default layout to display when the user selects the Tab (see ResultList.options.layout and\nResultLayout).\nSee the ValidLayout type for the list of possible values.
\nIf not specified, it will default to 'list'.
\nSee also Result Layouts.
\nDefault value is undefined and the component selects the first available layout.
Specifies the maximum age (in milliseconds) that cached query results can have to still be usable as results\ninstead of performing a new query on the index from within the Tab. The cache is located in the Coveo Search API\n(which resides between the index and the search interface).\nIf cached results that are older than the age you specify in this option are available, a new query will be\nperformed on the index anyhow.
\nOn high-volume public web sites, specifying a higher value for this option can greatly improve query response\ntime at the cost of result freshness.
\nNote:
\n\n\nIt is also possible to set a maximum cache age for the entire SearchInterface rather than for a single\nTab (see SearchInterface.options.maximumAge).
\n
Default value is undefined and the Coveo Search API determines the maximum cache age. This is typically\nequivalent to 30 minutes (see maximumAge).
Specifies the name of the query pipeline to use for the queries when the Tab is selected.\nYou can specify a value for this option if your index is in a Coveo Cloud organization in which pipelines have\nbeen created (see Adding and Managing Query Pipelines).
\nDefault value is undefined, which means that pipeline selection conditions defined in the Coveo Cloud\norganization apply.
Specifies the default sort criteria to use when selecting the Tab. A Sort component with the same\nparameter needs to be present in the search interface in order for this option to function properly.\nExamples:
\ndata-sort='relevancy'data-sort='date descending'Default value is undefined and the normal Sort component behavior applies.
Creates a new Tab. Binds on buildingQuery event as well as an event on click of the element.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader", "notSupportedIn": "", "comment": "The TemplateLoader component can load one result template into another. You should normally declare any reusable\nresult template outside of the ResultList component. Otherwise, the framework will evaluate the\ndata-condition of the reusable result template and possibly render it.\nExample:
[ ... ]\n\n<!-- A reusable result template. Note that it is important to declare it outside of the ResultList component. -->\n<script type='text/underscore' class='result-template' id='ReusableTemplate'></script>\n\n[ ... ]\n\n<div class=\"CoveoResultList\" data-wait-animation=\"fade\" data-auto-select-fields-to-include=\"true\">\n\n <!-- A custom result template for Lithium messages. -->\n <script type='text/underscore' class='result-template' data-condition='raw.filetype == \"lithiummessage\"'>\n <div>\n <img class='CoveoIcon' data-small='true'>\n <a class='CoveoResultLink'></a>\n <div class='CoveoTemplateLoader' data-template-id='ReusableTemplate'></div>\n </div>\n </script>\n\n <!-- A custom result template for images. -->\n <script type='text/underscore' class='result-template' data-condition='raw.filetype == \"Image\"'></script>\n</div>\n\n[ ... ]\nSee Result Templates.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.options", "notSupportedIn": "", "comment": "The possible options for a TemplateLoader.
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateLoader.options.condition", "notSupportedIn": "", "comment": "Specifies the boolean condition that the result must satisfy in order for the template to load.\nExample:
\ndata-condition='percentScore > 80'
Specifies how to find the template. This can be either a CSS selector or an HTML id attribute.\nExamples:
data-template-selector='.MySelector'id: data-template-id='MyId'Creates a new TemplateLoader.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text", "notSupportedIn": "", "comment": "The Text component embeds itself in a result template to output a simple text value.\nThe only purpose of this component is to make it possible to easily add different text values to result templates\nwhen using the Coveo JavaScript Search Interface Editor (see\nInterface Editor).
\nIf you are not designing a search interface using the Coveo JavaScript Search Interface Editor, using this component\nis unnecessary.
\nThis component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.options.color", "notSupportedIn": "", "comment": "Specifies the color of the text (set as the color CSS property).
Specifies the bottom margin of the text (set as the margin-bottom CSS property).
Specifies the left margin of the text (set as the margin-left CSS property).
Specifies the right margin of the text (set as the margin-right CSS property).
Specifies the top margin of the text (set as the margin-top CSS property).
Specifies the bottom padding of the text (set as the padding-bottom CSS property).
Specifies the left padding of the text (set as the padding-left CSS property).
Specifies the right padding of the text (set as the padding-right CSS property).
Specifies the top padding of the text (set as the padding-top CSS property).
Specifies the size of the text (set as the font-size CSS property).
Specifies the style of the text (set as the font-style CSS property).
Specifies the alignment of the text (set as the text-align CSS property).
Specifies the localized string value that the component should render.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "Text.options.weight", "notSupportedIn": "", "comment": "Specifies the weight of the text (set as the font-weight CSS property).
Creates a new Text component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail", "notSupportedIn": [ "salesforcefree" ], "comment": "The Thumbnail component automatically fetches the thumbnail of the result object and outputs an HTML img tag with\nit.
Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.options", "notSupportedIn": "", "comment": "Options for the Thumbnail
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "Thumbnail.options.clickable", "notSupportedIn": "", "comment": "Specifies whether to create a clickable ResultLink around the Thumbnail.\nDefault value is false.
If set to true, you can use the options specified on ResultLink.options
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": { "defaultValue": "false" } }, { "name": "Thumbnail.options.noThumbnailClass", "notSupportedIn": "", "comment": "Specifies the CSS class to use on the img tag that the Thumbnail component outputs when a result has no\nthumbnail in the index.\nDefault value is coveo-no-thumbnail.
Creates a new Thumbnail component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet", "notSupportedIn": [ "salesforcefree" ], "comment": "The TimespanFacet component displays a FacetRange with prebuilt ranges.\nThe prebuilt ranges allow you to see the items last updated in the last day, week, month, or year.
\nThis component in a thin wrapper around the standard FacetRange component.
\nThis component is meant to offer out of the box default ranges, so it can easily be inserted in a standard search page.
\nTo configure different ranges than those offered by this component, use the standard FacetRange component instead.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Returns the underlying FacetRange component associated to the Timespan Facet.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.ranges", "notSupportedIn": "", "comment": "Sets a new range for the component.\nReturns the current range the facet uses to query the index
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.usageAnalytics", "notSupportedIn": "", "comment": "A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TimespanFacet.options.field", "notSupportedIn": "", "comment": "Specifies the index field whose values the facet should use.\nDefault value is the field @date
Specifies a unique identifier for the facet. Among other things, this identifier serves the purpose of saving\nthe facet state in the URL hash.\nIf you have two facets with the same field on the same page, you should specify an id value for at least one of\nthose two facets. This id must be unique in the page.
Default value is the field option value.
Specifies the title to display at the top of the facet.\nDefault value is the localized string for Last updated.
Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The Triggers component enables the use of triggers (notify, execute, query, redirect) generated by the Coveo\nSearch API (see Trigger) in the query pipeline (see\nManaging the Query Pipeline).\nTo enable the triggers functionality in your JavaScript Search Framework interface, incorporate a div with the coveoTriggers class. For example: <div class="coveoTriggers"></div>.
Note: adding the Triggers component gives query pipeline administrators the power to influence users' search experience.\nBad actors will be able to perform XSS attacks, or redirect users to dangerous sites. Make sure only individuals you trust\nhave query pipeline edit privileges.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.notifications", "notSupportedIn": "", "comment": "The list of notifications returned by the Search API for the current query (via notify triggers).\nThe Triggers component automatically renders this list visually.
Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Triggers.constructor", "notSupportedIn": "", "comment": "Creates a new Triggers component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail", "notSupportedIn": "", "comment": "The YouTubeThumbnail component automatically fetches the thumbnail of a YouTube video.\nThis component differs from the standard Thumbnail component because the thumbnail it outputs is always\nclickable.
\nDepending on the component configuration, clicking a YouTube thumbnail can either automatically open a modal box\ncontaining the iframe from YouTube, or open the target URL in the current window (see\nYouTubeThumbnail.options.embed).
This component is a result template component (see Result Templates).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "YouTubeThumbnail.options.embed", "notSupportedIn": "", "comment": "Specifies whether clicking on the YouTube thumbnail loads the video in a modal box.\nSetting this option to false causes the browser to change its current location to that of the target URL when\nthe end user clicks the YouTube thumbnail.
Default value is true.
Specifies the height (in pixels) of the YouTube thumbnail.\nDefault value is 112px.
Specifies the width (in pixels) of the YouTube thumbnail.\nDefault value is 200px.
Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The possible values for the allowedValuesPatternType property of the IGroupByRequest interface.
Applies the Edit Distance algorithm to match values that are close to the specified pattern.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AllowedValuesPatternType.Legacy", "notSupportedIn": "", "comment": "Only supports trailing wildcards in the pattern.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AllowedValuesPatternType.Phonetic", "notSupportedIn": "", "comment": "Applies a phonetic algorithm to match values that are phonetically similar to the specified pattern.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AllowedValuesPatternType.Regex", "notSupportedIn": "", "comment": "Supports regular expression as the pattern.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AllowedValuesPatternType.Wildcards", "notSupportedIn": "", "comment": "Fully supports wildcards.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRangeValueFormat", "notSupportedIn": "", "comment": "The allowed values for the valueFormat option\nof the DynamicFacetRange component.
Format range values as localized currency strings.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRangeValueFormat.date", "notSupportedIn": "", "comment": "Format range values as localized date strings.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DynamicFacetRangeValueFormat.number", "notSupportedIn": "", "comment": "Format range values as localized numeric strings.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSearchType", "notSupportedIn": "", "comment": "The facet types against which facet search is allowed.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSearchType.hierarchical", "notSupportedIn": "", "comment": "Search among hierarchical facet values (e.g., Electronics|Entertainment|Gaming Consoles;, Electronics|Computers|Laptops;, etc.).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSearchType.specific", "notSupportedIn": "", "comment": "Search among specific (i.e., scalar) facet values (e.g., Alice Smith, Bob Jones, etc.).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSortCriteria", "notSupportedIn": "", "comment": "The allowed sort criteria for a Search API\nfacet request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSortCriteria.alphanumeric", "notSupportedIn": "", "comment": "Sort facet values in ascending alphanumeric order.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSortCriteria.occurrences", "notSupportedIn": "", "comment": "Sort facet values in descending number of occurrences.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSortCriteria.score", "notSupportedIn": "", "comment": "Sort facet values in descending score order.\nFacet value scores are based on number of occurrences and position in the\nranked query result set.
\nThe Coveo Machine Learning dynamic navigation experience feature only\nworks with this sort criterion.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetType", "notSupportedIn": "", "comment": "The allowed values for the facetType property of a facet request.
Request facet values representing ranges of dates.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetType.hierarchical", "notSupportedIn": "", "comment": "Request facet values representing a hierarchy.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetType.numericalRange", "notSupportedIn": "", "comment": "Request facet values representing ranges of numbers.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetType.specific", "notSupportedIn": "", "comment": "Request facet values representing specific values.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueState", "notSupportedIn": "", "comment": "The allowed states of a facet value in a Search API facet\nrequest or\nresponse.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueState.idle", "notSupportedIn": "", "comment": "The facet value is not currently selected or excluded in the search\ninterface.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValueState.selected", "notSupportedIn": "", "comment": "The facet value is currently selected in the search interface.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearchEvents", "notSupportedIn": "", "comment": "This static class is there to contains the different string definition for all the events related to the AdvancedSearch component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "AdvancedSearchEvents.buildingAdvancedSearch", "notSupportedIn": "", "comment": "Triggered when the AdvancedSearch component is being built.\nAllows external code to add new sections in the Advanced Search panel.
\nAll bound handlers receive IBuildingAdvancedSearchEventArgs as an argument
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "AnalyticsEvents", "notSupportedIn": "", "comment": "The AnalyticsEvents static class contains the string definitions of all events that strongly relate to usage\nanalytics.\nSee Events.
Triggered when any event (i.e., search, click, or custom) is about to be logged.\nAll analyticsEventReady event handlers receive an AnalyticsEventArgs object as an argument.
Triggered whenever an analytics event is about to be logged.\nThis event allows external code to modify the analytics data before it is sent to the Coveo Usage Analytics REST\nservice.
\nAll changeAnalyticsCustomData event handlers receive a\nChangeAnalyticsCustomDataEventArgs object as an argument.
Triggered when a click analytics event is logged (e.g., when the end user clicks a\nResultLink or Quickview to open a query result item).\nAll documentViewEvent event handlers receive an\nAnalyticsDocumentViewEventArgs object as an argument.
Every component in the framework ultimately inherits from this base component class.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "BaseComponent.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "BaseComponent.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "BaseComponent.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
This static class is there to contains the different string definition for all the events related to Breadcrumb.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "BreadcrumbEvents.clearBreadcrumb", "notSupportedIn": "", "comment": "Triggered when the user clicks the Clear All button in the breadcrumb. When this event is raised, every filter that is included in the breadcrumb should be removed.\nThis event does not provide custom event data.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "BreadcrumbEvents.populateBreadcrumb", "notSupportedIn": "", "comment": "Triggered when the breadcrumb needs to update its content. External code can use this event to provide bits of HTML that should be included in the breadcrumb.\nAll handlers bound to this event will receive a IPopulateBreadcrumbEventArgs as an argument.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlayEvents", "notSupportedIn": "", "comment": "The CardOverlayEvents class contains string definitions for all events related to the CardOverlay component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlayEvents.closeCardOverlay", "notSupportedIn": "", "comment": "Closing a CardOverlay component triggers this event (see CardOverlay.closeOverlay).
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "CardOverlayEvents.openCardOverlay", "notSupportedIn": "", "comment": "Opening a CardOverlay component triggers this event (see CardOverlay.openOverlay).
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "Cell", "notSupportedIn": "", "comment": "Represent a single cell of data in the Matrix component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Checkbox", "notSupportedIn": "", "comment": "A checkbox widget with standard styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Checkbox.constructor", "notSupportedIn": "", "comment": "Creates a new Checkbox.
The base class for every component in the framework.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Component.constructor", "notSupportedIn": "", "comment": "Create a new Component. Resolve all IComponentBindings if not provided.
\nCreate a new Logger for this component.\nAttach the component to the SearchInterface.
The ComponentEvents class is used by the various Coveo Component to trigger events and bind event handlers. It adds\nlogic to execute handlers or triggers only when a component is "enabled", which serves as a way to avoid executing\nhandlers on components that are invisible and inactive in the query.\nTypically, a component is disabled when it is not active in the current Tab. It can also be disabled\nby external code, however.
To manually enable or disable a component, simply use its enable or\ndisable method.
Creates a new ComponentEvents instance for a Component.
The ComponentOptions static class contains methods allowing the Coveo JavaScript Search Framework to initialize\ncomponent options.\nTypically, each Component that exposes a set of options contains a static options property.
This property "builds" each option using the ComponentOptions method corresponding to its type (e.g.,\nbuildBooleanOption,\nbuildFieldOption,\nbuildStringOption, etc.)
A date picker widget with standard styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "DatePicker.constructor", "notSupportedIn": "", "comment": "Creates a new DatePicker.
The DateUtils class exposes methods to convert strings, numbers and date objects to standard ISO 8601 Date objects,\nusing the correct culture, language and format. It also offers methods to convert date objects to strings.
The DistanceEvents static class contains the string definitions of all events related to distance\nlist.\nSee Events.
Triggered when the DistanceResources component fails to resolve the position.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "DistanceEvents.onPositionResolved", "notSupportedIn": "", "comment": "You should bind a handler to this event if you want to display an error message to the end user, or hide\ncomponents that cannot be used.
\n
Triggered when the DistanceResources component successfully resolves the position.\nAll onPositionResolved event handlers receive a PositionResolvedEventArgs\nobject as an argument.
Triggered when the DistanceResources component tries to resolve the position.\nAll onResolvingPosition event handlers receive a\nResolvingPositionEventArgs object as an argument.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "Dom", "notSupportedIn": "", "comment": "You should bind a handler to this event if you want to register one or several new position providers.
\n
This is essentially a helper class for dom manipulation.
\nThis is intended to provide some basic functionality normally offered by jQuery.
\nTo minimize the multiple jQuery conflict we have while integrating in various system, we implemented the very small subset that the framework needs.
\nSee $$, which is a function that wraps this class constructor, for less verbose code.
Whether to always register, remove, and trigger events using standard JavaScript rather than attempting to use jQuery first.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Dom.constructor", "notSupportedIn": "", "comment": "Create a new Dom object with the given HTMLElement
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Dropdown", "notSupportedIn": "", "comment": "A dropdown widget with standard styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Dropdown.constructor", "notSupportedIn": "", "comment": "Creates a new Dropdown.
This class is in charge of calling an endpoint (eg: a SearchEndpoint).\nThis means it's only uses to execute an XMLHttpRequest (for example), massage the response and check if there are errors.
\nWill execute the call and return a Promise.
\nCall using one of those options :
\nSet this property to true to enable Jsonp call to the endpoint.
\nBe aware that jsonp is "easier" to setup endpoint wise, but has a lot of drawback and limitation for the client code.
\nDefault to false.
Create a new EndpointCaller.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExecutionPlan", "notSupportedIn": "", "comment": "The plan of execution of a search request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ExecutionPlan.basicExpression", "notSupportedIn": "", "comment": "Gets the final value of the basic expression (q) after the search request has been processed in the query pipeline, but before it is sent to the index.
Gets the final value of the large expression (lq) after the search request has been processed in the query pipeline, but before it is sent to the index.
Gets the URL to redirect the browser to, if the search request satisfies the condition of a redirect trigger rule in the query pipeline.\nReturns null otherwise.
An ExpressionBuilder that is mostly used by the QueryBuilder.
\nIt is used to build a single query expression.
\nIt allows combining multiple expression parts into a single string and provides utilities to generate common expression parts.
Used by the Facet component to render and handle the facet search part of each facet.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetSettings", "notSupportedIn": "", "comment": "Handle the rendering of the Facet settings menu (typically the ... in the facet header).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetValue", "notSupportedIn": "", "comment": "A class which holds information and operation available on a single facet value returned by a IGroupByRequest.
\nThis class is used extensively in the Facet component.
The names of the events that can be triggered by the FacetsMobileMode component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileModeEvents.popupClosed", "notSupportedIn": "", "comment": "The name of the event that gets triggered when the facets pop-up (or modal) is closed in mobile mode.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "FacetsMobileModeEvents.popupOpened", "notSupportedIn": "", "comment": "The name of the event that gets triggered when the facets pop-up (or modal) is opened in mobile mode.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread", "notSupportedIn": "", "comment": "The FoldingForThread component inherits from the Folding component. It offers the\nsame configuration options.\nFolding conversations and threads requires different processing. When you need to fold all child items (including\ntheir attachments) on the same level under a common ancestor item, use this component rather than the Folding\ncomponent.
This component works well with Chatter and Lithium.
\nNote:
\n\n\nThere can only be one
\nFoldingForThreadcomponent perTabcomponent.
See Folding Results.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.bind", "notSupportedIn": "", "comment": "Allows the component to bind events and execute them only when it is enabled.
\n", "type": "ComponentEvents", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.root", "notSupportedIn": "", "comment": "A reference to the root HTMLElement (the SearchInterface).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.options", "notSupportedIn": "", "comment": "The options for the component
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.options.child", "notSupportedIn": "", "comment": "Specifies the field that determines whether a certain result is a child of another top result.\nNote:
\n\n\nIn the index, the values of the corresponding field must:
\n\n
\n- Contain alphanumerical characters only.
\n- Contain no more than 60 characters.
\n
Default value is @foldingchild.
This option is deprecated. Instead, use the Folding.options.parent option.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.options.enableExpand", "notSupportedIn": "", "comment": "Specifies whether to add a callback function on the top result, allowing to make an additional query to load all\nof its child results (e.g., to load all conversations of a given thread).\nConcretely, the ResultFolding component uses this for its Show More link.
See also the expandExpression and\nmaximumExpandedResults options.
Default value is true.
If the enableExpand option is true, specifies a custom constant\nexpression to send when querying the expanded results.\nDefault value is undefined.
Specifies the name of the field on which to do the folding.\nSpecifying a value for this option is required for this component to work.
\nNote:
\n\n\nIn an Elasticsearch index, the corresponding field must be configured as a Facet field\n(see Add or Edit Fields).\nThis limitation does not apply to Coveo indexes.
\n
Default value is @foldingcollection.
Specifies the function that manages the folding of all results.\nDefault value is:
\nCoveo.Folding.defaultGetMoreResults = function(results) {\n // The results are flat, just do the folding.\n return Coveo.Folding.foldWithParent(results);\n}\nSpecifies the function that manages the individual folding of each result.\nDefault value is:
\nvar results = result.childResults || [];\n// Add the top result at the top of the list.\nresults.unshift(result);\n// Empty childResults just to clean it.\nresult.childResults = [];\n// Fold those results.\nresults = Coveo.Folding.foldWithParent(results);\n// The first result is the top one.\nvar topResult = results.shift();\n// All other results are childResults.\ntopResult.childResults = results;\nreturn topResult;\nYou can pre-process all the result with this option in the init call of your search interface:
Coveo.init(document.querySelector('#search'), {\n Folding: {\n getResult: function(result) {\n result = Coveo.Folding.defaultGetResult(result);\n // Your code here\n }\n }\n})\nIf the enableExpand option is true, specifies the maximum number of\nresults to load when expanding.\nDefault value is 100. Minimum value is 1.
Specifies the field that determines whether a certain result is a top result containing other child results.\nNote:
\n\n\nIn the index, the values of the corresponding field must:
\n\n
\n- Contain alphanumerical characters only.
\n- Contain no more than 60 characters.
\n
Default value is @foldingparent.
This option is deprecated. Instead, use the Folding.options.child option.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.options.range", "notSupportedIn": "", "comment": "Specifies the maximum number of child results to fold.\nExample:
\n\n\nFor an email thread with a total of 20 messages, using the default value of
\n2means that the component loads\nup to a maximum of 2 child messages under the original message, unless the end user expands the entire\nconversation using the Show More link (see theenableExpand\noption).
Default value is 2. Minimum value is 0.
Specifies the sort criteria to apply to the top result and its child results (e.g., date ascending,\n@myfield descending, etc.). See sortCriteria.\nThis option works from the results returned by the index. This means that if only the three most relevant folded results are returned by the index\nand you choose to rearrange the folded results by date, then the three most relevant results will be rearranged by date,\nmeaning that the first folded result is not necessarily the oldest or newest item.
However, since clicking on the Show More button triggers a new query, you would receive new results based on the sort criteria of this option.
Example
\n\n\nIf you are folding email results by conversation and you specify
\ndate descendingas therearrangevalue of\ntheFoldingcomponent, the component re-arranges email conversations so that the newest email is always the\ntop result. Specifyingdate ascendinginstead always makes the original email the top result, as it is also\nnecessarily the oldest.
By default, the component displays the results in the order that the index returns them.
\n", "type": "SortCriteria", "constrainedValues": [], "miscAttributes": {} }, { "name": "FoldingForThread.constructor", "notSupportedIn": "", "comment": "Creates a new FoldingForThread component
A simple fieldset HTMLElement containing multiple form widgets.
Creates a new FormGroup.
The GoogleApiPositionProvider class uses the\nGoogle Maps Geolocation API to provide the\nposition of the end user to a DistanceResources component whose\ngoogleApiKey option is set to a valid Google Maps Geolocation API\nkey.
This component is instantiated automatically by the framework on the root if the SearchInterface.
\nWhen the SearchInterface.options.enableHistory option is set to true, this component is instantiated.
\nIt's only job is to apply changes in the QueryStateModel to the hash in the URL, and vice versa.
\nThis component does not hold the state of the interface, it only represent it in the URL.
A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "HistoryController.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "HistoryController.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Create a new HistoryController
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Initialization", "notSupportedIn": "", "comment": "The main purpose of this class is to initialize the framework (a.k.a the code executed when calling Coveo.init).
\nIt's also in charge or registering the available components, as well as the method that we expost to the global Coveo scope.
\nFor example, the Coveo.executeQuery function will be registed in this class by the QueryController.
This static class is there to contain the different string definitions for all the events related to initialization.\nNote that these events will only be triggered when the init function is called.
\nThis means these events are normally called only once when the search interface is initialized.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "InitializationEvents.afterComponentsInitialization", "notSupportedIn": "", "comment": "Triggered after the components are initialized (eg: After the constructor of each component is executed)\nbut before their state is set from the hash portion of the URL (e.g., http://mysearchinterface#q=myQuery).\nThis is also before the first query is launched (if the SearchInterface.options.autoTriggerQuery is true).
The string value is afterComponentsInitialization.
Triggered right after the UI is fully initialized.\nConcretely this means that the constructor of each component has been executed, and that the state coming for the URL (e.g., http://mysearchinterface#q=myquery) has been applied.
It is triggered before the first query is launched, and if the SearchInterface.options.autoTriggerQuery is true.
The string value is afterInitialization.
This event is triggered right before each components inside the search interface get initialized (eg: Before the constructor of each component is executed).\nThe string value is beforeInitialization.
This is triggered when the UI needs to be dynamically removed so that components can unbind any internal handlers they might have set globally on the window or the document.\nAfter this event has been executed, the search interface can be dynamically removed and all handlers can be considered cleanly removed.
\nThe string value is nuke.
Triggered right before the state from the URL (e.g., http://mysearchinterface#q=myQuery) gets applied in the interface.\nThis will typically only be useful if the SearchInterface.options.enableHistory is set to true.
The string value is restoreHistoryState.
This component acts like the HistoryController excepts that is saves the QueryStateModel in the local storage.
\nThis will not allow 'back' and 'forward' navigation in the history, like the standard HistoryController allows. Instead, it load the query state only on page load.
\nTo enable this component, you should set the SearchInterface.options.useLocalStorageForHistory as well as the SearchInterface.options.enableHistory options to true.
A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "LocalStorageHistoryController.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "LocalStorageHistoryController.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Create a new LocalStorageHistoryController instance
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Model", "notSupportedIn": "", "comment": "A model is a key-value store that triggers various JavaScript events when any value associated to one of its key changes.
\nThis class is meant to be extended, one of the most important extension being the QueryStateModel class.
\nComponents set values in this key-value store and listen to triggered events in order to update themselves accordingly.
The attributes contained in this model.\nNormally, you should not set attributes directly on this property, as this would prevent required events from being triggered.
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "Model.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "Model.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "Model.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
The event types that can be triggered:
\n• preprocess: triggered before a value is set on an attribute. This allows the value to be modified before it is set.
\n• changeOne: triggered when a single value changes.\n• change: triggered when one or many values change.\n• reset: triggered when all attributes are reset to their default values. \n• all: triggered after the change event.
A multi select widget with standard styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "MultiSelect.constructor", "notSupportedIn": "", "comment": "Creates a new MultiSelect.
The NavigatorPositionProvider class uses the current web browser to provide the position of the end user to\na DistanceResources component whose\n[useNavigator]{DistanceResources.options.useNavigator} option is set to true.\nNote:
\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "NumericSpinner", "notSupportedIn": "", "comment": "Recent web browsers typically require a site to be in HTTPS to enable their geolocation service.
\n
A numeric spinner widget with standard styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "NumericSpinner.constructor", "notSupportedIn": "", "comment": "Creates a new NumericSpinner.
The OmniboxEvents static class contains the string definitions of all events that strongly relate to the\nOmnibox component.
Triggered by the Omnibox component before sending a query suggestion request to the Search API.\nAllows external functions to refine the payload b3efore sending the request.
This event is only triggered by standard ML-powered query suggestions, and not AnalyticsSuggestions or FieldSuggestions.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "OmniboxEvents.populateOmniboxSuggestions", "notSupportedIn": "", "comment": "Triggered by the Omnibox component before query completion suggestions are rendered.\nThe out-of-the-box Coveo JavaScript Search Framework query completion suggestion addons (see the\nenableFieldAddon,\nenableQueryExtensionAddon, and\nenableQuerySuggestAddon options of the Omnibox) push their\nrespective suggestions in the argument object which is passed along with this event.
All populateOmniboxSuggestions event handlers receive a\nPopulateOmniboxSuggestionsEventArgs object as an argument.
Triggered by the Omnibox component when a query suggestion gets focus following a mouse hovering or keyboard navigation event.\nAll querySuggestGetFocus event handlers receive an object implementing the IQuerySuggestSelection interface as an argument.
Triggered by the Omnibox component when a query suggestion loses focus following a mouse hovering or keyboard navigation event.
Triggered by the Omnibox component when a query suggestion has finished rendering.
Triggered by the Omnibox component when a query suggestion is selected by a mouse click or pressing the enter key.\nAll querySuggestSelection event handlers receive an object implementing the IQuerySuggestSelection interface as an argument.
Triggered by the Omnibox component when query suggestions are received from the Search API.\nAllows external functions to look into the received query suggestions, and modify them if needed.
This event is only triggered by standard ML-powered query suggestions, and not AnalyticsSuggestions or FieldSuggestions.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "PublicPathUtils", "notSupportedIn": "", "comment": "Set of utilities to determine where to load the lazy chunks from.\nYou should add the coveo-script class on the script tag that includes the Coveo framework to make sure the framework can always\nauto-detect the path to load the lazy chunks from. More details here\">https://docs.coveo.com/en/295/javascript-search-framework/lazy-versus-eager-component-loading#fixing-code-chunks-loading-path-issues}
The QueryBuilder is used to build a IQuery that will be able to be executed using the Search API.\nThe class exposes several members and methods that help components and external code to build up the final query that is sent to the Search API.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.actionsHistory", "notSupportedIn": "", "comment": "The actions history represents the past actions a user made and is used by the Coveo Machine Learning service to suggest recommendations.\nIt is generated by the page view script (https://github.com/coveo/coveo.analytics.js).
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.advancedExpression", "notSupportedIn": "", "comment": "Used to build the advanced part of the query expression.\nThis part is typically formed of filter expressions generated by components such as facets, external code, etc.
\n", "type": "ExpressionBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.allowQueriesWithoutKeywords", "notSupportedIn": "", "comment": "Specifies if the Search API should perform queries even when no keywords were entered by the end user.\nEnd user keywords are present in either the IQuery.q or IQuery.lq part of the query.
\nThis parameter is normally controlled by SearchInterface.options.allowEmptyQuery option.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.categoryFacets", "notSupportedIn": "", "comment": "Specifies an array of request for the CategoryFacet component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.childField", "notSupportedIn": "", "comment": "Specifies the childField when doing parent-child loading (See: Folding).
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.commerce", "notSupportedIn": "", "comment": "A request for a commerce query.
\n", "type": "ICommerceRequest", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.constantExpression", "notSupportedIn": "", "comment": "Used to build the advanced part of the query expression.\nThis part is similar to advancedExpression, but its content is interpreted as a constant expression by the index and it takes advantage of special caching features.
The custom context information to send along with the query. Each value should be a string or an array of strings.\nCustom context information can influence the output of Coveo Machine Learning models and can also be used in query pipeline conditions.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.disjunctionExpression", "notSupportedIn": "", "comment": "Used to build the disjunctive part of the query expression.\nWhen present, this part is evaluated separately from the other expressions and the matching results are merged to those matching expressions, advancedExpression and constantExpression.
The final boolean expression for the query is thus (basic advanced constant) OR (disjunction).
\n", "type": "ExpressionBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.enableCollaborativeRating", "notSupportedIn": "", "comment": "Note:
\n\n\nThe Coveo Cloud V2 platform does not support collaborative rating. Therefore, this property is obsolete in Coveo Cloud V2.
\n
Whether the index should take collaborative rating in account when ranking result (See: ResultRating).
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.enableDebug", "notSupportedIn": "", "comment": "Whether to enable debug info on the query.\nThis will return additional information on the resulting JSON response from the Search API.
\nMostly: execution report (a detailed breakdown of the parsed and executed query).
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.enableDidYouMean", "notSupportedIn": "", "comment": "Whether to enable query corrections on this query (see DidYouMean).
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.enableLowercaseOperators", "notSupportedIn": "", "comment": "Whether to interpret the AND, NOT, OR, and NEAR keywords in the basic\nexpression as query operators, even if those keywords are in lowercase.\nSetting this attribute to true has no effect unless enableQuerySyntax\nis also true.
Note:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.enablePartialMatch", "notSupportedIn": "", "comment": "Normally, the
\nenableLowercaseOperatorsoption of the\nQueryboxcomponent determines the value of this attribute during the initialization of the\nsearch page.
Whether to automatically convert the basic expression to a partial match\nexpression if it contains at least a certain number of keywords (see\npartialMatchKeywords), so that items containing at least a certain\nsubset of those keywords (see partialMatchThreshold) will match the\nquery.\nNote:
\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.enableQuerySyntax", "notSupportedIn": "", "comment": "Normally, the
\nenablePartialMatchoption of the\nQueryboxcomponent determines the value of this attribute during the initialization of the\nsearch page.
Whether to interpret special query syntax (e.g., @objecttype=message) in the basic\nexpression (see\nCoveo Query Syntax Reference).\nSee also enableLowercaseOperators.
Note:
\n\n\nNormally, the
\nenableQuerySyntaxoption of the\nQueryboxcomponent determines the value of this attribute during the initialization of the\nsearch page. End user preferences can also modify the value of this attribute.
Default value is false
Whether to interpret question mark characters (?) in the basic expression\nkeywords (see Using Wildcards in Queries.\nSetting this attribute to true has no effect unless enableWildcards is\nalso true.
Note:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.enableWildcards", "notSupportedIn": "", "comment": "Normally, the
\nenableQuestionMarksoption of the\nQueryboxcomponent determines the value of this attribute during the initialization of the\nsearch page.
Whether to interpret wildcard characters (*) in the basic expression keywords.\nSetting this attribute to true enables the wildcards features of the index, effectively expanding keywords\ncontaining wildcard characters (*) to the possible matching keywords in order to broaden the query (see\nUsing Wildcards in Queries).
See also enableQuestionMarks.
Note:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.excerptLength", "notSupportedIn": "", "comment": "Normally, the
\nenableWildcardsoption of the\nQueryboxcomponent determines the value of this attribute during the initialization of the\nsearch page.
Specifies the length (in number of characters) of the excerpts generated by the indexer based on the keywords present in the query.\nThe index includes the top most interesting sentences (in the order they appear in the item) that fit in the specified number of characters.
\nWhen not specified, the default value is 200.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.expression", "notSupportedIn": "", "comment": "Used to build the basic part of the query expression.\nThis part typically consists of user-entered content such as query keywords, etc.
\n", "type": "ExpressionBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.facetOptions", "notSupportedIn": "", "comment": "The global configuration options to apply to the requests in the facets array.
\n", "type": "IFacetOptions", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.facetRequests", "notSupportedIn": "", "comment": "Specifies an array of request for the DynamicFacet component.\nCannot be used alongside groupByRequests
Specifies a field on which Folding should be performed.\nFolding is a kind of duplicate filtering where only the first result with any given value of the field is included in the result set.
\nIt's typically used to return only one result in a conversation, for example when forum posts in a thread are indexed as separate items.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.filterFieldRange", "notSupportedIn": "", "comment": "Number of results that should be folded, using the IQuery.filterField.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.firstResult", "notSupportedIn": "", "comment": "This is the 0-based index of the first result to return.\nIf not specified, this parameter defaults to 0.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.groupByRequests", "notSupportedIn": "", "comment": "Specifies an array of Group By operations that can be performed on the query results to extract facets.\nCannot be used alongside facetRequests
The contextual text.\nThis is the contextual text part of the query. It uses the Coveo Machine Learning service to pick key keywords from the text and add them to the basic expression.\nThis field is mainly used to pass context such a case description, long textual query or any other form of text that might help in\nrefining the query.
\n", "type": "ExpressionBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.maximumAge", "notSupportedIn": "", "comment": "The maximum age for cached query results, in milliseconds.\nIf results for the exact same request (including user identities) are available in the in-memory cache, they will be used if they are not older than the specified value.
\nOtherwise, the query will be sent to the index.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.numberOfResults", "notSupportedIn": "", "comment": "This is the number of results to return, starting from IQuery.firstResult.\nIf not specified, this parameter defaults to 10.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.parentField", "notSupportedIn": "", "comment": "Specifies the parentField when doing parent-child loading (See: Folding).
The minimum number of keywords that need to be present in the basic expression\nto convert it to a partial match expression.\nThe value of this attribute has no meaning unless enablePartialMatch is\ntrue.
See also partialMatchThreshold.
Note:
\n\n\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.partialMatchThreshold", "notSupportedIn": "", "comment": "Normally, the
\npartialMatchKeywordsoption of the\nQueryboxcomponent determines the value of this attribute during the initialization of the\nsearch page.
An absolute or relative (percentage) value indicating the minimum number of partial match expression keywords an\nitem must contain to match the query.\nThe value of this attribute has no meaning unless enablePartialMatch is\ntrue.
See also partialMatchKeywords.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.pipeline", "notSupportedIn": "", "comment": "Normally, the
\npartialMatchThresholdoption of the\nQueryboxcomponent determines the value of this attribute during the initialization of the\nsearch page.
Name of the query pipeline to use.\nSpecifies the name of the query pipeline to use for the query. If not specified, the default value is default, which means the default query pipeline will be used.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.queryFunctions", "notSupportedIn": "", "comment": "Specifies an array of Query Function operation that will be executed on the results.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.rankingFunctions", "notSupportedIn": "", "comment": "Specifies an array of Ranking Function operations that will be executed on the results.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.recommendation", "notSupportedIn": "", "comment": "This is the ID of the recommendation interface that generated the query.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.searchHub", "notSupportedIn": "", "comment": "The hub value set from the Analytics component.\nUsed for analytics reporting in the Coveo platform.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.sortCriteria", "notSupportedIn": "", "comment": "Specifies the sort criterion(s) to use to sort results. If not specified, this parameter defaults to relevancy.\nPossible values are :
\n-- relevancy : This uses all the configured ranking weights as well as any specified ranking expressions to rank results.
\n-- dateascending / datedescending Sort using the value of the @date field, which is typically the last modification date of an item in the index.
\n-- qre : Sort using only the weights applied through ranking expressions. This is much like using relevancy except that automatic weights based on keyword proximity etc, are not computed.
\n-- nosort : Do not sort the results. The order in which items are returned is essentially random.
\n-- @field ascending / @field descending Sort using the value of a custom field.
The tab value set from the Tab component.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryBuilder.userActions", "notSupportedIn": "", "comment": "A request to retrieve user actions in the query response.
\n", "type": "IUserActionsRequest", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryController", "notSupportedIn": "", "comment": "This class is automatically instantiated and bound to the root of your search interface when you initialize the framework.
\nIt is essentially a singleton that wraps the access to the SearchEndpoint endpoint to execute query, and is in charge of triggering the different query events.
\nThis is what every component of the framework uses internally to execute query or access the endpoint.
\nWhen calling Coveo.executeQuery this class is used.
A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryController.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryController.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Create a new query controller
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryEvents", "notSupportedIn": "", "comment": "This static class is there to contains the different string definition for all the events related to query.\nNote that these events will only be triggered when the QueryController.executeQuery method is used, either directly or by using executeQuery
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryEvents.buildingQuery", "notSupportedIn": "", "comment": "Triggered when the query is being built.\nThis is typically where all components will contribute their part to the IQuery using the QueryBuilder.
\nAll bound handlers will receive IBuildingQueryEventArgs as an argument.
\nThe string value is buildingQuery.
Triggered after the main query success event has finished executing.\nThis is typically where facets will process the IGroupByResult and render themselves.
\nAll bound handlers will receive IQuerySuccessEventArgs as an argument.
\nThe string value is deferredQuerySuccess.
Triggered when the query is done being built.\nThis is typically where the facet will add it's IGroupByRequest to the IQuery.
\nAll bound handlers will receive IDoneBuildingQueryEventArgs as an argument.
\nThe string value is doneBuildingQuery.
Triggered when more results are being fetched on the Search API (think : infinite scrolling, or pager).\nAll bound handlers will receive IDuringQueryEventArgs as an argument.
\nThe string value is duringFetchMoreQuery.
Triggered when the query is being executed on the Search API.\nAll bound handlers will receive IDuringQueryEventArgs as an argument.
\nThe string value is duringQuery.
Triggered when a more results were successfully returned from the Search API. (think : infinite scrolling, or pager).\nAll bound handlers will receive IFetchMoreSuccessEventArgs as an argument.
\nThe string value is fetchMoreSuccess.
Triggered when a new query is launched.\nAll bound handlers will receive INewQueryEventArgs as an argument.
\nThe string value is newQuery.
Triggered when there is no result for a particular query.\nAll bound handlers will receive INoResultsEventArgs as an argument.
\nThe string value is noResults.
Triggered before the QueryEvents.fetchMoreSuccess event.\nThis allows external code to modify the results before rendering them.
\nFor example, the Folding component might use this event to construct a coherent parent child relationship between query results.
\nAll bound handlers will receive IPreprocessResultsEventArgs as an argument.
\nThe string value is preprocessMoreResults.
Triggered before the QueryEvents.querySuccess event.\nThis allows external code to modify the results before rendering them.
\nFor example, the Folding component might use this event to construct a coherent parent child relationship between query results.
\nAll bound handlers will receive IPreprocessResultsEventArgs as an argument.
\nThe string value is preprocessResults.
Triggered when there was an error executing a query on the Search API.\nAll bound handlers will receive IQueryErrorEventArgs as an argument.
\nThe string value is queryError.
Triggered when a query successfully returns from the Search API.\nAll bound handlers will receive IQuerySuccessEventArgs as an argument.
\nThe string value is querySuccess.
The QueryStateModel class is a key-value store which contains the current state of the components that can affect\nthe query (see State). This class inherits from the Model\nclass. Optionally, it is possible to persist the state in the query string in order to enable browser history\nmanagement (see the HistoryController class).\nComponents set values in the QueryStateModel instance to reflect their current state. The QueryStateModel\ntriggers state events (see eventTypes) whenever one of its values is modified. Components\nlisten to triggered state events to update themselves when appropriate.
For instance, when a query is triggered, the Searchbox component sets the q attribute (the\nbasic query expression), while the Pager component sets the first attribute (the index of the\nfirst result to display in the result list), and so on.
Example:
\n\n\nThe user modifies the content of the
\nSearchboxand submits a query. This triggers the following state events:\n
\n- \n
state:change:q(because the value ofqhas changed).- \n
state:change(because at least one value has changed in theQueryStateModel).Components or external code can attach handlers to those events:
\n\nCoveo.$$(document).on('state:change:q', function() {\n [ ... ]\n});\n
Note:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryStateModel.attributes", "notSupportedIn": "", "comment": "Normally, you should interact with the
\nQueryStateModelinstance using theCoveo.statetop-level\nfunction.
The attributes contained in this model.\nNormally, you should not set attributes directly on this property, as this would prevent required events from being triggered.
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryStateModel.disabled", "notSupportedIn": "", "comment": "A disabled component will not participate in the query, or listen to ComponentEvents.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryStateModel.logger", "notSupportedIn": "", "comment": "Allows component to log in the dev console.
\n", "type": "Logger", "constrainedValues": [], "miscAttributes": {} }, { "name": "QueryStateModel.ID", "notSupportedIn": "", "comment": "The static ID that each component needs in order to be identified.
\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
The event types that can be triggered:
\n• preprocess: triggered before a value is set on an attribute. This allows the value to be modified before it is set.
\n• changeOne: triggered when a single value changes.\n• change: triggered when one or many values change.\n• reset: triggered when all attributes are reset to their default values. \n• all: triggered after the change event.
Creates a new QueryStateModel instance.
This static class is there to contains the different string definition for all the events related to the AdvancedSearch component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuerySummaryEvents.cancelLastAction", "notSupportedIn": "", "comment": "Triggered when the last action is being cancelled by the query summary component\nAllows external code to revert their last action.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "QuickviewEvents", "notSupportedIn": "", "comment": "The QuickviewEvents static class contains the string definitions of all events that strongly relate to the\nQuickview component.
Triggered by the QuickviewDocument component when the end user has just clicked the\nQuickview button/link to open the quickview modal window.\nThis event allows external code to modify the terms to highlight before the content of the quickview modal window\nis rendered.
All openQuickview event handlers receive an\nOpenQuickviewEventArgs object as an argument.
Triggered by the QuickviewDocument component when the content to display in the\nquickview modal window has just finished downloading.\nThe Quickview component listens to this event to know when to remove its loading animation.
All quickviewLoaded event handlers receive a QuickviewLoadedEventArgs object\nas an argument.
A radio button widget with standard styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "RadioButton.constructor", "notSupportedIn": "", "comment": "Creates a new RadioButton.
This class serves as a way to get and set the different screen size breakpoints for the interface.\nBy setting those, you can impact, amongst others, the Facet's, Tab's or the ResultList's behaviour.
\nFor example, the Facet components of your interface will switch to a dropdown menu when the screen size reaches 800px or less.
\nYou could modify this value using this calls
Normally, you would interact with this class using the instance bound to SearchInterface.responsiveComponents
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultListEvents", "notSupportedIn": "", "comment": "The ResultListEvents static class contains the string definitions of all events that strongly relate to the result\nlist.\nSee Events.
Triggered by the ResultLayout component whenever the current result layout changes (see\nResult Layouts).\nAll changeLayout event handlers receive a ChangeLayoutEventArgs object as an\nargument.
Triggered each time the result list has just finished rendering a single result.\nAll newResultDisplayed event handlers receive a\nDisplayedNewResultEventArgs object as an argument.
Triggered when the result list has just finished rendering the current page of results.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultListEvents.openQuickview", "notSupportedIn": "", "comment": "Triggered by the ResultLink result template component when its\nopenQuickview option is set to true and the end user clicks the\nresult link. The Quickview component listens to this event to be able to open the quickview\nmodal window in reaction.\nSee also the openQuickview event (which is identical to this one, except\nthat it is triggered by the [QuickviewDocument] result template component instead).
All openQuickview event handlers receive an OpenQuickviewEventArgs object as\nan argument
Those are the string definitions of events for ResultPreviewsManager.\nThose events should be bound to the element returned by resolveRoot.
Executed when building a query to fetch result previews.\nThis always receives IBuildingResultPreviewsQueryEventArgs as arguments.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultPreviewsManagerEvents.populateSearchResultPreviews", "notSupportedIn": "", "comment": "Executed when a Suggestion is focused and waiting for search result previews.\nThis always receives IPopulateSearchResultPreviewsEventArgs as arguments.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResultPreviewsManagerEvents.updateResultPreviewsManagerOptions", "notSupportedIn": "", "comment": "Executed when a Suggestion is focused before PopulateSearchResultPreviews is called to fetch more options.\nThis always receives IUpdateResultPreviewsManagerOptionsEventArgs as arguments.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "SearchEndpoint", "notSupportedIn": "", "comment": "The SearchEndpoint class allows the framework to perform HTTP requests against the Search API (e.g., searching, getting query suggestions, getting the HTML preview of an item, etc.).\nNote:
When writing custom code that interacts with the Search API, be aware that executing queries directly through an instance of this class will not trigger any query events.
\nIn some cases, this may be what you want. However, if you do want query events to be triggered (e.g., to ensure that standard components update themselves as expected), use the queryController instance instead.
A map of all initialized SearchEndpoint instances.\nExample: Coveo.SearchEndpoint.endpoints["default"] returns the default endpoint that was created at initialization.
Creates a new SearchEndpoint instance.\nUses a set of adequate default options, and merges these with the options parameter.\nAlso creates an EndpointCaller instance and uses it to communicate with the endpoint\ninternally.
The StandaloneSearchInterfaceEvents static class contains the string definitions of all events that strongly relate to the standalone search interface.
Triggered by the StandaloneSearchBox component during initialization, just before redirecting to the full search page.
The StaticPositionProvider class provides a static end user position to a\nDistanceResources component.
Holds a reference to all template available in the framework
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TemplateHelpers", "notSupportedIn": "", "comment": "Allow to register and return template helpers (essentially: Utility functions that can be executed in the context of a template to render complex elements).
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TextInput", "notSupportedIn": "", "comment": "A text input widget with standard styling.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "TextInput.constructor", "notSupportedIn": "", "comment": "Creates a new TextInput.
Describe a section in the AdvancedSearch component
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAdvancedSearchSection.inputs", "notSupportedIn": "", "comment": "The array of inputs to populate.\nExternal code should only push inputs that match the type BaseFormTypes.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAdvancedSearchSection.name", "notSupportedIn": "", "comment": "The name of the section.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsActionCause", "notSupportedIn": "", "comment": "The IAnalyticsActionCause interface describes the cause of an event for the analytics service.\nSee the Analytics component
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsActionCause.name", "notSupportedIn": "", "comment": "Specifies the name of the event. While you can actually set this property to any arbitrary string value, its value\nshould uniquely identify the precise action that triggers the event. Thus, each individual event should have its\nown unique name value.\nExample: searchBoxSubmit, resultSort, etc.
Specifies the type of the event. While you can actually set this property to any arbitrary string value, it should\ndescribe the general category of the event. Thus, more than one event can have the same type value, which makes\nit possible to group events with identical types when doing reporting.\nExample: All search box related events could have searchbox as their type value.
Describes the object sent as metadata along with clickQuerySuggestPreview usage analytics events.
The 0-based position of the preview item that was opened.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsClickQuerySuggestPreviewMeta.suggestion", "notSupportedIn": "", "comment": "The query suggestion for which a preview item was opened.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsClient", "notSupportedIn": "", "comment": "The IAnalyticsClient interface describes an analytics client that can log events to, or return information from the\nusage analytics service.\nSee also the Analytics component.
The IAnalyticsDocumentViewEventArgs interface describes the object that all\ndocumentViewEvent handlers receive as an argument.
The data to send in the request body of the Usage Analytics Write REST API call that logs the click event.
The common subset of fields used to describe Coveo Cloud usage analytics search, click, and custom events.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsEvent.actionCause", "notSupportedIn": "", "comment": "A unique name describing the action that triggered the event.\nSee the name property of the IAnalyticsActionCause interface.
Example: pagerNext
A name describing the category of actions to which the action that triggered the event belongs.\nSee the type property of the IAnalyticsActionCause interface.
Example: getMoreResults
Whether the event should be logged anonymously to the Coveo Cloud usage analytics service.\nNote: This field is normally set to the anonymous option value of the Analytics component.
A GUID representing the current user. This GUID is generated locally and stored in a non-expiring browser cookie.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsEvent.customData", "notSupportedIn": "", "comment": "Additional metadata to send along with the event.\nNote: This field may include custom user context information (see Sending Custom Context Information).
\nExample: { "currentResultsPerPage": 25, "userRole": "developer" }
The name of the device or browser that triggered the event.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
Example: Chrome
The language of the search interface from which the event originates.\nMust be a valid ISO-639-1 code.
\nNote: By default, the framework sets this field according to the currently loaded culture file (see Changing the Language of Your Search Interface).
\nExample: en
Whether the event originates from a mobile device.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
The broad application context from which the event originates.\nNote: By default, the framework sets this field to Search. However, you can use the setOriginContext method of the Analytics component to modify the default value.
Example: Search
The identifier of the search interface from which the event originates.\nNote: This field is normally set through the searchHub option of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: PartnerPortalSearch
The identifier of the tab from which the event originates.\nNote: The framework normally sets this field to the identifier of the currently selected Tab in the search interface.
Example: All
The address of the webpage that linked to the search interface from which the event originates.\nNote: The framework normally sets this field to the current document.referrer value.
Example: http://example.com/
The time it took to get a response from the Search API for the query related to the event (in milliseconds).\nNote: The framework normally sets this field to 0, except for search events in which case it sets the field by retrieving the information from the related Search API query response.
The unique identifier of the related query.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: 74682726-0e20-46eb-85ac-f37259346f57
The software acting on behalf of the end-user whose action triggered the event.\nNote: By default, the framework sets this field to the current navigator.userAgent value.
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36
The display name of the end-user whose action triggered the event.\nNote: This field is normally set to the userDisplayName option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: Alice Smith
The groups the end-user whose action triggered the event belongs to.\nNote: This field is normally left undefined, and the Coveo Cloud usage analytics service attempts to extract the information from the search token when actually recording the event.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsEvent.username", "notSupportedIn": "", "comment": "The identifier of the end-user whose action triggered the event.\nNote: This field is normally set to the user option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: `asmith@example.com`
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsEventArgs", "notSupportedIn": "", "comment": "The object that all analyticsEventReady handlers receive as an argument.
The fields describing the Coveo Cloud usage analytics event.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsEventArgs.event", "notSupportedIn": "", "comment": "The type of Coveo Cloud usage analytics event.
\n", "type": "", "constrainedValues": [ "CoveoCustomEvent,CoveoClickEvent,CoveoSearchEvent" ], "miscAttributes": {} }, { "name": "IAnalyticsFacetState", "notSupportedIn": "", "comment": "Describes the current condition of a single dynamic facet value.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsFacetState.displayValue", "notSupportedIn": "", "comment": "The custom display name of the dynamic facet value that was interacted with.\nExample: Alice R. Smith
The maximum value of the dynamic range facet value.\nExamples:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsFacetState.endInclusive", "notSupportedIn": "", "comment": "\n
\n- \n
500- \n
2018-12-31T23:59:59.999Z
Whether the end value is included in the dynamic range facet value.
The type of values displayed in the dynamic facet.
\n", "type": "FacetType", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsFacetState.field", "notSupportedIn": "", "comment": "The name of the field the dynamic facet displaying the value is based on.\nExample: author
The unique identifier of the dynamic facet displaying the value.\nExample: author
The minimum value of the dynamic range facet value.\nExamples:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsFacetState.state", "notSupportedIn": "", "comment": "\n
\n- \n
0- \n
2018-01-01T00:00:00.000Z
The new state of the dynamic facet value that was interacted with.
\n", "type": "FacetValueState", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsFacetState.title", "notSupportedIn": "", "comment": "The title of the dynamic facet.\nExample: Author
The original name (i.e., field value) of the dynamic facet value.\nExample: alice_r_smith
The current 1-based position of the dynamic facet value, relative to other values in the same dynamic facet.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnchorUtilsOptions", "notSupportedIn": "", "comment": "Options for building an <a> tag.
The CSS class(es) of the tag.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnchorUtilsOptions.target", "notSupportedIn": "", "comment": "The target (href attribute).
The tag's text content.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBadgeColors", "notSupportedIn": "", "comment": "Badge Colors
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBeforeRedirectEventArgs", "notSupportedIn": "", "comment": "The IBeforeRedirectEventArgs interface describes the object that all\nbeforeRedirect event handlers receive as an argument.
If this property is set to true by a beforeRedirect event handler, the StandaloneSearchBox component will not redirect to the full search page.
The URI of the page that the search interface will redirect to when a query is performed by the StandaloneSearchBox component.
Represent an item to insert in the breadcrumb
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBreadcrumbItem.element", "notSupportedIn": "", "comment": "The HTMLElement to insert in the breadcrumb
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBuildingAdvancedSearchEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on AdvancedSearchEvents.buildingAdvancedSearch
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBuildingAdvancedSearchEventArgs.executeQuery", "notSupportedIn": "", "comment": "An easy way to execute a new query.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBuildingAdvancedSearchEventArgs.sections", "notSupportedIn": "", "comment": "Sections which external code can populate by pushing into this array.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBuildingQueryEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QueryEvents.buildingQuery
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBuildingQueryEventArgs.cancel", "notSupportedIn": "", "comment": "If this property is set to true by any handlers, the query will not be executed.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBuildingQueryEventArgs.queryBuilder", "notSupportedIn": "", "comment": "Allow handlers to modify the query by using the QueryBuilder
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "IBuildingQueryEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Determine if the query is a "search-as-you-type"
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs", "notSupportedIn": "", "comment": "The IChangeAnalyticsCustomDataEventArgs interface describes the object that all\nchangeAnalyticsCustomData event handlers receive as an argument.\nThis interface extends the IChangeableAnalyticsDataObject interface.
Notes:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.actionCause", "notSupportedIn": "", "comment": "\n
\n- External code can only modify the attributes described by the
\nIChangeableAnalyticsDataObjectinterface.- When the analytics event being logged is a
\nClickEvent, theChangeAnalyticsCustomDataEventArgsobject also\ncontains aresultDataattribute, which describes theQueryResultthat was clicked.\nExternal code cannot modify this object.
The cause of the usage analytics event.\nFor instance, triggering a query using the search box logs a usage analytics event with searchBoxSubmit as its\nactionCause, whereas triggering a query by selecting a facet value logs a usage analytics event with\nfacetSelect as its actionCause.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.actionType", "notSupportedIn": "", "comment": "External code cannot modify the value of this attribute.
\n
The generic action type of the usage analytics event.\nAll analytics events that strongly relate to a certain feature or component usually share the same actionType.
For instance, all usage analytics events relating to the Facet component have facet as their\nactionType, whereas all usage analytics events relating to the Breadcrumb component have\nbreadcrumb as their actionType.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.language", "notSupportedIn": "", "comment": "External code cannot modify the value of this attribute.
\n
The language of the search interface from which the usage analytics event originates.\nBy default, the framework populates this attribute with the currently loaded localization and culture file of the\nsearch interface from which the usage analytics event originates.
\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.metaObject", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The metadata to send along with the usage analytics event.\nNote:
\n\n\n", "type": "IChangeableAnalyticsMetaObject", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.originLevel1", "notSupportedIn": "", "comment": "External code can modify existing values, or add new key-value pairs in this attribute.
\n
The high-level origin of the usage analytics event.\nFor instance, this could be the name of the search hub, or a name that can uniquely identify the search page from\nwhich the usage analytics event originates.
\nDefault value is default.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.originLevel2", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The mid-level origin of the usage analytics event.\nBy default, the framework populates this attribute with the data-id of the currently selected tab in the search\ninterface from which the usage analytics event originates.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.originLevel3", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The low-level origin of the usage analytics event.\nFor instance, this could be the HTTP identifier of the page from which the usage analytics event originates.
\nDefault value is the empty string.
\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeAnalyticsCustomDataEventArgs.type", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The type of the usage analytics event.\nNote:
\n\n\n", "type": "", "constrainedValues": [ "SearchEvent,CustomEvent,ClickEvent" ], "miscAttributes": {} }, { "name": "IChangeLayoutEventArgs", "notSupportedIn": "", "comment": "External code cannot modify the value of this attribute.
\n
The IChangeLayoutEventArgs interface describes the object that all\nChangeLayout event handlers receive as an argument.
The name of the new layout.
\n", "type": "ValidLayout", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeLayoutEventArgs.results", "notSupportedIn": "", "comment": "The current page of results.
\n", "type": "IQueryResults", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeableAnalyticsDataObject", "notSupportedIn": "", "comment": "The IChangeableAnalyticsDataObject interface describes the modifiable part of the object that all\nchangeAnalyticsCustomData event handlers receive as an argument.
The language of the search interface from which the usage analytics event originates.\nBy default, the framework populates this attribute with the currently loaded localization and culture file of the\nsearch interface from which the usage analytics event originates.
\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeableAnalyticsDataObject.metaObject", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The metadata to send along with the usage analytics event.\nNote:
\n\n\n", "type": "IChangeableAnalyticsMetaObject", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeableAnalyticsDataObject.originLevel1", "notSupportedIn": "", "comment": "External code can modify existing values, or add new key-value pairs in this attribute.
\n
The high-level origin of the usage analytics event.\nFor instance, this could be the name of the search hub, or a name that can uniquely identify the search page from\nwhich the usage analytics event originates.
\nDefault value is default.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeableAnalyticsDataObject.originLevel2", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The mid-level origin of the usage analytics event.\nBy default, the framework populates this attribute with the data-id of the currently selected tab in the search\ninterface from which the usage analytics event originates.
Note:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeableAnalyticsDataObject.originLevel3", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The low-level origin of the usage analytics event.\nFor instance, this could be the HTTP identifier of the page from which the usage analytics event originates.
\nDefault value is the empty string.
\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IChangeableAnalyticsMetaObject", "notSupportedIn": "", "comment": "External code can modify the value of this attribute.
\n
The IChangeableAnalyticsMetaObject interface describes the metadata which can be sent along with any usage\nanalytics event.
Describes a Coveo Cloud usage analytics click event.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IClickEvent.actionCause", "notSupportedIn": "", "comment": "A unique name describing the action that triggered the event.\nSee the name property of the IAnalyticsActionCause interface.
Example: pagerNext
A name describing the category of actions to which the action that triggered the event belongs.\nSee the type property of the IAnalyticsActionCause interface.
Example: getMoreResults
Whether the event should be logged anonymously to the Coveo Cloud usage analytics service.\nNote: This field is normally set to the anonymous option value of the Analytics component.
A GUID representing the current user. This GUID is generated locally and stored in a non-expiring browser cookie.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IClickEvent.collectionName", "notSupportedIn": "", "comment": "The name of the collection to which the clicked query result item belongs.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: default
Additional metadata to send along with the event.\nNote: This field may include custom user context information (see Sending Custom Context Information).
\nExample: { "currentResultsPerPage": 25, "userRole": "developer" }
The name of the device or browser that triggered the event.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
Example: Chrome
The type of query result item that was clicked.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: FAQ
The 1-based position of the clicked item in the query results set.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IClickEvent.documentTitle", "notSupportedIn": "", "comment": "The title of the clicked query result item.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: Coveo ML Frequently Asked Questions
The URI of the clicked query result item.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: http://www.example.com/org:organization/articletype:FAQ/article:aB1c2000000A1BcDEF/language:en_US
The hashed URI of the clicked query result item.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: AbCñdeFghiJKLM1n
The URL of the clicked query result item.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: https://example.com/aB1c2000000A1Bc
The language of the search interface from which the event originates.\nMust be a valid ISO-639-1 code.
\nNote: By default, the framework sets this field according to the currently loaded culture file (see Changing the Language of Your Search Interface).
\nExample: en
Whether the event originates from a mobile device.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
The broad application context from which the event originates.\nNote: By default, the framework sets this field to Search. However, you can use the setOriginContext method of the Analytics component to modify the default value.
Example: Search
The identifier of the search interface from which the event originates.\nNote: This field is normally set through the searchHub option of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: PartnerPortalSearch
The identifier of the tab from which the event originates.\nNote: The framework normally sets this field to the identifier of the currently selected Tab in the search interface.
Example: All
The address of the webpage that linked to the search interface from which the event originates.\nNote: The framework normally sets this field to the current document.referrer value.
Example: http://example.com/
The name of the query pipeline to which the Search API query that returned the clicked result item was routed.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: PartnerPortalSearchPipeline
The ranking modifier that was applied to the clicked query result item.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: Reveal ART
The time it took to get a response from the Search API for the query related to the event (in milliseconds).\nNote: The framework normally sets this field to 0, except for search events in which case it sets the field by retrieving the information from the related Search API query response.
The unique identifier of the related query.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: 74682726-0e20-46eb-85ac-f37259346f57
The name of the source that contains the clicked query result item.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: Product Documentation
The name of the A/B test that applied to the related Search API query.\nNote: This field is normally set by the splitTestRunName option of the Analytics component. However, if this option is left undefined, the framework attempts to set this field by retrieving information from the related Search API query response.
Example: Testing new ART model
The version of the A/B test that applied to the related Search API query (i.e., version A or version B).\nNote: This field is normally set by the splitTestRunVersion option of the Analytics component. However, if this option is left undefined and the related Search API query response indicates that an A/B test was applied, the framework sets this field to the name of the query pipeline to which the query was routed.
Example: PartnerPortalSearchPipelineWithART
The software acting on behalf of the end-user whose action triggered the event.\nNote: By default, the framework sets this field to the current navigator.userAgent value.
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36
The display name of the end-user whose action triggered the event.\nNote: This field is normally set to the userDisplayName option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: Alice Smith
The groups the end-user whose action triggered the event belongs to.\nNote: This field is normally left undefined, and the Coveo Cloud usage analytics service attempts to extract the information from the search token when actually recording the event.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IClickEvent.username", "notSupportedIn": "", "comment": "The identifier of the end-user whose action triggered the event.\nNote: This field is normally set to the user option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: `asmith@example.com`
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IClickEvent.viewMethod", "notSupportedIn": "", "comment": "The way the item was clicked.\nNote: The framework normally sets this field to the exact same value as actionCause.
Example: documentOpen
A Search API commerce request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICommerceRequest.catalogId", "notSupportedIn": "", "comment": "The unique identifier of the catalog to query.\nExample: 46bc4275-e613-4dd5-b1ea-3e5aca1bcd9d
A mandatory query expression to apply if the commerce request affects the query.\nExample: @storeid==1001
The way the commerce request should affect query results.\nExample: selectCatalogObjects
The bindings, or environment in which each component exists.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentBindings.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentBindings.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentBindings.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentBindings.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Triggers state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentBindings.root", "notSupportedIn": "", "comment": "The root HTMLElement of the SearchInterface in which the component exists.
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentBindings.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentBindings.usageAnalytics", "notSupportedIn": "", "comment": "A reference to the Analytics.client.
\n", "type": "IAnalyticsClient", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentDefinition", "notSupportedIn": "", "comment": "Definition for a Component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentDefinition.ID", "notSupportedIn": "", "comment": "The static ID that each component need to be identified.
\nFor example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
The generated className for this component.
\nFor example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Function that can be called to export one or multiple module in the global scope.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentDefinition.fields", "notSupportedIn": "", "comment": "The optional index fields that the component possess or display.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentDefinition.options", "notSupportedIn": "", "comment": "The available options for the component.
\n", "type": "any", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentDefinition.parent", "notSupportedIn": "", "comment": "The optional parent of the component, which will be a component itself.
\n", "type": "IComponentDefinition", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentDefinition.constructor", "notSupportedIn": "", "comment": "Constructor for each component
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs", "notSupportedIn": "", "comment": "The IComponentLocalizedStringOptionArgs interface describes the available parameters when building a\nfields option.
Specifies an alias, or array of aliases, which can be used instead of the actual option name.\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.attrName", "notSupportedIn": "", "comment": "This can be useful to modify an option name without introducing a breaking change.
\n
Specifies a different markup name to use for an option, rather than the standard name (i.e., data- followed by\nthe hyphened name of the option).\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.defaultFunction", "notSupportedIn": "", "comment": "This should only be used for backward compatibility reasons.
\n
Specifies a function that should return the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.depend", "notSupportedIn": "", "comment": "Specifies the name of a boolean component option which must be true in order for this option to function\nproperly.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.deprecated", "notSupportedIn": "", "comment": "This is mostly useful for the Coveo JavaScript Interface Editor.
\n
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization\nif the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why\nthe option is deprecated, and what now replaces it.\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.postProcessing", "notSupportedIn": "", "comment": "Deprecated options do not appear in the Coveo JavaScript Interface Editor.
\n
Specifies a function that should allow a component option to further modify its own value once all other options\nof that component have been built.\nExample:
\n\n\n", "type": "IComponentOptionsPostProcessing", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.required", "notSupportedIn": "", "comment": "By default, the
\nidoption of theFacetcomponent uses a post processing function to\nset its value to that of thefieldoption.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to\nfunction properly.\nExample:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.section", "notSupportedIn": "", "comment": "The
\nfieldoption of theFacetcomponent is required, since a facet cannot\nfunction properly without a field.
Specifies a section name inside which the option should appear in the Coveo JavaScript Interface Editor.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentLocalizedStringOptionArgs.validator", "notSupportedIn": "", "comment": "Specifies a function that should indicate whether the option value is valid.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions", "notSupportedIn": "", "comment": "The IComponentOptions interface describes the available parameters when building any kind of component\noption.
Specifies an alias, or array of aliases, which can be used instead of the actual option name.\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.attrName", "notSupportedIn": "", "comment": "This can be useful to modify an option name without introducing a breaking change.
\n
Specifies a different markup name to use for an option, rather than the standard name (i.e., data- followed by\nthe hyphened name of the option).\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.defaultFunction", "notSupportedIn": "", "comment": "This should only be used for backward compatibility reasons.
\n
Specifies a function that should return the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.defaultValue", "notSupportedIn": "", "comment": "Specifies the value the option must take when no other value is explicitly specified.
\n", "type": "T", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.depend", "notSupportedIn": "", "comment": "Specifies the name of a boolean component option which must be true in order for this option to function\nproperly.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.deprecated", "notSupportedIn": "", "comment": "This is mostly useful for the Coveo JavaScript Interface Editor.
\n
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization\nif the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why\nthe option is deprecated, and what now replaces it.\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.postProcessing", "notSupportedIn": "", "comment": "Deprecated options do not appear in the Coveo JavaScript Interface Editor.
\n
Specifies a function that should allow a component option to further modify its own value once all other options\nof that component have been built.\nExample:
\n\n\n", "type": "IComponentOptionsPostProcessing", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.required", "notSupportedIn": "", "comment": "By default, the
\nidoption of theFacetcomponent uses a post processing function to\nset its value to that of thefieldoption.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to\nfunction properly.\nExample:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.section", "notSupportedIn": "", "comment": "The
\nfieldoption of theFacetcomponent is required, since a facet cannot\nfunction properly without a field.
Specifies a section name inside which the option should appear in the Coveo JavaScript Interface Editor.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptions.validator", "notSupportedIn": "", "comment": "Specifies a function that should indicate whether the option value is valid.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption", "notSupportedIn": "", "comment": "The IComponentOptionsTemplateOptionArgs interface describes the available parameters when building a\ntemplate option.
Specifies an alias, or array of aliases, which can be used instead of the actual option name.\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.attrName", "notSupportedIn": "", "comment": "This can be useful to modify an option name without introducing a breaking change.
\n
Specifies a different markup name to use for an option, rather than the standard name (i.e., data- followed by\nthe hyphened name of the option).\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.defaultFunction", "notSupportedIn": "", "comment": "This should only be used for backward compatibility reasons.
\n
Specifies a function that should return the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.defaultValue", "notSupportedIn": "", "comment": "Specifies the value the option must take when no other value is explicitly specified.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.depend", "notSupportedIn": "", "comment": "Specifies the name of a boolean component option which must be true in order for this option to function\nproperly.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.deprecated", "notSupportedIn": "", "comment": "This is mostly useful for the Coveo JavaScript Interface Editor.
\n
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization\nif the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why\nthe option is deprecated, and what now replaces it.\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.postProcessing", "notSupportedIn": "", "comment": "Deprecated options do not appear in the Coveo JavaScript Interface Editor.
\n
Specifies a function that should allow a component option to further modify its own value once all other options\nof that component have been built.\nExample:
\n\n\n", "type": "IComponentOptionsPostProcessing", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.required", "notSupportedIn": "", "comment": "By default, the
\nidoption of theFacetcomponent uses a post processing function to\nset its value to that of thefieldoption.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to\nfunction properly.\nExample:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.section", "notSupportedIn": "", "comment": "The
\nfieldoption of theFacetcomponent is required, since a facet cannot\nfunction properly without a field.
Specifies a section name inside which the option should appear in the Coveo JavaScript Interface Editor.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOption.validator", "notSupportedIn": "", "comment": "Specifies a function that should indicate whether the option value is valid.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs", "notSupportedIn": "", "comment": "The IComponentOptionsFieldOptionArgs interface describes the available parameters when building a\nfield option.
Specifies an alias, or array of aliases, which can be used instead of the actual option name.\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.attrName", "notSupportedIn": "", "comment": "This can be useful to modify an option name without introducing a breaking change.
\n
Specifies a different markup name to use for an option, rather than the standard name (i.e., data- followed by\nthe hyphened name of the option).\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.defaultFunction", "notSupportedIn": "", "comment": "This should only be used for backward compatibility reasons.
\n
Specifies a function that should return the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.defaultValue", "notSupportedIn": "", "comment": "Specifies the value the option must take when no other value is explicitly specified.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.depend", "notSupportedIn": "", "comment": "Specifies the name of a boolean component option which must be true in order for this option to function\nproperly.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.deprecated", "notSupportedIn": "", "comment": "This is mostly useful for the Coveo JavaScript Interface Editor.
\n
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization\nif the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why\nthe option is deprecated, and what now replaces it.\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.postProcessing", "notSupportedIn": "", "comment": "Deprecated options do not appear in the Coveo JavaScript Interface Editor.
\n
Specifies a function that should allow a component option to further modify its own value once all other options\nof that component have been built.\nExample:
\n\n\n", "type": "IComponentOptionsPostProcessing", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.required", "notSupportedIn": "", "comment": "By default, the
\nidoption of theFacetcomponent uses a post processing function to\nset its value to that of thefieldoption.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to\nfunction properly.\nExample:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.section", "notSupportedIn": "", "comment": "The
\nfieldoption of theFacetcomponent is required, since a facet cannot\nfunction properly without a field.
Specifies a section name inside which the option should appear in the Coveo JavaScript Interface Editor.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldOptionArgs.validator", "notSupportedIn": "", "comment": "Specifies a function that should indicate whether the option value is valid.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs", "notSupportedIn": "", "comment": "The IComponentOptionsFieldsOptionArgs interface describes the available parameters when building a\nfields option.
Specifies an alias, or array of aliases, which can be used instead of the actual option name.\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.attrName", "notSupportedIn": "", "comment": "This can be useful to modify an option name without introducing a breaking change.
\n
Specifies a different markup name to use for an option, rather than the standard name (i.e., data- followed by\nthe hyphened name of the option).\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.defaultFunction", "notSupportedIn": "", "comment": "This should only be used for backward compatibility reasons.
\n
Specifies a function that should return the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.defaultValue", "notSupportedIn": "", "comment": "Specifies the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.depend", "notSupportedIn": "", "comment": "Specifies the name of a boolean component option which must be true in order for this option to function\nproperly.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.deprecated", "notSupportedIn": "", "comment": "This is mostly useful for the Coveo JavaScript Interface Editor.
\n
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization\nif the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why\nthe option is deprecated, and what now replaces it.\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.postProcessing", "notSupportedIn": "", "comment": "Deprecated options do not appear in the Coveo JavaScript Interface Editor.
\n
Specifies a function that should allow a component option to further modify its own value once all other options\nof that component have been built.\nExample:
\n\n\n", "type": "IComponentOptionsPostProcessing", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.required", "notSupportedIn": "", "comment": "By default, the
\nidoption of theFacetcomponent uses a post processing function to\nset its value to that of thefieldoption.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to\nfunction properly.\nExample:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.section", "notSupportedIn": "", "comment": "The
\nfieldoption of theFacetcomponent is required, since a facet cannot\nfunction properly without a field.
Specifies a section name inside which the option should appear in the Coveo JavaScript Interface Editor.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsFieldsOptionArgs.validator", "notSupportedIn": "", "comment": "Specifies a function that should indicate whether the option value is valid.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs", "notSupportedIn": "", "comment": "The IComponentOptionsListOptionArgs interface describes the available parameters when building a\n[list option]{@link ComponentOptions.buildListOption).
Specifies an alias, or array of aliases, which can be used instead of the actual option name.\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.attrName", "notSupportedIn": "", "comment": "This can be useful to modify an option name without introducing a breaking change.
\n
Specifies a different markup name to use for an option, rather than the standard name (i.e., data- followed by\nthe hyphened name of the option).\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.defaultFunction", "notSupportedIn": "", "comment": "This should only be used for backward compatibility reasons.
\n
Specifies a function that should return the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.defaultValue", "notSupportedIn": "", "comment": "Specifies the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.depend", "notSupportedIn": "", "comment": "Specifies the name of a boolean component option which must be true in order for this option to function\nproperly.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.deprecated", "notSupportedIn": "", "comment": "This is mostly useful for the Coveo JavaScript Interface Editor.
\n
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization\nif the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why\nthe option is deprecated, and what now replaces it.\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.postProcessing", "notSupportedIn": "", "comment": "Deprecated options do not appear in the Coveo JavaScript Interface Editor.
\n
Specifies a function that should allow a component option to further modify its own value once all other options\nof that component have been built.\nExample:
\n\n\n", "type": "IComponentOptionsPostProcessing", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.required", "notSupportedIn": "", "comment": "By default, the
\nidoption of theFacetcomponent uses a post processing function to\nset its value to that of thefieldoption.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to\nfunction properly.\nExample:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.section", "notSupportedIn": "", "comment": "The
\nfieldoption of theFacetcomponent is required, since a facet cannot\nfunction properly without a field.
Specifies a section name inside which the option should appear in the Coveo JavaScript Interface Editor.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.separator", "notSupportedIn": "", "comment": "Specifies the regular expression to use to separate the elements of the list option.\nDefault value is a regular expression that inserts a comma character (,) between each word.
Specifies a function that should indicate whether the option value is valid.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsListOptionArgs.values", "notSupportedIn": "", "comment": "Specifies the possible values the list option elements can take.
\n", "type": "any", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs", "notSupportedIn": "", "comment": "The IComponentOptionsNumberOptionArgs interface describes the available parameters when building a\n[number option]{@link ComponentOptions.buildNumberOption).
Specifies an alias, or array of aliases, which can be used instead of the actual option name.\nNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.attrName", "notSupportedIn": "", "comment": "This can be useful to modify an option name without introducing a breaking change.
\n
Specifies a different markup name to use for an option, rather than the standard name (i.e., data- followed by\nthe hyphened name of the option).\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.defaultFunction", "notSupportedIn": "", "comment": "This should only be used for backward compatibility reasons.
\n
Specifies a function that should return the value the option must take when no other value is explicitly specified.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.defaultValue", "notSupportedIn": "", "comment": "Specifies the value the option must take when no other value is explicitly specified.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.depend", "notSupportedIn": "", "comment": "Specifies the name of a boolean component option which must be true in order for this option to function\nproperly.\nNote:
\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.deprecated", "notSupportedIn": "", "comment": "This is mostly useful for the Coveo JavaScript Interface Editor.
\n
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization\nif the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why\nthe option is deprecated, and what now replaces it.\nNote:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.float", "notSupportedIn": "", "comment": "Deprecated options do not appear in the Coveo JavaScript Interface Editor.
\n
Specifies whether the value of this option is a floating point number.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.max", "notSupportedIn": "", "comment": "Specifies the exclusive maximum value the option can take.\nConfiguring the option using a value strictly greater than this maximum displays a warning message in the console\nand automatically sets the option to its maximum value.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.min", "notSupportedIn": "", "comment": "Specifies the exclusive minimum value the option can take.\nConfiguring the option using a value strictly less than this minimum displays a warning message in the console and\nautomatically sets the option to its minimum value.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.postProcessing", "notSupportedIn": "", "comment": "Specifies a function that should allow a component option to further modify its own value once all other options\nof that component have been built.\nExample:
\n\n\n", "type": "IComponentOptionsPostProcessing", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.required", "notSupportedIn": "", "comment": "By default, the
\nidoption of theFacetcomponent uses a post processing function to\nset its value to that of thefieldoption.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to\nfunction properly.\nExample:
\n\n\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.section", "notSupportedIn": "", "comment": "The
\nfieldoption of theFacetcomponent is required, since a facet cannot\nfunction properly without a field.
Specifies a section name inside which the option should appear in the Coveo JavaScript Interface Editor.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsNumberOptionArgs.validator", "notSupportedIn": "", "comment": "Specifies a function that should indicate whether the option value is valid.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComponentOptionsPostProcessing", "notSupportedIn": "", "comment": "The IComponentOptionsPostProcessing<T> interface describes a post process function that should allow a component\noption to further modify its own value once all other options of that component have been built.
Describe a computed field request
\nSee: Computed Fields
This specifies the field on which the aggregate operation will be performed. This field is typically a numerical value.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IComputedFieldRequest.operation", "notSupportedIn": "", "comment": "This specifies the operation to execute on the field value.
\nPossible operations:\n-- sum: Computes the sum of all values.\n-- average: Computes the average of all values.\n--minimum: Retrieves the smallest of all values.\n--maximum: Retrieves the largest of all values.
The core template helpers provided by default.\nExamples:
\nHTML
\n<div class=\"CoveoFieldValue\" data-field=\"@videoduration\" data-helper=\"timeSpan\" data-helper-options-is-milliseconds=\"false\"></div>\nUnderscore
\n<%= timeSpan(raw.videoduration, { isMilliseconds: false }) %>\nFormats a clickable HTML link (<a>).
href: The link URIoptions: Optional. The options to use (see IAnchorUtilsOptions)Formats a currency value to a string using the specified options.
\ncontent: The number value to format.options: Optional. The options to use (see ICurrencyToStringOptions).Formats a date value to a date-only string using the specified options.
\ncontent: The Date value to format.options: Optional. The options to use (see IDateToStringOptions).Formats a date value to a date and time string using the specified\noptions.
\ncontent: The Date value to format.options: Optional. The options to use (see IDateToStringOptions).Renders one or several email values in mailto: hyperlinks.
value: The string or array of strings that contains a list of semicolon-separated email\nvalues. When multiple values are passed, each value is displayed in a\nseparate hyperlink.companyDomain: Optional. The string that contains your own domain (e.g.:\ncoveo.com). When specified, this parameter allows email addresses\ncoming from your own domain to be displayed in a shortened format\n(e.g.: Full Name), whereas email addresses coming from an external\ndomain will be displayed in an extended format (e.g.: Full Name\n(domain.com)). If this parameter is not specified, then the shortened\nformat will automatically be used.me: Optional. The string that contains the current username. If it is\nspecified, then the email address containing the current username will\nbe replaced by the localized string 'Me'.lengthLimit: Optional. The number of email addresses that you want to display\nbefore an ellipse is added (e.g.: 'From Joe, John and 5 others').truncateName: Optional. When the username is available from the email address,\nthen you can specify if you want to truncate the full name. (e.g.:\n'John S.' instead of 'John Smith').false.Formats a date value to a date and time string using options suitable for\nemail dates
\ncontent: The Date value to format.options: Optional. The options to use (see IDateToStringOptions).Replace all carriage return in a string by a <br /> tag
\nvalue: The string value to replace the carriage returns in.Generates an icon based on the file type of the current result. The icon\nwill be contained inside a <span> element with the appropriate CSS\nclass.
result: Optional. The current result object inside your template. In\nunderscore, it is referenced as obj. By default, the result\nwill be resolved automatically from your current template function (\nMeaning the nearest result in the current call stack execution inside\nyour template)options: Optional. The options to use (see IIconOptions).Highlights a string using the provided highlight information.
\ncontent: The URI to shorten.highlights: Optional. The highlight information to use.cssClass: Optional. The name of the CSS class to use for highlighting.This helper operates exactly like the highlightStreamText helper, except\nthat it should be used to highlight HTML content. The helper takes care\nof not highlighting the HTML markup.
\ncontent: The string content to highlighttermsToHighlight: The terms to highlight (see IHighlightTerm)phraseToHighlight: The phrases to highlight (see IHighlightPhrase)options: Optional. The options defined below as IStreamHighlightOptionsNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICoreHelpers.highlightStreamText", "notSupportedIn": "", "comment": "\n
highlightStreamHTMLshould only be used for very particular/specific use cases (e.g., augmenting the result template with additional information rather than the typical excerpt/title), and is not a proper replacement for actually having the correct title and excerpt on your results.Using incorrect result titles or excerpts on your search interface also causes relevancy to suffer greatly, as the index uses the title and excerpt to find relevant results. Consequently, end users are more likely to see results whose titles do not match their query.
\nMoreover, the recommended method to implement simple title and/or excerpt highlighting is to simply use the Excerpt and ResultLink components.
\n
Highlights the provided terms in a given string.
\nBy default, the terms to highlight are the current query and the\nassociated stemming words from the index.\nThe only required parameter is the content, which specify the string that needs to be highlighted.\nThe other parameters will normally be automatically resolved for you from the current result object.
content: The string content to highlighttermsToHighlight: The terms to highlight (see IHighlightTerm)phraseToHighlight: The phrases to highlight (see IHighlightPhrase)options: Optional. The options defined below as IStreamHighlightOptionsNote:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICoreHelpers.image", "notSupportedIn": "", "comment": "\n
highlightStreamTextshould only be used for very particular/specific use cases (e.g., augmenting the result template with additional information rather than the typical excerpt/title), and is not a proper replacement for actually having the correct title and excerpt on your results.Using incorrect result titles or excerpts on your search interface also causes relevancy to suffer greatly, as the index uses the title and excerpt to find relevant results. Consequently, end users are more likely to see results whose titles do not match their query.
\nMoreover, the recommended method to implement simple title and/or excerpt highlighting is to simply use the Excerpt and ResultLink components.
\n
Formats an HTML image tag (<img>).
src: The image source URIoptions: Optional. The options to use (see IImageUtilsOptions)Detect if the results is being rendered in a mobile device.\nIf it's not a mobile device, the helper return null ;
\nIf it's a mobile device, return the type of device (Android, iPhone, iPad) etc.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICoreHelpers.loadTemplate", "notSupportedIn": "", "comment": "Loads a partial template in the current template, by passing the ID of\nthe template to load, the condition for which this template should be\nloaded, and the context object (the object that the loaded template will\nuse as its data). By default, the context object will be the same as the\ntemplate that called this helper function. So, for example, in a\nResultList Component, the contextObject would, by default, be the Query\nResults.
\ntemplateId: The ID of the template to load.condition: Optional. The boolean condition to determine if this template should\nload for this result set. Most of the time this would be a condition of\nthe type if raw.somefield == 'something'.contextObject: Optional. The object that should be used by the loaded template\nas its contextObject.Formats a numeric value using the format string.
\ncontent: The numeric value to format.format Optional. The string format to use. See the Globalize library for the list of available formats.When the helper is used in a FieldValue component, this value is automatically retrieved from the specified field.
Example:
\n <div class=\"CoveoFieldValue\" data-field=\"@viewcount\" data-text-caption=\"Views\" data-helper=\"number\" data-helper-options-format=\"n0\"></div>\nShortens a string so that its length does not exceed a specific number of\ncharacters. An ellipsis is appended to the string if it exceeds the\nmaximum length.
\ncontent: The string to shorten.length: The maximum length of the resulting string.highlights: Optional. If provided, the string will be highlighted\nusing this highlight information.cssClass: Optional. When highlighting, the name of the CSS class to use.Shortens a string using an algorithm suitable for file paths. The helper\nwill insert an ellipsis in the string where text has been removed when\nthe path exceeds the maximum length.
\ncontent: The path to shorten.length: The maximum length of the resulting string.highlights: Optional. If provided, the string will be highlighted using\nthis highlight information.cssClass: Optional. When highlighting, the name of the CSS class to use.Shortens a string using an algorithm suitable for URIs. The helper will\ninsert an ellipsis in the string where text has been removed when the URI\nexceeds the maximum length.
\ncontent: The URI to shorten.length: The maximum length of the resulting string.highlights: Optional. If provided, the string will be highlighted\nusing this highlight information.cssClass: Optional. When highlighting, the name of the CSS class to use.Formats a number, which represents a file size in bytes, into a logical unit size.\nExamples:
\n\n\n\n
size(1024) => 1024 B\n
size(1025) => 1 KB\n
size(10240) => 10 KB
Examples:
\n\n\nHTML
\n\n<div class=\"CoveoFieldValue\" data-field='@size' data-helper=\"size\" data-helper-options-base=\"1\"></div>\n
\n\nUnderscore
\n\n<%= size(raw.size, {base: 0, precision: 2}) %>\n
value: The number to formatoptions : The options to use (see ISizeOptions)Formats an HTML image tag (<img>), and automatically uses the result\nobject to query the REST API to get the thumbnail for this result. For\nexample, this can be used to great effect when designing a template\nshowing users or previews of files.
result: Optional. The current result object inside your template. In\nunderscore, it is referenced as obj. By default, the result\nwill be resolved automatically from your current template function (\nMeaning the nearest result in the current call stack execution inside\nyour template)endpoint: Optional. The name of the endpoint to use for your\nthumbnail. Default is default.options: Optional. The options to use (see IImageUtilsOptions).Formats a date value to a time-only string using the specified options.
\ncontent: The Date value to format.options: Optional. The options to use (see IDateToStringOptions).Given a number, either in millisecond or second, convert to a HH:MM:SS format.\nExamples
\n\n\n\n
timeSpan(1, {isMilliseconds: false}) => '00:01'\n
timeSpan(1000, {isMilliseconds: true}) => '00:01'
value: The number to convert to a timespanoptions : The options to use (see ITimeSpanUtilsOptions)Given a filetype value, try to return a translated and human readable version.\nIf the filetype is known and recognized by the framework, a translated value will be returned.
\nExamples
\n\n\n\n
translatedCaption('doc') => Document\n
translatedCaption('xls') => Spreadsheet Document
value: The string value to translateThe available options to format a numeric value as a currency string.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICurrencyToStringOptions.decimals", "notSupportedIn": "", "comment": "The number of decimals to display.\nDefault: 0
The currency symbol to use.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICustomEvent", "notSupportedIn": "", "comment": "Describes a Coveo Cloud usage analytics custom event.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICustomEvent.actionCause", "notSupportedIn": "", "comment": "A unique name describing the action that triggered the event.\nSee the name property of the IAnalyticsActionCause interface.
Example: pagerNext
A name describing the category of actions to which the action that triggered the event belongs.\nSee the type property of the IAnalyticsActionCause interface.
Example: getMoreResults
Whether the event should be logged anonymously to the Coveo Cloud usage analytics service.\nNote: This field is normally set to the anonymous option value of the Analytics component.
A GUID representing the current user. This GUID is generated locally and stored in a non-expiring browser cookie.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICustomEvent.customData", "notSupportedIn": "", "comment": "Additional metadata to send along with the event.\nNote: This field may include custom user context information (see Sending Custom Context Information).
\nExample: { "currentResultsPerPage": 25, "userRole": "developer" }
The name of the device or browser that triggered the event.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
Example: Chrome
A name describing the category of actions to which the action that triggered the event belongs.\nNote: Normally, this field is set to the same value as actionType.
Example: getMoreResults
A unique name describing the action that triggered the event.\nNote: Normally, this field is set to the same value as actionCause.
Example: pagerNext
The language of the search interface from which the event originates.\nMust be a valid ISO-639-1 code.
\nNote: By default, the framework sets this field according to the currently loaded culture file (see Changing the Language of Your Search Interface).
\nExample: en
The searchQueryUid of the last search event that occurred before this event.\nExample: 74682726-0e20-46eb-85ac-f37259346f57
Whether the event originates from a mobile device.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
The broad application context from which the event originates.\nNote: By default, the framework sets this field to Search. However, you can use the setOriginContext method of the Analytics component to modify the default value.
Example: Search
The identifier of the search interface from which the event originates.\nNote: This field is normally set through the searchHub option of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: PartnerPortalSearch
The identifier of the tab from which the event originates.\nNote: The framework normally sets this field to the identifier of the currently selected Tab in the search interface.
Example: All
The address of the webpage that linked to the search interface from which the event originates.\nNote: The framework normally sets this field to the current document.referrer value.
Example: http://example.com/
The time it took to get a response from the Search API for the query related to the event (in milliseconds).\nNote: The framework normally sets this field to 0, except for search events in which case it sets the field by retrieving the information from the related Search API query response.
The unique identifier of the related query.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: 74682726-0e20-46eb-85ac-f37259346f57
The software acting on behalf of the end-user whose action triggered the event.\nNote: By default, the framework sets this field to the current navigator.userAgent value.
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36
The display name of the end-user whose action triggered the event.\nNote: This field is normally set to the userDisplayName option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: Alice Smith
The groups the end-user whose action triggered the event belongs to.\nNote: This field is normally left undefined, and the Coveo Cloud usage analytics service attempts to extract the information from the search token when actually recording the event.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ICustomEvent.username", "notSupportedIn": "", "comment": "The identifier of the end-user whose action triggered the event.\nNote: This field is normally set to the user option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: `asmith@example.com`
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDateToStringOptions", "notSupportedIn": "", "comment": "The IDateToStringOptions interface describes a set of options to use when converting a standard Date object to a\nstring using the dateToString , or the\n dateTimeToString method from the DateUtils class.\nThe precedence orders for the options are:\n useTodayYesterdayAndTomorrow \n-> useWeekdayIfThisWeek \n-> omitYearIfCurrentOne \n-> useLongDateFormat \nand alwaysIncludeTime \n-> includeTimeIfThisWeek \n-> includeTimeIfToday .
Specifies whether to always include the time in the resulting string when converting the Date object (e.g. May 15, 4:17 PM)\nThis option takes precedence over includeTimeIfThisWeek .\nExample
If includeTimeIfToday is true\nand now contains a Date object equivalent to Monday, March 8, 2017, then:
2010/03/08 17:23:11, the resulting string is 3/8/2010, 5:23 PM.Default value is false.
Specifies whether to include the time in the resulting string when converting the Date object (e.g. May 15, 4:17 PM)\nif the date to convert within a week from now . This option takes precedence over\n includeTimeIfToday .\nExamples
If includeTimeIfToday is true\nand now contains a Date object equivalent to Monday, March 8, 2017, then:
If the Date object to convert is equivalent to 2017/03/08 17:23:11, the resulting string is 3/8/2017, 5:23 PM.
If the Date object to convert is equivalent to 2017/03/09 17:23:11, the resulting string is 3/9/2017 ,5:23 PM.
Default value is true.
Specifies whether to include the time in the resulting string when converting the Date object (e.g. May 15, 4:17 PM)\nif the date to convert is equivalent to now .\nExamples
If includeTimeIfToday is true\nand now contains a Date object equivalent to Monday, March 8, 2017, then:
If the Date object to convert is equivalent to 2017/03/08 17:23:11, the resulting string is 3/8/2017, 5:23 PM.
If the Date object to convert is equivalent to 2017/03/09 17:23:11, the resulting string is 3/9/2017.
Default value is true.
Contains a standard Date object that specifies the current date and time.\nDefault value is undefined.
Specifies whether to omit the year from the resulting string when converting the Date object, if the year\nis the current one. This option takes precedence over\n useLongDateFormat .\nExamples
If the Date object to convert is equivalent to September 22, 2017, the resulting string does not contain\nthe year (e.g., September 22).
If the Date object to convert is equivalent to September 22, 2016, the resulting string contains the year\n(e.g., September 22, 2016).
Default value is true.
Specifies a custom date format (e.g., dd/MM/yyyy), regardless of browser locale or any other option.\nThis option uses the following syntax. All examples use the April 5th, 2018 14:15:34 time.
\nyyyy: full length year (e.g., 2018)yy: short length year (e.g., 18)MMMM: month name (e.g., April)MMM: shortened month name (e.g., Apr)MM: month number (e.g., 04)M: single digit month number for months before October (e.g., 4)dddd: day name (e.g., Thursday)ddd: shortened day name (e.g., Thu)dd: day number (e.g., 05)d: single digit day for days before the 10th (e.g., 5)hh: hour, in the 24-hour format (e.g., 14)h: hour, in the 12-hour format (e.g., 2)mm: minutes (e.g., 15)ss: seconds (e.g., 34)Specifies whether to format the resulting string in the long date format (e.g., Friday, August 04, 2017).\nDefault value is false.
Specifies whether to convert the Date object to the localized version of Today, Yesterday, or Tomorrow,\nif possible. This option takes precedence over\n useWeekdayIfThisWeek .\nExamples
If useTodayYesterdayAndTomorrow is true,\nand now contains a Date object equivalent to March 8, 2017, then:
If the Date object to convert contains a value equivalent to March 7, 2017, the resulting string is the\nlocalized version of Yesterday.
If the Date object to convert contains a value equivalent to March 8, 2017, the resulting string is the\nlocalized version of Today.
If the Date object to convert contains a value equivalent to March 9, 2017, the resulting string is the\nlocalized version of Tomorrow.
Default value is true.
Specifies whether to convert the Date object to the localized version of the corresponding day of the week,\nif the date to convert is part of the current week. This option takes precedence over\n omitYearIfCurrentOne .\nExamples
If useWeekdayIfThisWeek is true\n and now contains a Date object equivalent to Monday, March 8, 2017, then:
If the date to convert is equivalent to Saturday, March 6, 2017, the resulting string is the localized\nversion of Last Saturday.
If the date to convert is equivalent to Thursday, March 11, 2017, the resulting string is the localized\nversion of Next Thursday.
Default value is true.
The IDisplayedNewResultEventArgs interface describes the object that all\nnewResultDisplayed event handlers receive as an argument.
The HTML element which was rendered by the the displayed result.
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDisplayedNewResultEventArgs.result", "notSupportedIn": "", "comment": "The query result that was just displayed by the ResultList component.
The IDisplayedNewResultsEventArgs interface describes the object that all\nnewResultsDisplayed event handlers receive as an argument.
Whether the results are being displayed in a ResultList with infinite scroll enabled.\nSee enableInfiniteScroll option).
Argument sent to all handlers bound on QueryEvents.doneBuildingQuery
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDoneBuildingQueryEventArgs.cancel", "notSupportedIn": "", "comment": "If this property is set to true by any handlers, the query will not be executed.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDoneBuildingQueryEventArgs.queryBuilder", "notSupportedIn": "", "comment": "Allow handlers to modify the query by using the QueryBuilder
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDoneBuildingQueryEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDuringQueryEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QueryEvents.duringQuery
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDuringQueryEventArgs.promise", "notSupportedIn": "", "comment": "A promises for the results that will be returned by the Search API
\n", "type": "Promise", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDuringQueryEventArgs.query", "notSupportedIn": "", "comment": "The query that was just executed
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDuringQueryEventArgs.queryBuilder", "notSupportedIn": "", "comment": "The QueryBuilder that was used for the current query
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "IDuringQueryEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallOptions", "notSupportedIn": "", "comment": "Available options when calling against the SearchEndpoint
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallParameters", "notSupportedIn": "", "comment": "Parameters that can be used when calling an EndpointCaller
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallParameters.errorsAsSuccess", "notSupportedIn": "", "comment": "Flag to specify if the endpoint should return different type of error as actual 200 success for the browser, but with the error code/message contained in the response.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallParameters.method", "notSupportedIn": "", "comment": "Or HTTP verb : GET, POST, PUT, etc.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallParameters.queryString", "notSupportedIn": "", "comment": "Array of query string params.
\neg: ['foo=1','bar=2']
Body of the request.
\nkey -> value map (JSON)
Request data type.
\neg: "application/json", "application/x-www-form-urlencoded; charset=UTF-8"
responseType of the request.\neg: "text", "arraybuffer" etc.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallParameters.url", "notSupportedIn": "", "comment": "Url to target
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallerOptions", "notSupportedIn": "", "comment": "Possible options when creating a EndpointCaller
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallerOptions.accessToken", "notSupportedIn": "", "comment": "The access token to use for this endpoint.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallerOptions.anonymous", "notSupportedIn": "", "comment": "Specifies that the request (and the Coveo Search API) does not need any kind of authentication.
\nThis flag is only needed for specific setups when your requests are being blocked by your browser. If your queries are executing correctly, you do not need to bother.
\nSetting this flag will prevent the withCredentials option to be set on the XMLHttpRequest, allowing performing cross-domain requests on a server that returns * in the Access-Control-Allow-Origin HTTP header.
The password to use to log into this endpoint. Used for basic auth.
\nNot used if accessToken is provided.
A function which will allow external code to modify all endpoint call parameters before they are sent by the browser.\nUsed in very specific scenario where the network infrastructure require special request headers to be added or removed, for example.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IEndpointCallerOptions.username", "notSupportedIn": "", "comment": "The username to use to log into this endpoint. Used for basic auth.
\nNot used if accessToken is provided.
The XmlHttpRequest implementation to use instead of the native one.\nIf not specified, the native one is used.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IErrorResponse", "notSupportedIn": "", "comment": "An error response
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IErrorResponse.data", "notSupportedIn": "", "comment": "Data about the error
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IErrorResponse.statusCode", "notSupportedIn": "", "comment": "Status code for the error
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExtension", "notSupportedIn": "", "comment": "Information about a query extension
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExtension.argumentNames", "notSupportedIn": "", "comment": "An array of all possible arguments
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExtension.name", "notSupportedIn": "", "comment": "The name of the extension
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExternalAdvancedSearchSection", "notSupportedIn": "", "comment": "Describe a section populated by external code, using the AdvancedSearchEvents.buildingAdvancedSearch
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExternalAdvancedSearchSection.content", "notSupportedIn": "", "comment": "The content to add to the external section, as an HTMLElement.
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExternalAdvancedSearchSection.inputs", "notSupportedIn": "", "comment": "The array of inputs to populate.\nExternal code should only push inputs that match the type BaseFormTypes.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExternalAdvancedSearchSection.name", "notSupportedIn": "", "comment": "The name of the section.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IExternalAdvancedSearchSection.updateQuery", "notSupportedIn": "", "comment": "A handler to execute every time a new query is launched.\nThe handler will receive the inputs used to build the external section, as well as the queryBuilder object to allow to modify the query.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetOptions", "notSupportedIn": "", "comment": "The available global configuration options when requesting facets through the [facets]{IQuery.facets} array.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetOptions.freezeFacetOrder", "notSupportedIn": "", "comment": "Whether the facet values should be returned in their current order.
\n", "type": "Boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetRequest", "notSupportedIn": "", "comment": "A Search API facet request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetRequest.basePath", "notSupportedIn": "", "comment": "The base path shared by all values for a given hierarchical facet.\nDefault (Search API): []
The values displayed by the facet in the search interface at the moment of\nthe request.\nSee IFacetRequestValue.
\nDefault (Search API): []
The character to use to split field values into a hierarchical sequence.\nExample:\nFor a multi-value field containing the following values: c; c>folder2; c>folder2>folder3;\nThe delimiting character is >.
Default (Search API): ;
The unique identifier of the facet in the search interface.\nNote: Must match ^[A-Za-z0-9-_]{1,60}$.
Example: author-1
Required (Search API). The name of the field on which to base the\nfacet request.\nNote: Must reference an index field whose Facet option is enabled.
\nExample: author
Whether to use the basePath as a filter for the results.\nNote: This parameter is ignored unless the facet type is hierarchical.
Default (Search API): true
Whether to exclude folded result parents when estimating result counts for facet values.\nDefault (Search API): true
Whether to include the facet request's\ncurrentValues in the corresponding\nfacet response's\nvalues array.\nNote: Setting this to true is useful to ensure that the facet does\nnot move around while the end-user is interacting with it in the search\ninterface.
Default (Search API): false
Whether to automatically generate range values for the facet.\nNotes:
\ntrue is only effective when type is set to dateRange\nor numericalRange, and the referenced field is of a corresponding type (i.e., date or numeric).field is dynamically generated by a query function.field will speed up automatic range generation (see Add or Edit Fields).Default (Search API): false
The maximum number of items to scan for facet values.\nNote: A high injectionDepth may negatively impact the facet request\nperformance.
Default (Search API): 1000
Whether the facet is expanded in the search interface at the moment of the\nrequest.\nDefault (Search API): false
The maximum number of facet values to fetch.\nNote: If\nfreezeCurrentValues is\ntrue, numberOfValues must be equal to the\ncurrentValues array length.
Default (Search API): 8
Whether to prevent Coveo ML from automatically selecting values from that facet.\nDefault: false
The sort criterion to apply to the returned facet values.\nDefault behaviour when type is set to specific\nor hierarchical (Search API):
isFieldExpanded is false\nin the facet request, and\nmoreValuesAvailable is\ntrue in the corresponding facet response, use\nscore.alphanumeric.Default (Search API) when type is set to dateRange\nor numericalRange (Search API):: ascending\nOther possible value: descending
The kind of values to request for the facet.\nDefault (Search API): Specific
A currentValues item in a Search API\nfacet request.
The children of this category facet value.\nEach child is a full-fledged category facet value that may in turn have its own children and so forth,\nup to a maximum depth of 50 levels
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetRequestValue.end", "notSupportedIn": "", "comment": "The value to end the range at.\nExamples:
\n\n\n", "type": "RangeType", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetRequestValue.endInclusive", "notSupportedIn": "", "comment": "\n
\n- \n
500- \n
2018-12-31T23:59:59.999Z
Whether to include the end value in the range.
The label to associate with the range value.\nExamples:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetRequestValue.preventAutoSelect", "notSupportedIn": "", "comment": "\n
\n- \n
0 - 500- \n
In 2018
Whether to prevent Coveo ML from automatically selecting the facet value.\nDefault: false
Whether to retrieve the children of this category facet value. Can only be used on leaf values in the request (i.e., values with no current children).\nDefault: false
If retrieveChildren is true, the maximum number of children to retrieve for this leaf value.\nDefault (Search API): 0
The value to start the range at.\nExamples:
\n\n\n", "type": "RangeType", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetRequestValue.state", "notSupportedIn": "", "comment": "\n
\n- \n
0- \n
2018-01-01T00:00:00.000Z
The current facet value state in the search interface.\nDefault (Search API): idle
Required (Search API). The facet value name.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponse", "notSupportedIn": "", "comment": "An item in the response of a Search API facet request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponse.facetId", "notSupportedIn": "", "comment": "The unique facet identifier in the search interface.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponse.field", "notSupportedIn": "", "comment": "The name of the field on which the facet is based.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponse.moreValuesAvailable", "notSupportedIn": "", "comment": "Whether additional values are available for the facet.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponse.values", "notSupportedIn": "", "comment": "The returned facet values.\nSee IFacetResponseValue
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue", "notSupportedIn": "", "comment": "A values item in a Search API facet response.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.children", "notSupportedIn": "", "comment": "The children of this hierarchical facet value.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.end", "notSupportedIn": "", "comment": "The value to end the range at.\nExamples:
\n\n\n", "type": "RangeType", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.endInclusive", "notSupportedIn": "", "comment": "\n
\n- \n
500- \n
2018-12-31T23:59:59.999Z
Whether to include the end value in the range.
When the hierarchical value has no children, this property is true.
The label to associate with the range value.\nExamples:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.moreValuesAvailable", "notSupportedIn": "", "comment": "\n
\n- \n
0 - 500- \n
In 2018
Whether additional values are available for the facet.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.numberOfResults", "notSupportedIn": "", "comment": "The number of query result items matching the facet value.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.start", "notSupportedIn": "", "comment": "The value to start the range at.\nExamples:
\n\n\n", "type": "RangeType", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.state", "notSupportedIn": "", "comment": "\n
\n- \n
0- \n
2018-01-01T00:00:00.000Z
The facet value state to display in the search interface.
\n", "type": "FacetValueState", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetResponseValue.value", "notSupportedIn": "", "comment": "The facet value name.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetSearchRequest", "notSupportedIn": "", "comment": "A Search API facet search request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetSearchRequest.basePath", "notSupportedIn": "", "comment": "The base path shared by all values for the facet.\nNote: This parameter has no effect unless the facet type is hierarchical.
A dictionary that maps index field values to facet value display names.\nExample
\n\n\n", "type": "Record", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetSearchRequest.delimitingCharacter", "notSupportedIn": "", "comment": "\n
{"acme_productA": "ACME Product A", "acme_productB": "ACME Product B"}
The character to use to split field values into a hierarchical sequence.\nExample:
\nFor a multi-value field containing the following values:
\nc; c>folder2; c>folder2>folder3;\nThe delimiting character is >.
For a hierarchical field containing the following values:
\nc;folder2;folder3;\nThe delimiting character is ;.
Default: ;
The name of the field against which to execute the facet search request.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetSearchRequest.filterFacetCount", "notSupportedIn": "", "comment": "Whether to exclude folded result parents when estimating result counts for facet values.\nNote: The target folding field must be a facet field with the Use cache for nested queries options enabled (see Add or Edit a Field).
\nSee also the Folding and FoldingForThread components.
Default: true.
A list of paths to filter out from the hierarchical facet search results.\nExample: [["Electronics", "Entertainment", "Gaming Consoles"],["Appliances", "Kitchen"]]
A list of index field values to filter out from the facet search results.\nExample: ["blue", "green"]
The maximum number of facet values to fetch.\nDefault (Search API): 10
The string to match.\nTypically, the text entered by the end-user in the facet search box, to which one or more wildcard characters (*) may be added.
Example: "*oran*"
The query parameters representing the current state of the search interface.\nSee the query documentation.
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetSearchRequest.type", "notSupportedIn": "", "comment": "The kind of facet values against which the search request is being made.\nDefault: specific
A Search API facet search response.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetSearchResponse.moreValuesAvailable", "notSupportedIn": "", "comment": "Whether additional facet values matching the request are available.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetSearchResponse.values", "notSupportedIn": "", "comment": "The facet values.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetValueSuggestionRow", "notSupportedIn": "", "comment": "Used to define a row returned by an IFacetValueSuggestionsProvider.
The field that was used for the suggestions.
\n", "type": "IFieldOption", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetValueSuggestionRow.keyword", "notSupportedIn": "", "comment": "The keyword that was used in the query to retrieve results.
\n", "type": "IQuerySuggestionKeyword", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetValueSuggestionRow.numberOfResults", "notSupportedIn": "", "comment": "The number of results matching the value for the given keyword.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetValueSuggestionRow.score", "notSupportedIn": "", "comment": "The score computed by the suggestions provider.\nA higher score means the results is more relevant.
\n", "type": "IFacetValueSuggestionScore", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetValueSuggestionRow.value", "notSupportedIn": "", "comment": "The field value returned by the suggestion that should be used to filter the results.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFacetValueSuggestionsProvider", "notSupportedIn": "", "comment": "Provides suggestions for the FacetValueSuggestions component.
Defines options for the FacetValueSuggestions component.
Argument sent to all handlers bound on QueryEvents.fetchMoreSuccess
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFetchMoreSuccessEventArgs.query", "notSupportedIn": "", "comment": "The query that was just executed
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFetchMoreSuccessEventArgs.queryBuilder", "notSupportedIn": "", "comment": "The QueryBuilder that was used for the current query
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFetchMoreSuccessEventArgs.results", "notSupportedIn": "", "comment": "The results returned by the query that was executed
\n", "type": "IQueryResults", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFetchMoreSuccessEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldConditionOption", "notSupportedIn": "", "comment": "The IFieldConditionOption is a component option expressing a field-based condition that must be satisfied.
The name of the field on which the condition is based (e.g., author).
Whether the condition should disallow the specified values rather than allowing them.
The field values allowed (or disallowed) by the condition (e.g., ["Alice Smith", "Bob Jones"]).
Information about a single field in the index
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.defaultValue", "notSupportedIn": "", "comment": "The default value of the field
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.description", "notSupportedIn": "", "comment": "A small(ish) description of the field
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.fieldSourceType", "notSupportedIn": "", "comment": "It's fieldSourceType, as a string.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.fieldType", "notSupportedIn": "", "comment": "It's fieldType, as a string.
\neg: Date, Double, Integer, LargeString, Long, SmallString
Gets whether the field is considered groupBy (facet)
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.includeInQuery", "notSupportedIn": "", "comment": "Gets whether the field can be referenced in a query.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.includeInResults", "notSupportedIn": "", "comment": "Gets whether the field is returned with results.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.name", "notSupportedIn": "", "comment": "It's name, as a string
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.sortByField", "notSupportedIn": "", "comment": "Gets whether the field can be used to sort results
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.splitGroupByField", "notSupportedIn": "", "comment": "Gets whether the field is considered splitGroupBy (facet with ; between values)
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldDescription.type", "notSupportedIn": "", "comment": "It's type, as a string
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldOption", "notSupportedIn": "", "comment": "The IFieldOption interface declares a type for options that should contain a field to be used in a query.\nThe only constraint this type has over a basic string is that it should start with the @ character.
Allows manipulation and formatting of text strings and determination and location of substrings within strings.
\n", "type": "StringConstructor", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFieldOption.length", "notSupportedIn": "", "comment": "Returns the length of a String object.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IFormWidget", "notSupportedIn": "", "comment": "Describe an interface for a simple form widget.\nCheckbox, DatePicker, Dropdown are all examples of IFormWidgets.
The IGeolocationPosition interface describes a geolocation position\nusable by the DistanceResources component.
The IGeolocationPositionProvider interface describes an object with a method that can provide\na geolocation position to the DistanceResources component.
The IGetDocumentOptions interface describes the available options when calling against a\nSearchEndpoint to get an item.
The IGroupByRequest interface describes a Group By operation to perform against the index.\nSee Group By Operations.
Explicitly specifies a list of values for which to generate Group By values.\nYou can use trailing wildcards to include ranges of values.
\nExample:
\n\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByRequest.allowedValuesPatternType", "notSupportedIn": "", "comment": "The array
\n["foo", "bar*"]would return Group By values forfooand any value starting withbar.
The pattern type to use for the IGroupByRequest.allowedValues property (see AllowedValuesPatternType).\nThis option is empty by default, which makes it behave as legacy.
Specifies an array of computed fields that should be evaluated for each Group By value that is returned.\nComputed fields are used to perform aggregate operations on other fields for all the matching items having a\nspecific value in the Group By field in the results. See\nComputed Fields.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByRequest.constantQueryOverride", "notSupportedIn": "", "comment": "Specifies a constant query expression on which to compute the Group By operation.\nThis feature is similar to the queryOverride feature, except that in this\ncase, the index keeps the constant query expression in cache for faster queries. You should avoid specifying a\ndynamic query expression for this parameter, for doing so will negatively impact performance.
By default, the constant part of the query expression being executed is used.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByRequest.field", "notSupportedIn": "", "comment": "Specifies the field on which to perform the Group By request. The Group By request returns a Group By value for\neach distinct value of this field within the result set.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByRequest.generateAutomaticRanges", "notSupportedIn": "", "comment": "Specifies whether to let the index calculate the ranges.\nDefault value is false.
Specifies how deep the index should scan the results to identify missing Group By values.\nWhen executing a Group By operation, the index uses various heuristics to try to list all of the field values that\nappear in the result set. In some corner cases, certain values might be omitted (it is a classical example of a\ntrade-off between precision and performance). Using injectionDepth forces the index to explicitly scan the field\nvalues of the top n results of the query, and ensure that the field values present in those results are included.
Consequently, specifying a high value for this parameter may negatively impact query performance.
\nDefault value is 1000. Minimum value is 1000.
Specifies the maximum number of values that the Group By operation can return.\nDefault value is 10. Minimum value is 0.
Specifies a different query expression on which to compute the Group By operation.\nThis feature is typically used for performance reasons to retrieve Group By values on separate expressions while\nexecuting a normal query in a single operation.
\nBy default, the query expression being executed is used.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByRequest.rangeValues", "notSupportedIn": "", "comment": "Explicitly specifies a list of range values for which Group By values should be generated.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByRequest.sortCriteria", "notSupportedIn": "", "comment": "Specifies how the indexer should sort the Group By values.\nThe possible values are:
\nscore: Sort by score. Score is computed from the number of occurrences of a field value, as well as from the\nposition where results having this field value appear in the ranked result set. When using this sort criterion, a\nfield value with 100 occurrences might appear after one with only 10 occurrences, if the occurrences of the latter\ntend to appear sooner in the ranked result set.occurrences: Sort by number of occurrences, with values having the highest number of occurrences appearing\nfirst.alphaascending / alphadescending: Sort alphabetically on the field values.computedfieldascending / computedfielddescending: Sort on the values of the first computed field for each\nGroup By value (see Computed Fields).chisquare: Sort based on the relative frequency of values in the result set compared to the frequency in the\nentire index. This means that a value that does not appear often in the index but does appear often in the result\nset will tend to appear first.nosort: Do not sort the Group By values. When using this sort criterion, the index returns the Group By values\nin a random order.Default value is score.
A result for a IGroupByRequest.\nThis is typically what the Facet component will use to render themselves.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByResult.field", "notSupportedIn": "", "comment": "The field on which the group by was performed.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByResult.globalComputedFieldResults", "notSupportedIn": "", "comment": "Available if there was any computed field request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByResult.values", "notSupportedIn": "", "comment": "The differents values for this result
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByValue", "notSupportedIn": "", "comment": "Describe a single group by value, returned by a IGroupByResult
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByValue.computedFieldResults", "notSupportedIn": "", "comment": "If there was ny computed field request, the results will be available here.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByValue.lookupValue", "notSupportedIn": "", "comment": "The lookup value if it was specified.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByValue.numberOfResults", "notSupportedIn": "", "comment": "The number of results that match this value in the index for this particular group by request
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByValue.score", "notSupportedIn": "", "comment": "The relevance score.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IGroupByValue.value", "notSupportedIn": "", "comment": "The string value. Think : Facet label.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IHighlight", "notSupportedIn": "", "comment": "A highlight structure, as returned by the index.\nThis structure can be used to do the actual highlighting job.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IHighlight.dataHighlightGroup", "notSupportedIn": "", "comment": "The group number for the highlight. A single string can have the same term highlighted multiple times.\nThis allows to regroup the different highlights.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IHighlight.dataHighlightGroupTerm", "notSupportedIn": "", "comment": "The string that represent the highlight. A single string can have the same term highlighted multiple times.\nThis allows to regroup the different highlights.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IHighlight.length", "notSupportedIn": "", "comment": "The length of the offset.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IHighlight.offset", "notSupportedIn": "", "comment": "The 0 based offset inside the string where the highlight should start.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IHighlightPhrase", "notSupportedIn": "", "comment": "The data about a single phrase to highlight.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IHighlightTerm", "notSupportedIn": "", "comment": "The data about a single term to highlight.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IIconOptions", "notSupportedIn": "", "comment": "Available options for the Icon component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IImageUtilsOptions", "notSupportedIn": "", "comment": "Options for building an <img> tag.
The alternative text for the image (alt attribute).
The height of the image
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IImageUtilsOptions.srcTemplate", "notSupportedIn": "", "comment": "The template to use for the image source
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IImageUtilsOptions.width", "notSupportedIn": "", "comment": "The width of the image
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IIndexFieldValue", "notSupportedIn": "", "comment": "Describe a field value returned by index
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IIndexFieldValue.computedFieldResults", "notSupportedIn": "", "comment": "The optional computedFieldResults, if requested in the IGroupByRequest
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IIndexFieldValue.lookupValue", "notSupportedIn": "", "comment": "The optional lookupValue, if requested in the IGroupByRequest
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IIndexFieldValue.numberOfResults", "notSupportedIn": "", "comment": "The number of results in the index which have this value
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IIndexFieldValue.value", "notSupportedIn": "", "comment": "The value
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IInitializationEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on InitializationEvents.afterComponentsInitialization, and InitializationEvents.afterInitialization.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IInitializationParameters", "notSupportedIn": "", "comment": "Represent the initialization parameters required to init a new component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesBatchRequest", "notSupportedIn": "", "comment": "Describe a request to list the possible values of multiple fields.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesBatchRequest.batch", "notSupportedIn": "", "comment": "The list of fields to request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest", "notSupportedIn": "", "comment": "Describe a request to list the possible values of a field.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.constantQueryOverride", "notSupportedIn": "", "comment": "A query to execute when returning possible field values, put in cache in the index
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.field", "notSupportedIn": "", "comment": "The field for which to list values
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.ignoreAccents", "notSupportedIn": "", "comment": "Whether to ignore accents in the values
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.lookupField", "notSupportedIn": "", "comment": "The lookup field to use
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.maximumNumberOfValues", "notSupportedIn": "", "comment": "Maximum number of field values to return
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.pattern", "notSupportedIn": "", "comment": "A pattern to filter out results
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.patternType", "notSupportedIn": "", "comment": "The type of the pattern (eg: regex)
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.queryOverride", "notSupportedIn": "", "comment": "A query to execute when returning possible field values
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IListFieldValuesRequest.sortCriteria", "notSupportedIn": "", "comment": "The sort order for the returned field.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "INewQueryEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QueryEvents.newQuery
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "INewQueryEventArgs.cancel", "notSupportedIn": "", "comment": "If this property is set to true by any handlers, the query will not be executed.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "INewQueryEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "INoResultsEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QueryEvents.noResults
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "INoResultsEventArgs.query", "notSupportedIn": "", "comment": "The query that was just executed
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "INoResultsEventArgs.queryBuilder", "notSupportedIn": "", "comment": "The QueryBuilder that was used for the current query
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "INoResultsEventArgs.results", "notSupportedIn": "", "comment": "The results returned by the query that was executed
\n", "type": "IQueryResults", "constrainedValues": [], "miscAttributes": {} }, { "name": "INoResultsEventArgs.retryTheQuery", "notSupportedIn": "", "comment": "If set to true by any handler, the last query will automatically be re-executed again.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "INoResultsEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IOmniboxDataRow", "notSupportedIn": "", "comment": "The content that external code that wants to populate the omnibox need to populate.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IOmniboxDataRow.deferred", "notSupportedIn": "", "comment": "This is a Promise object. It is used when you want to make an asynchronous call (most likely an Ajax request) to a service in order to retrieve the data that you will use to build your HTML content.
\n", "type": "Promise", "constrainedValues": [], "miscAttributes": {} }, { "name": "IOmniboxDataRow.element", "notSupportedIn": "", "comment": "This an HTMLElement that you want the Omnibox to render.\nIt can be any valid HTML element (div, span, image, table, etc.). You can bind any event you want to this element and also add logic to handle the Omnibox (e.g. should the Omnibox close itself when clicking on your suggestion, should the Omnibox clear itself?).
This element you provide can be as complex as you want it to be (see Providing Suggestions for the Omnibox).
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "IOmniboxDataRow.zIndex", "notSupportedIn": "", "comment": "This is an optional property. It is used by each component to influence their rendering order in the Omnibox. It works like a normal CSS zIndex: higher value will render at the top most level. Providing no zIndex will make your item render with a low priority.
The IOpenQuickviewEventArgs interface describes the object that all\nopenQuickview event handlers receive as an argument.
The array of query expression terms to highlight in the quickview modal window.
\n", "type": "any", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPlanResponse", "notSupportedIn": "", "comment": "Describes the plan of execution of a search request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPlanResponse.parsedInput", "notSupportedIn": "", "comment": "The query expressions that would be sent to the index once the search\nrequest has been fully processed by the query pipeline.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPlanResponse.preprocessingOutput", "notSupportedIn": "", "comment": "The output that would be included by the Search API in the query response\nonce the search request has been fully processed by the query pipeline.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateBreadcrumbEventArgs", "notSupportedIn": "", "comment": "Event triggered when populating the breadcrumb
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxObject", "notSupportedIn": "", "comment": "The IPopulateOmniboxObject is an interface that is used by components to interact with the Omnibox and provides a framework for type-ahead suggestions.
An array IPopulateOmniboxQueryExpression used to describe each part of the content of the Omnibox component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxObject.completeQueryExpression", "notSupportedIn": "", "comment": "A IPopulateOmniboxQueryExpression object used to describe the complete content of the Querybox component.
\n", "type": "IPopulateOmniboxQueryExpression", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxObject.currentQueryExpression", "notSupportedIn": "", "comment": "A IPopulateOmniboxQueryExpression object used to describe the current active content (the current position of the cursor/caret) of the Omnibox component.
\n", "type": "IPopulateOmniboxQueryExpression", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxObject.cursorPosition", "notSupportedIn": "", "comment": "The number representing the current position of the cursor/caret inside the Omnibox component.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxQueryExpression", "notSupportedIn": "", "comment": "This object is a simple interface that describes the content of an omnibox query expression.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxQueryExpression.regex", "notSupportedIn": "", "comment": "This is a regex of the content of the Omnibox with some special character escaped.
\n", "type": "RegExp", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxQueryExpression.word", "notSupportedIn": "", "comment": "This is a simple string with the plain content of the Omnibox.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateOmniboxSuggestionsEventArgs", "notSupportedIn": "", "comment": "The IPopulateOmniboxSuggestionsEventArgs interface describes the object that all\npopulateOmniboxSuggestions event handlers receive as an argument.
The Omnibox component instance.
The list of resolved query completion suggestions, and/or query completion suggestion promises.
\n", "type": "Array", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateSearchResultPreviewsEventArgs", "notSupportedIn": "", "comment": "Executed when a Suggestion is focused and waiting for search result previews.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateSearchResultPreviewsEventArgs.previewsQueries", "notSupportedIn": "", "comment": "The result previews query. This must be set synchronously before the event resolves.\nSetting this to a non-empty array will display the given search result previews.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPopulateSearchResultPreviewsEventArgs.suggestion", "notSupportedIn": "", "comment": "The suggestion to look up search result previews for.
\n", "type": "Suggestion", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPositionResolvedEventArgs", "notSupportedIn": "", "comment": "The IPositionResolvedEventArgs interface describes the object that all\nonPositionResolved event handlers receive as an argument.
The position that was resolved.
\n", "type": "IGeolocationPosition", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPreprocessMoreResultsEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QueryEvents.preprocessMoreResults
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPreprocessMoreResultsEventArgs.results", "notSupportedIn": "", "comment": "The results returned by the query that was executed
\n", "type": "IQueryResults", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPreprocessResultsEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QueryEvents.preprocessResults
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPreprocessResultsEventArgs.query", "notSupportedIn": "", "comment": "The query that was just executed
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPreprocessResultsEventArgs.queryBuilder", "notSupportedIn": "", "comment": "The QueryBuilder that was used for the current query
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPreprocessResultsEventArgs.results", "notSupportedIn": "", "comment": "The results returned by the query that was executed
\n", "type": "IQueryResults", "constrainedValues": [], "miscAttributes": {} }, { "name": "IPreprocessResultsEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery", "notSupportedIn": "", "comment": "The IQuery interface describes a query that can be performed on the Coveo REST Search API.\nFor basic usage, see the IQuery.q and IQuery.aq properties.
\nIn a normal scenario, a query is built by the QueryBuilder class.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.actionsHistory", "notSupportedIn": "", "comment": "The actions history represents the past actions a user made and is used by the Coveo Machine Learning service to\nsuggest recommendations. It is generated by the page view script (https://github.com/coveo/coveo.analytics.js)
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.allowQueriesWithoutKeywords", "notSupportedIn": "", "comment": "Specifies if the Search API should perform queries even when no keywords were entered by the end user.\nEnd user keywords are present in either the IQuery.q or IQuery.lq part of the query.
\nThis parameter is normally controlled by SearchInterface.options.allowEmptyQuery option.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.aq", "notSupportedIn": "", "comment": "The advanced query expression.
\nThis is the part of the query expression generated by code based on various rules.
\neg: Selecting a facet value will cause an expression to be added to the advanced query expression.
Specifies an array of request to retrieve facet values for the CategoryFacet component
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.childField", "notSupportedIn": "", "comment": "Specifies the childField when doing parent-child loading (See: Folding)
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.commerce", "notSupportedIn": "", "comment": "The commerce request to execute.
\n", "type": "ICommerceRequest", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.context", "notSupportedIn": "", "comment": "The context is a map of key_value that can be used in the Query pipeline in the Coveo platform.
The constant query expression.
\nThis part of the expression is much alike the advanced query expression, but it is meant to hold expressions that are constant for all users of a search interface/widget.
\nThe results of evaluating those expressions are kept in a special index cache, to avoid re-evaluating them on each query.
\nYou must be careful to not include dynamic parts in this expression, otherwise you risk filling up the cache with useless data and this might have a negative impact on performance.
\nExpressions other than cq also benefit from caching in the index, but using cq allows to explicitly require that a part of the query be included in the cache.
Whether to include debug information from the Search API in the query response.\nNote:
\n\n\nThis debug information does not include ranking information.
\n
Setting this property to true can have an adverse effect on query performance, so it should always be left to\nfalse in a production environment.
The disjunction query expression.
\nThis is the disjunctive part of the query expression that is merged with the other expression parts using an OR boolean operator.
\nWhen specified, the final expression evaluated by the index ends up being (q aq cq) OR (dq).
Whether the index should take collaborative rating in account when ranking result. See: ResultRating
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.enableDidYouMean", "notSupportedIn": "", "comment": "This enables the query correction feature of the index.
\nBy activating this, the index returns an array of {link IQueryCorrection} with suggested word corrections.
Whether to enable the special query syntax such as field references for the basic query expression (parameter q).\nIt is equivalent to a No syntax block applied to the basic query expression.\nIf not specified, the parameter defaults to false
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.excerptLength", "notSupportedIn": "", "comment": "Specifies the length (in number of characters) of the excerpts generated by the indexer based on the keywords present in the query.
\nThe index includes the top most interesting sentences (in the order they appear in the item) that fit in the specified number of characters.
\nWhen not specified, the default value is 200.
The global configuration options to apply to the requests in the facets array.
\n", "type": "IFacetOptions", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.facets", "notSupportedIn": "", "comment": "Specifies an array of request to retrieve facet values for the DynamicFacet component.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.fieldsToExclude", "notSupportedIn": "", "comment": "Specifies an array of fields that should be excluded from the query results.
\neg: ['@foo','@bar']
Specifies an array of fields that should be returned for each result.
\neg: ['@foo','@bar']
Specifies a field on which Folding should be performed.
\nFolding is a kind of duplicate filtering where only the first result with any given value of the field is included in the result set.
\nIt's typically used to return only one result in a conversation, for example when forum posts in a thread are indexed as separate items.
Number of results that should be folded, using the IQuery.filterField
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.firstResult", "notSupportedIn": "", "comment": "This is the 0-based index of the first result to return.
\nIf not specified, this parameter defaults to 0.
The format of a successful response.\nIf not specified, this parameter defaults to 'json'.
\n", "type": "ResponseFormat", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.groupBy", "notSupportedIn": "", "comment": "Specifies an array of Group By operations that can be performed on the query results to extract facets
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.lowercaseOperators", "notSupportedIn": "", "comment": "Whether to enable the support for operator in lowercase (AND OR -> and or)
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.lq", "notSupportedIn": "", "comment": "The contextual text.
\nThis is the contextual text part of the query. It uses the Coveo Machine Learning service to pick key keywords from\nthe text and add them to the basic expression.\nThis field is mainly used to pass context such a case description, long textual query or any other form of text that might help in\nrefining the query.
The maximum age for cached query results, in milliseconds.
\nIf results for the exact same request (including user identities) are available in the in-memory cache, they will be used if they are not older than the specified value.
\nOtherwise, the query will be sent to the index.
This is the number of results to return, starting from IQuery.firstResult.
\nIf not specified, this parameter defaults to 10.
Specifies the parentField when doing parent-child loading (See: Folding)
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.partialMatch", "notSupportedIn": "", "comment": "Whether to enable partial matching of the basic expression keywords.
\nBy activating this, when the basic expression contains at least IQuery.partialMatchKeywords, items containing only the number of keywords specified by IQuery.partialMatchThreshold will also match the query.
\nWithout this option, items are required to contain all the keywords in order to match the query.
\nIf not specified, this parameter defaults to false.
The minimum number of keywords needed to activate partial match.
\nSpecifies the minimum number of keywords needed for the partial match feature to activate.
\nIf the basic expression contains less than this number of keywords, no transformation is applied on the query.
\nIf not specified, this parameter defaults to 5.
The threshold to use for matching items when partial match is enabled.
\nSpecifies the minimum number of query keywords that an item must contain when partial match is enabled. This value can either be an absolute number or a percentage value based on the total number of keywords.
\nIf not specified, this parameter defaults to 50%.
Name of the query pipeline to use.
\nSpecifies the name of the query pipeline to use for the query. If not specified, the default value is default, which means the default query pipeline will be used.
The basic query expression.
\nThis is typically the query expression entered by the user in a query box.
\nSince this part of the query is expected to come from user input, it is processed by the Did You Mean feature.
Specifies an array of Query Function operation that will be executed on the results.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.questionMark", "notSupportedIn": "", "comment": "Whether to enable question marks with wildcards.
\nThis enables using the question mark ? character within wildcard expressions.
Specifies an array of Ranking Function operations that will be executed on the result
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.recommendation", "notSupportedIn": "", "comment": "This is the id of the recommendation interface that generated the query.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.retrieveFirstSentences", "notSupportedIn": "", "comment": "Specifies whether the first sentences of the item should be included in the results.
\nThe retrieveFirstSentences option is typically used instead of excerpts when displaying email items, where the first sentence of the email might be of more interest than a contextually generated excerpt.
The hub value set from the Analytics component.
\nUsed for analytics reporting in the Coveo platform
Specifies the sort criterion(s) to use to sort results. If not specified, this parameter defaults to Relevancy.
\nPossible values are :
\n-- relevancy : This uses all the configured ranking weights as well as any specified ranking expressions to rank results.
\n-- dateascending / datedescending : Sort using the value of the @date field, which is typically the last modification date of an item in the index.
\n-- qre : Sort using only the weights applied through ranking expressions. This is much like using Relevancy except that automatic weights based on keyword proximity etc, are not computed.
\n-- nosort : Do not sort the results. The order in which items are returned is essentially random.
\n-- @field ascending / @field descending : Sort using the value of a custom field.
The tab value set from the Tab component.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuery.userActions", "notSupportedIn": "", "comment": "The user ID or visitor ID whose item views should be tagged in the query results\n(see the isUserActionView property of the IQueryResult interface).\nExamples:
\nWhether to enable wildcards on the basic expression keywords.
\nThis enables the wildcard features of the index. Coveo Platform will expand keywords containing wildcard characters to the possible matching keywords to broaden the query.
\nSee Using Wildcards in Queries.
\nIf not specified, this parameter defaults to false.
Describe the expressions part of a QueryBuilder.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryBuilderExpression.advanced", "notSupportedIn": "", "comment": "The advanced part of the expression
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryBuilderExpression.basic", "notSupportedIn": "", "comment": "The basic part of the expression
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryBuilderExpression.constant", "notSupportedIn": "", "comment": "The constant part of the expression
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryBuilderExpression.disjunction", "notSupportedIn": "", "comment": "The disjunction part of the expression
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryBuilderExpression.full", "notSupportedIn": "", "comment": "The whole expression
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryBuilderExpression.withoutConstant", "notSupportedIn": "", "comment": "The full part, but without the constant.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryCorrection", "notSupportedIn": "", "comment": "Describe correction for a query
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryCorrection.correctedQuery", "notSupportedIn": "", "comment": "The query once corrected
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryCorrection.wordCorrections", "notSupportedIn": "", "comment": "Array of correction for each word in the query
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryErrorEventArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QueryEvents.queryError
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryErrorEventArgs.endpoint", "notSupportedIn": "", "comment": "The endpoint on which the error happened.
\n", "type": "ISearchEndpoint", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryErrorEventArgs.error", "notSupportedIn": "", "comment": "The error info / message itself.
\n", "type": "IEndpointError", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryErrorEventArgs.query", "notSupportedIn": "", "comment": "The query that was just executed
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryErrorEventArgs.queryBuilder", "notSupportedIn": "", "comment": "The QueryBuilder that was used for the current query
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryErrorEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryException", "notSupportedIn": "", "comment": "Describe an exception that was triggered by the index when performing the query.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryException.code", "notSupportedIn": "", "comment": "The exception code
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryFunction", "notSupportedIn": "", "comment": "Describe a query function that can be executed against the index
\nSee: Query Functions
The field name on which to store the query function result when the query returns
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryFunction.function", "notSupportedIn": "", "comment": "Function to execute, as a string
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryOptions", "notSupportedIn": "", "comment": "Possible options when performing a query with the query controller
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryOptions.beforeExecuteQuery", "notSupportedIn": "", "comment": "Specify a function that you wish to execute just before the query is executed
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryOptions.cancel", "notSupportedIn": "", "comment": "Cancel the query
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryOptions.ignoreWarningSearchEvent", "notSupportedIn": "", "comment": "If the analytics component is enabled in the interface, it will look for any query executed by the query controller for which no analytics event was associated.
\nBy setting this property to true, this will cancel this check when the query is performed
Whether or not to log the query in the user actions history when using the page view script: https://github.com/coveo/coveo.analytics.js.\nOnly the 'q' part of the query will be logged.\nThis option is useful, because it prevents the query to be logged twice when a Recommendation component is present.\nIt also makes sure that only relevant queries are logged. For exemple, the 'empty' interface load query isn't logged.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryOptions.origin", "notSupportedIn": "", "comment": "The component from which the query originated. For example the pager will set the property to tweak it's behaviour
\n", "type": "any", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryOptions.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query to execute is a search-as-you-type. This information will be passed down in the query events for component and external code to determine their behavior
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult", "notSupportedIn": "", "comment": "The IQueryResult interface describes a single result returned by the Coveo REST Search API.
The query terms that are not matched by the result.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.childResults", "notSupportedIn": "", "comment": "Contains the child results of the item, if parent-child loading was performed.\nSee the Folding component.
Contains the clickable URI of the item, which you can set on an href in your search interface.\nSee the ResultLink component.
Contains an excerpt of the item. Can be empty for certain types of items (e.g., images, videos, etc.).\nSee the Excerpt component.
Contains the list of flags for the item. Values are separated by a semicolon characters (;).
Contains a value specifying whether the item has an HTML version.\nSee the Quickview component.
Contains the 0-based index value of the result, as returned by the Coveo REST Search API.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.isRecommendation", "notSupportedIn": "", "comment": "Contains a value that specifies whether the result was recommended by the Coveo Machine Learning service.\nSee the Recommendation component.
See also Coveo Machine Learning.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.isTopResult", "notSupportedIn": "", "comment": "Specifies whether the result is a Featured Result in the Coveo Query Pipeline (see Adding and Managing Query Pipeline Featured Results).
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.isUserActionView", "notSupportedIn": "", "comment": "Whether the result item was previously viewed by the user specified in the userActions request of the query.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.parentResult", "notSupportedIn": "", "comment": "Contains the parent result of the item, if parent-child loading was performed.\nSee the Folding component.
Contains a printable URI (or path) to the item.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.queryUid", "notSupportedIn": "", "comment": "Contains the query UID, as returned by the Coveo REST Search API.\nThis value is used mainly for usage analytics.
\nThe Coveo JavaScript Search Framework adds this property client-side to each result.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.rankingInfo", "notSupportedIn": "", "comment": "Contains ranking information, which the Coveo REST Search API returns along with the item when the query\ndebug property is true.
Note:
\n\n\nThe Coveo Cloud V2 platform does not support collaborative rating. Therefore, this property is obsolete in Coveo Cloud V2.
\n
Contains the collaborative rating value for the item.
\nSee the ResultRating component.
Contains the raw field values of the item, expressed as key-value pairs.
\n", "type": "any", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.searchInterface", "notSupportedIn": "", "comment": "The SearchInterface inside which this result is rendered.\nThis value is used mainly to allow for conditional rendering of results templates.
The Coveo JavaScript Search Framework adds this property client-side to each result.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.state", "notSupportedIn": "", "comment": "Contains the query state of the SearchInterface inside which this result is rendered.\nThis value is used mainly to allow for conditional rendering of results templates.
The Coveo JavaScript Search Framework adds this property client-side to each result.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.title", "notSupportedIn": "", "comment": "Contains the title of the item.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResult.uniqueId", "notSupportedIn": "", "comment": "Contains the unique ID of the item.\nThis parameter is useful when making certain calls to a SearchEndpoint.
Contains the URI of the item.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults", "notSupportedIn": "", "comment": "Describe a set a results returned by the Search API
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.advancedExpression", "notSupportedIn": "", "comment": "The advanced expression that was executed.
\nOnly sent if IQuery.debug is true
The search api version that was used for this query.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.basicExpression", "notSupportedIn": "", "comment": "The basic expression that was executed.
\nOnly sent if IQuery.debug is true
Category facet results of the query
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.clientDuration", "notSupportedIn": "", "comment": "The duration of the query for the client.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.constantExpression", "notSupportedIn": "", "comment": "The constant expression that was executed.
\nOnly sent if IQuery.debug is true
The total query duration, which is the sum of the indexDuration and searchAPIDuration, including any latency incurred through the necessary network hops.
When an error occurs, and the errorsAsSuccess flag is passed, the error will be returned in the body of the response
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.exception", "notSupportedIn": "", "comment": "The exception that can be returned by the index if the query triggered an error
\n", "type": "IQueryException", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.executionReport", "notSupportedIn": "", "comment": "A detailed execution report sent by the Search API.
\nOnly sent if IQuery.debug is true
Facet results of the query
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.groupByResults", "notSupportedIn": "", "comment": "The group by results of the query
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.indexDuration", "notSupportedIn": "", "comment": "The part of the total query duration that was spent in the index.
Phrases to highlight (with stemming) in the results
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.pipeline", "notSupportedIn": "", "comment": "The pipeline that was used for this query.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.proxyDuration", "notSupportedIn": "", "comment": "The duration of the query on the proxy (not always applicable, can be optional)
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.queryCorrections", "notSupportedIn": "", "comment": "Possible query corrections (eg : DidYouMean)
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.rankingExpressions", "notSupportedIn": "", "comment": "A list of ranking expression that were used to tweak the relevance.
\nOnly sent if IQuery.debug is true
The keywords selected by Coveo Machine Learning Refined Query feature
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.results", "notSupportedIn": "", "comment": "The results of the query
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.searchAPIDuration", "notSupportedIn": "", "comment": "The part of the total query duration that was spent in the Coveo Search API.
A unique identifier for this query, used mainly for the Analytics service.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.splitTestRun", "notSupportedIn": "", "comment": "The split test run that was used for this query. (A/B tests feature of the Coveo Query Pipeline)
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.termsToHighlight", "notSupportedIn": "", "comment": "Terms to highlight (with stemming) in the results
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.totalCount", "notSupportedIn": "", "comment": "The total number of results that matched the query in the index.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.totalCountFiltered", "notSupportedIn": "", "comment": "The total number of results that matched the query in the index, but with the duplicate filtered.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.triggers", "notSupportedIn": "", "comment": "The Coveo Query Pipeline triggers, if any were configured.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQueryResults.userIdentities", "notSupportedIn": "", "comment": "A list of user identities that were used to perform this query.
\nOnly sent if IQuery.debug is true
Argument sent to all handlers bound on QueryEvents.querySuccess
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuccessEventArgs.query", "notSupportedIn": "", "comment": "The query that was just executed
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuccessEventArgs.queryBuilder", "notSupportedIn": "", "comment": "The QueryBuilder that was used for the current query
\n", "type": "QueryBuilder", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuccessEventArgs.results", "notSupportedIn": "", "comment": "The results returned by the query that was executed
\n", "type": "IQueryResults", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuccessEventArgs.searchAsYouType", "notSupportedIn": "", "comment": "Whether the query is a search-as-you-type
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestCompletion", "notSupportedIn": "", "comment": "The IQuerySuggestCompletion interface describes a completion suggestion from the Coveo Machine Learning\nservice (see Coveo Machine Learning.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestCompletion.executableConfidence", "notSupportedIn": "", "comment": "Contains a value indicating the confidence level that this suggestion should be executed.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestCompletion.expression", "notSupportedIn": "", "comment": "Contains the expression to complete.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestCompletion.highlighted", "notSupportedIn": "", "comment": "Contains the highlighted expression to complete.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestCompletion.score", "notSupportedIn": "", "comment": "Contains a value indicating how certain the Coveo Machine Learning service is that this suggestion is actually\nrelevant.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest", "notSupportedIn": "", "comment": "The IQuerySuggestRequest interface describes a request to the Coveo Machine Learning service query suggest.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.actionsHistory", "notSupportedIn": "", "comment": "Specfies the actions history which represents the past actions a user made. It is generated by the page view script (https://github.com/coveo/coveo.analytics.js)
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.context", "notSupportedIn": "", "comment": "Specifies the context to use for the request.
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.count", "notSupportedIn": "", "comment": "Specifies the number of suggestions that the Coveo Machine Learning service should return.\nDefault value is 5.
Specifies whether to attempt to complete the last word of the current "q" parameter and boost the ranking score of the resulting expression so that it is returned as the first query suggestion.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.isGuestUser", "notSupportedIn": "", "comment": "Whether the current user is anonymous. This can be specified when configuring the SearchEndpoint.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.locale", "notSupportedIn": "", "comment": "The locale of the current user. Will typically match the "language" parameter that is used to perform standard queries.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.pipeline", "notSupportedIn": "", "comment": "Specifies the pipeline to use for the request.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.q", "notSupportedIn": "", "comment": "Specifies the query / word for which to get completion.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.referrer", "notSupportedIn": "", "comment": "Specifies the third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the document.referrer value).
Specifies the search hub for which to get suggestions.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.tab", "notSupportedIn": "", "comment": "Specifies the second level of origin of the request, typically the identifier of the selected tab from which the request originates.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.timezone", "notSupportedIn": "", "comment": "The tz database identifier of the time zone to use to correctly interpret dates in the query expression and result items.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestRequest.visitorId", "notSupportedIn": "", "comment": "A GUID representing the current user, who can be authenticated or anonymous. This GUID is normally generated by the usage analytics service and stored in a non-expiring browser cookie.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestResponse", "notSupportedIn": "", "comment": "The IQuerySuggestResponse interface describes a response from the Coveo Machine Learning service query\nsuggestions.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestResponse.completions", "notSupportedIn": "", "comment": "Contains an array of completions.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySuggestSelection", "notSupportedIn": "", "comment": "Describes the object that all querySuggestGetFocus and querySuggestSelection event handlers receive as an argument.
The query suggestion that had focus or was selected.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuerySummaryCancelLastActionArgs", "notSupportedIn": "", "comment": "Argument sent to all handlers bound on QuerySummaryEvents.cancelLastAction
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IQuickviewLoadedEventArgs", "notSupportedIn": "", "comment": "The IQuickviewLoadedEventArgs interface describes the object that all\nquickviewLoaded event handlers receive as an argument.
The amount of time it took to download the content to display in the quickview modal window (in milliseconds).
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRangeValue", "notSupportedIn": "", "comment": "Describes a single range value in a group by request or facet request.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRangeValue.end", "notSupportedIn": "", "comment": "The value to end the range at.\nExamples:
\n\n\n", "type": "RangeType", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRangeValue.endInclusive", "notSupportedIn": "", "comment": "\n
\n- \n
500- \n
2018-12-31T23:59:59.999Z
Whether to include the end value in the range.
The label to associate with the range value.\nExamples:
\n\n\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRangeValue.start", "notSupportedIn": "", "comment": "\n
\n- \n
0 - 500- \n
In 2018
The value to start the range at.\nExamples:
\n\n\n", "type": "RangeType", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRankingExpression", "notSupportedIn": "", "comment": "\n
\n- \n
0- \n
2018-01-01T00:00:00.000Z
Describe a ranking expression performed against the index (qre)
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRankingExpression.expression", "notSupportedIn": "", "comment": "The expression that was executed in the ranking expression
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRankingExpression.modifier", "notSupportedIn": "", "comment": "The relevance modifier that was applied
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRankingFunction", "notSupportedIn": "", "comment": "Describe a ranking function that can be executed against the index.
\nSee: Ranking Functions
The mathematical expression that calculates the ranking value to add to the result score.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRankingFunction.normalizeWeight", "notSupportedIn": "", "comment": "Whether to normalize the value using the standard index scale or not. If you don't want to completely override the index ranking and use the qrf as a boost, you should turn this on.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRatingRequest", "notSupportedIn": "", "comment": "The IRatingRequest interface describes a request to rate an item in the index.
Contains the rating description.\nPossible values are Undefined | Lowest | Low | Average | Good | Best.
Contains the unique ID of the item to rate.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo", "notSupportedIn": "", "comment": "Information about a request
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo.begun", "notSupportedIn": "", "comment": "The timestamp at which the request started
\n", "type": "Date", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo.headers", "notSupportedIn": "", "comment": "The headers for the request.
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo.method", "notSupportedIn": "", "comment": "The method that was used for this request
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo.queryString", "notSupportedIn": "", "comment": "The query string parameters that were used for this request
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo.requestData", "notSupportedIn": "", "comment": "The data that was sent for this request
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo.requestDataType", "notSupportedIn": "", "comment": "The requestDataType that was used for this request
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IRequestInfo.url", "notSupportedIn": "", "comment": "Url that was requested
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResolvingPositionEventArgs", "notSupportedIn": "", "comment": "The IResolvingPositionEventArgs interface describes the object that all\nonResolvingPosition event handlers receive as an argument.
The array of providers that can provide a position. The first provider that can resolve the position will be used.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResponse", "notSupportedIn": "", "comment": "A generic response
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResponse.data", "notSupportedIn": "", "comment": "Data of the response
\n", "type": "T", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings", "notSupportedIn": "", "comment": "The bindings, or environment in which each component inside the ResultList exists.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings.componentOptionsModel", "notSupportedIn": "", "comment": "Contains the state of options for different components. Mainly used by ResultLink.
\n", "type": "ComponentOptionsModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings.componentStateModel", "notSupportedIn": "", "comment": "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.
\n", "type": "ComponentStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings.queryController", "notSupportedIn": "", "comment": "Contains the singleton that allows to trigger queries.
\n", "type": "QueryController", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings.queryStateModel", "notSupportedIn": "", "comment": "Contains the state of the query. Allows to get/set values. Triggers state event when modified. Each component can listen to those events.
\n", "type": "QueryStateModel", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings.root", "notSupportedIn": "", "comment": "The root HTMLElement of the SearchInterface in which the component exists.
\n", "type": "HTMLElement", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings.searchInterface", "notSupportedIn": "", "comment": "A reference to the root of every component, the SearchInterface.
\n", "type": "SearchInterface", "constrainedValues": [], "miscAttributes": {} }, { "name": "IResultsComponentBindings.usageAnalytics", "notSupportedIn": "", "comment": "A reference to the Analytics.client.
\n", "type": "IAnalyticsClient", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEndpointOptions", "notSupportedIn": "", "comment": "The possible options when creating a SearchEndpoint
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEndpointOptions.accessToken", "notSupportedIn": "", "comment": "This allows using an OAuth2 or a search token to authenticate against the Search API.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEndpointOptions.anonymous", "notSupportedIn": "", "comment": "Specifies that the request (and the Coveo Search API) does not need any kind of authentication.
\nThis flag is only needed for specific setups when your requests are being blocked by your browser. If your queries are executing correctly, you do not need to bother.
\nSetting this flag will prevent the withCredentials option to be set on the XMLHttpRequest, allowing performing cross-domain requests on a server that returns * in the Access-Control-Allow-Origin HTTP header.
This is the password part of the credentials used to authenticate with the REST API.
\nThis option should only be used for development purposes. Including secret credentials in an HTML page that is sent to a client browser is not secure.
Query string arguments to add to every request to the search endpoint.
\neg : {'foo':'bar', 'a':'b'}
Specifies a function that, when called, will arrange for a new search token to be generated.
\nIt is expected to return a Promise that should be resolved with the new token once it's available.
A function which will allow external code to modify all endpoint call parameters before they are sent by the browser.\nUsed in very specific scenario where the network infrastructure require special request headers to be added or removed, for example.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEndpointOptions.restUri", "notSupportedIn": "", "comment": "The uri for the search endpoint. eg: cloudplatform.coveo.com/rest/search
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEndpointOptions.searchAlertsUri", "notSupportedIn": "", "comment": "The uri for the Coveo search alerts service. If not specified, will automatically resolve using the restUri otherwise
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEndpointOptions.username", "notSupportedIn": "", "comment": "This is the username part of the credentials used to authenticate with the Search API using Basic Authentication.
\nThis option should only be used for development purposes. Including secret credentials in an HTML page that is sent to a client browser is not secure.
The XmlHttpRequest implementation to use instead of the native one.\nIf not specified, the native one is used.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent", "notSupportedIn": "", "comment": "Describes a Coveo Cloud usage analytics search event.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.actionCause", "notSupportedIn": "", "comment": "A unique name describing the action that triggered the event.\nSee the name property of the IAnalyticsActionCause interface.
Example: pagerNext
A name describing the category of actions to which the action that triggered the event belongs.\nSee the type property of the IAnalyticsActionCause interface.
Example: getMoreResults
The original advanced query expression (i.e., aq) sent for the related query.\nNote: The framework normally sets this field by retrieving the information from the related query.
Whether the event should be logged anonymously to the Coveo Cloud usage analytics service.\nNote: This field is normally set to the anonymous option value of the Analytics component.
A GUID representing the current user. This GUID is generated locally and stored in a non-expiring browser cookie.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.contextual", "notSupportedIn": "", "comment": "Whether the related query was contextual.\nNote: The framework normally sets this field by retrieving the information from the related query.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.customData", "notSupportedIn": "", "comment": "Additional metadata to send along with the event.\nNote: This field may include custom user context information (see Sending Custom Context Information).
\nExample: { "currentResultsPerPage": 25, "userRole": "developer" }
The name of the device or browser that triggered the event.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
Example: Chrome
Whether the did you mean feature was enabled for the related query.\nNote: The framework normally sets this field by retrieving the information from the related query.
\nExample: @source=="Product Documentation"
A representation of the state of each dynamic facet in the search interface when the action that triggered the event was executed.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.language", "notSupportedIn": "", "comment": "The language of the search interface from which the event originates.\nMust be a valid ISO-639-1 code.
\nNote: By default, the framework sets this field according to the currently loaded culture file (see Changing the Language of Your Search Interface).
\nExample: en
Whether the event originates from a mobile device.\nNote: The framework normally sets this field by parsing the current navigator.userAgent value.
The number of query result items returned by the related query.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.originContext", "notSupportedIn": "", "comment": "The broad application context from which the event originates.\nNote: By default, the framework sets this field to Search. However, you can use the setOriginContext method of the Analytics component to modify the default value.
Example: Search
The identifier of the search interface from which the event originates.\nNote: This field is normally set through the searchHub option of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: PartnerPortalSearch
The identifier of the tab from which the event originates.\nNote: The framework normally sets this field to the identifier of the currently selected Tab in the search interface.
Example: All
The address of the webpage that linked to the search interface from which the event originates.\nNote: The framework normally sets this field to the current document.referrer value.
Example: http://example.com/
The 0-based page of results requested for the related query.\nNote: The framework normally sets this field by retrieving the information from the related query.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.queryPipeline", "notSupportedIn": "", "comment": "The name of the query pipeline to which the related query was routed.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: PartnerPortalSearchPipeline
The original basic query expression (i.e., q) sent for the related query.\nNote: The framework normally sets this field by retrieving the information from the related query.
Example: coveo machine learning
The time it took to get a response from the Search API for the query related to the event (in milliseconds).\nNote: The framework normally sets this field to 0, except for search events in which case it sets the field by retrieving the information from the related Search API query response.
The number of results per page requested for the related query.\nNote: The framework normally sets this field by retrieving the information from the related query.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.searchQueryUid", "notSupportedIn": "", "comment": "The unique identifier of the related query.\nNote: The framework normally sets this field by retrieving the information from the related Search API query response.
\nExample: 74682726-0e20-46eb-85ac-f37259346f57
The name of the A/B test that applied to the related query.\nNote: This field may be set through the splitTestRunName option of the Analytics component. However, if the option is left undefined, the framework attempts to set this field by retrieving information from the related Search API query response.
Example: Test new ART model
The version of the A/B test that applied to the related query (i.e., version A or version B).\nNote: This field may be set through the splitTestRunVersion option of the Analytics component. However, if the option is left undefined and the related Search API query response indicates that an A/B test was applied, the framework sets this field to the name of the query pipeline to which the query was routed.
Example: PartnerPortalSearchPipelineWithART
The software acting on behalf of the end-user whose action triggered the event.\nNote: By default, the framework sets this field to the current navigator.userAgent value.
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36
The display name of the end-user whose action triggered the event.\nNote: This field is normally set to the userDisplayName option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: Alice Smith
The groups the end-user whose action triggered the event belongs to.\nNote: This field is normally left undefined, and the Coveo Cloud usage analytics service attempts to extract the information from the search token when actually recording the event.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISearchEvent.username", "notSupportedIn": "", "comment": "The identifier of the end-user whose action triggered the event.\nNote: This field is normally set to the user option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.
Example: `asmith@example.com`
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISizeOptions", "notSupportedIn": "", "comment": "Available options for the size templateHelpers.\nExample:
\n\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISizeOptions.base", "notSupportedIn": "", "comment": "The base into which to format the value.\nFormula: value 10^(3 base)
\nExamples:
\n\n\nBase 0:
\n1 => 1B
\n1000 => 1KB
\n
\n\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISizeOptions.precision", "notSupportedIn": "", "comment": "Base 1:
\n1 => 1KB
\n1000 => 1MB
\n
The precision to use to format the size (i.e., the number of digits to display after the decimal)\nExamples:
\n\n\nPrecision 0:
\n1.0 => 1
\n1.85 => 1
\n
\n\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IStreamHighlightOptions", "notSupportedIn": "", "comment": "Precision 1:
\n1.0 => 1.0
\n1.85 => 1.8
\n
The possible options when highlighting a stream.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IStreamHighlightOptions.cssClass", "notSupportedIn": "", "comment": "The css class that the highlight will generate.\nDefaults to coveo-highlight.
The regex flags that should be applied to generate the highlighting.\nDefaults to gi.
A JSON which contains type T.\neg :
\nIStringMap<boolean> -> {'foo' : true, 'bar' : false};\nIStringMap<number> -> {'foo' : 1 , 'bar' : 123}\nDescribe a subscription to the Coveo Search alerts service
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscription.frequency", "notSupportedIn": "", "comment": "Frequency of the alerts
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscription.id", "notSupportedIn": "", "comment": "The id of the subscription
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscription.name", "notSupportedIn": "", "comment": "The name that should be used by the API to identify this subscription
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscription.type", "notSupportedIn": "", "comment": "Type of subscription.
\nCan be 'followQuery' or 'followDocument'
Config of the subscription
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscription.user", "notSupportedIn": "", "comment": "The user associated with the subscription
\n", "type": "ISubscriptionUser", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionItemRequest", "notSupportedIn": "", "comment": "The ISubscriptionItemRequest interface describes a subscription to a single item (a result).
Contains the unique ID of the item to subscribe to.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionItemRequest.modifiedDateField", "notSupportedIn": "", "comment": "Indicates which field contains the modification date of the item to subscribe to.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionItemRequest.title", "notSupportedIn": "", "comment": "Contains the title of the item to subscribe to.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionItemRequest.watchedFields", "notSupportedIn": "", "comment": "Contains a list of fields to monitor for the item to subscribe to.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionQueryRequest", "notSupportedIn": "", "comment": "Describe a subscription to a single query
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionQueryRequest.modifiedDateField", "notSupportedIn": "", "comment": "Which field on the result set represent the modification date for which you wish to receive alerts
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionQueryRequest.query", "notSupportedIn": "", "comment": "Query to subscribe to
\n", "type": "IQuery", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionRequest", "notSupportedIn": "", "comment": "Describe a request to subscribe to the Coveo Search alerts service
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionRequest.frequency", "notSupportedIn": "", "comment": "Frequency of the alerts
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionRequest.name", "notSupportedIn": "", "comment": "The name that should be used by the API to identify this subscription
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionRequest.type", "notSupportedIn": "", "comment": "Type of subscription.
\nCan be 'followQuery' or 'followDocument'
Config of the subscription
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionUser", "notSupportedIn": "", "comment": "Describe a user associated with a subscription to the Coveo Search alerts service
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionUser.email", "notSupportedIn": "", "comment": "The email of the user
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISubscriptionUser.manageToken", "notSupportedIn": "", "comment": "The token used to manage the alerts via email.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISuccessResponse", "notSupportedIn": "", "comment": "A generic success response
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISuccessResponse.data", "notSupportedIn": "", "comment": "Data of the response
\n", "type": "T", "constrainedValues": [], "miscAttributes": {} }, { "name": "ISuccessResponse.duration", "notSupportedIn": "", "comment": "The time that the successfull response took to complete
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITaggingRequest", "notSupportedIn": "", "comment": "The ITaggingRequest interface describes a tag request on an item.
Indicates whether to add the tag value, or to remove the tag value.
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITaggingRequest.fieldName", "notSupportedIn": "", "comment": "Contains the field name to tag.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITaggingRequest.fieldValue", "notSupportedIn": "", "comment": "Contains the value to tag.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITaggingRequest.uniqueId", "notSupportedIn": "", "comment": "Contains the unique ID of the item to tag.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITemplateHelperFunction", "notSupportedIn": "", "comment": "A function that describe a templates.\nIt can take any number of arguments, but needs to return a simple string.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITimeSpanUtilsOptions", "notSupportedIn": "", "comment": "The possible options to use when calculating a timespan
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITimeSpanUtilsOptions.isMilliseconds", "notSupportedIn": "", "comment": "Specify if the given timespan is in seconds or milliseconds
\n", "type": "boolean", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITopQueries", "notSupportedIn": "", "comment": "Describe a request to get top queries
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITopQueries.pageSize", "notSupportedIn": "", "comment": "Determine how many suggestions to receive
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITopQueries.queryText", "notSupportedIn": "", "comment": "The query text for which to receive suggestions
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITrigger", "notSupportedIn": "", "comment": "A trigger is an action that the interface will perform (show a message, execute a function, redirect users) depending on the query that was performed.
\nA trigger that can be configured in the Coveo Query Pipeline.
Execute a javascript function present in the page.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITriggerNotify", "notSupportedIn": "", "comment": "Notify (show a message) to a user
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITriggerQuery", "notSupportedIn": "", "comment": "Perform a new query with a different query expression
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "ITriggerRedirect", "notSupportedIn": "", "comment": "Redirect the user to another url
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IUpdateResultPreviewsManagerOptionsEventArgs", "notSupportedIn": "", "comment": "Executed when a Suggestion is focused before PopulateSearchResultPreviews is called to fetch more options.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IUpdateResultPreviewsManagerOptionsEventArgs.displayAfterDuration", "notSupportedIn": "", "comment": "How many milliseconds should a Suggestion be focused for before PopulateSearchResultPreviews is called.\nIf this is not defined, it will default to 200ms.
\n", "type": "number", "constrainedValues": [], "miscAttributes": {} }, { "name": "IUserActionsRequest", "notSupportedIn": "", "comment": "The information about the user we'd like to check and its actions.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IUserActionsRequest.tagViewsOfUser", "notSupportedIn": "", "comment": "The id of the user for which we should check the document views.
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IUserIdentity", "notSupportedIn": "", "comment": "Describe the identity of a user on the Coveo platform
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "IUserIdentity.name", "notSupportedIn": "", "comment": "The name of the identity
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IUserIdentity.provider", "notSupportedIn": "", "comment": "The provider of the identity in the Coveo platform
\n", "type": "string", "constrainedValues": [], "miscAttributes": {} }, { "name": "IViewAsHtmlOptions", "notSupportedIn": "", "comment": "The IViewAsHtmlOptions interface describes the available options when calling against a\nSearchEndpoint to view an item as an HTMLElement (think: quickview).
The basic types of form available to build an advanced search section.
\n", "type": "", "constrainedValues": [], "miscAttributes": {} }, { "name": "Context", "notSupportedIn": "", "comment": "A context, as returned by SearchInterface.getQueryContext or PipelineContext.getContext
\n", "type": "IStringMap", "constrainedValues": [], "miscAttributes": {} }, { "name": "IAnalyticsDocumentViewMeta", "notSupportedIn": "", "comment": "The IAnalyticsDocumentViewMeta interface describes the expected metadata when logging a click event / item view.\nSee also the Analytics component, and more specifically its\nlogClickEvent method.
The IQueryExpression type is a string type dedicated to query expressions.\nThis type is used to build a specific option for query expressions.
The format of a successful response.
\n", "type": "", "constrainedValues": [ "json,opensearch-atom,opensearch-rss,xlsx" ], "miscAttributes": {} }, { "name": "ValidLayout", "notSupportedIn": "", "comment": "The possible valid and supported layouts.\nSee the Result Layouts documentation.
\n", "type": "", "constrainedValues": [ "list,card,table" ], "miscAttributes": {} }, { "name": "ValidTooltipPlacement", "notSupportedIn": "", "comment": "The allowed Quickview tooltipPlacement option values. The -start and -end variations indicate relative alignement. Horizontally (top, bottom), -start means left and -end means right. Vertically (left, right), -start means top and -end means bottom. No variation means center.
ResponsiveFacets options
\n", "type": "object", "constrainedValues": [], "miscAttributes": {} }, { "name": "ResponsiveFacetOptions.dropdownHeaderLabel", "notSupportedIn": "", "comment": "If the enableResponsiveMode option is true for all facets and\nFacetSlider.options.enableResponsiveMode is also true for all sliders, specifies the label of the\ndropdown button that allows to display the facets when in responsive mode.\nIf more than one Facet or FacetSlider component in the search interface specifies a value for this\noption, the framework uses the first occurrence of the option.
Default value is Filters.
Specifies whether to enable responsive mode for facets. Setting this options to false on any Facet, or\nFacetSlider component in a search interface disables responsive mode for all other facets\nin the search interface.\nResponsive mode displays all facets under a single dropdown button whenever the width of the HTML element which\nthe search interface is bound to reaches or falls behind a certain threshold (see\nSearchInterface.responsiveComponents).
See also the dropdownHeaderLabel option.
Default value is true.