coveo-search-ui
Version:
Coveo JavaScript Search Framework
1,103 lines • 1.14 MB
JSON
[
{
"name": "AdvancedSearch",
"notSupportedIn": "",
"comment": "<p>The <code>AdvancedSearch</code> component is meant to render a section in the <a href=\"https://coveo.github.io/search-ui/components/settings.html\"><code>Settings</code></a> menu to allow the end\nuser to easily create complex queries to send to the index.\n<strong>Note:</strong></p>\n<blockquote>\n<p>You can write custom code to add new sections in the <strong>Advanced Search</strong> modal box generated by this component by\nattaching a handler to the <a href=\"https://coveo.github.io/search-ui/classes/advancedsearchevents.html#buildingadvancedsearch\"><code>buildingAdvancedSearch</code></a> event.</p>\n</blockquote>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>\n",
"type": "QueryStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.root",
"notSupportedIn": "",
"comment": "<p>A reference to the root HTMLElement (the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>).</p>\n",
"type": "HTMLElement",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.searchInterface",
"notSupportedIn": "",
"comment": "<p>A reference to the root of every component, the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>.</p>\n",
"type": "SearchInterface",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.ID",
"notSupportedIn": "",
"comment": "<p>The static ID that each component needs in order to be identified.<br/>\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.usageAnalytics",
"notSupportedIn": "",
"comment": "<p>A reference to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html#client\">Analytics.client</a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AdvancedSearch.options.includeDate",
"notSupportedIn": "",
"comment": "<p>Specifies whether to include the built-in <strong>Date</strong> section.\nDefault value is <code>true</code>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "true"
}
},
{
"name": "AdvancedSearch.options.includeDocument",
"notSupportedIn": "",
"comment": "<p>Specifies whether to include the built-in <strong>Document</strong> section.\nDefault value is <code>true</code>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "true"
}
},
{
"name": "AdvancedSearch.options.includeKeywords",
"notSupportedIn": "",
"comment": "<p>Specifies whether to include the built-in <strong>Keywords</strong> section.\nDefault value is <code>true</code>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "true"
}
},
{
"name": "AdvancedSearch.constructor",
"notSupportedIn": "",
"comment": "<p>Creates a new <code>AdvancedSearch</code> component.\nTriggers the <a href=\"https://coveo.github.io/search-ui/classes/advancedsearchevents.html#buildingadvancedsearch\"><code>buildingAdvancedSearch</code></a> event.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate",
"notSupportedIn": "",
"comment": "<p>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 <a href=\"https://coveo.github.io/search-ui/interfaces/igroupbyrequest.html\">IGroupByRequest</a>, then displays the result.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>\n",
"type": "QueryStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.root",
"notSupportedIn": "",
"comment": "<p>A reference to the root HTMLElement (the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>).</p>\n",
"type": "HTMLElement",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.searchInterface",
"notSupportedIn": "",
"comment": "<p>A reference to the root of every component, the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>.</p>\n",
"type": "SearchInterface",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.ID",
"notSupportedIn": "",
"comment": "<p>The static ID that each component needs in order to be identified.<br/>\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.usageAnalytics",
"notSupportedIn": "",
"comment": "<p>A reference to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html#client\">Analytics.client</a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.options",
"notSupportedIn": "",
"comment": "<p>The options for the component</p>\n",
"type": "object",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Aggregate.options.field",
"notSupportedIn": "",
"comment": "<p>Specifies the field on which to do the aggregate operation. This parameter is mandatory.</p>\n",
"type": "IFieldOption",
"constrainedValues": [],
"miscAttributes": {
"required": "true"
}
},
{
"name": "Aggregate.options.format",
"notSupportedIn": "",
"comment": "<p>Specifies how to format the value.\nThe available formats are defined in the Globalize library (see\n<a href=\"https://github.com/klaaspieter/jquery-global#globalizeformat-value-format-culture-\">Globalize</a>.</p>\n<p>The most commonly used formats are:</p>\n<ul>\n<li><code>c0</code> - Formats the value as a currency.</li>\n<li><code>n0</code> - Formats the value as an integer.</li>\n<li><code>n2</code> - Formats the value as a floating point with 2 decimal digits.</li>\n</ul>\n<p>Default value is <code>c0</code>.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "c0"
}
},
{
"name": "Aggregate.options.operation",
"notSupportedIn": "",
"comment": "<p>Specifies the aggregate operation to perform.\nThe possible values are:</p>\n<ul>\n<li><code>sum</code> - Computes the sum of the computed field values.</li>\n<li><code>average</code> - Computes the average of the computed field values.</li>\n<li><code>minimum</code> - Finds the minimum value of the computed field values.</li>\n<li><code>maximum</code> - Finds the maximum value of the computed field values.</li>\n</ul>\n<p>Default value is <code>sum</code>.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "sum"
}
},
{
"name": "Aggregate.constructor",
"notSupportedIn": "",
"comment": "<p>Creates a new Aggregate component.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics",
"notSupportedIn": "",
"comment": "<p>The <code>Analytics</code> 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.</p>\n<p>See <a href=\"https://docs.coveo.com/en/365\">JavaScript Search Framework Usage Analytics</a> for an introduction.</p>\n<p>See also <a href=\"https://docs.coveo.com/en/2726/#logging-your-own-search-events\">Logging Your Own Search Events</a> for more advanced use cases.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.client",
"notSupportedIn": "",
"comment": "<p>A reference to the <code>AnalyticsClient</code>, which performs the heavy duty part of sending the usage analytics events to\nthe Coveo Usage Analytics service.</p>\n",
"type": "IAnalyticsClient",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>\n",
"type": "QueryStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.root",
"notSupportedIn": "",
"comment": "<p>A reference to the root HTMLElement (the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>).</p>\n",
"type": "HTMLElement",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.searchInterface",
"notSupportedIn": "",
"comment": "<p>A reference to the root of every component, the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>.</p>\n",
"type": "SearchInterface",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.ID",
"notSupportedIn": "",
"comment": "<p>The static ID that each component needs in order to be identified.<br/>\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.usageAnalytics",
"notSupportedIn": "",
"comment": "<p>A reference to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html#client\">Analytics.client</a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options",
"notSupportedIn": "",
"comment": "<p>Options for the component</p>\n",
"type": "object",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options.anonymous",
"notSupportedIn": "",
"comment": "<p>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 <code>true</code>, 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.</p>\n<p>Default value is <code>false</code>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "false"
}
},
{
"name": "Analytics.options.autoPushToGtmDataLayer",
"notSupportedIn": "",
"comment": "<p>Whether to automatically attempt to push Coveo usage analytics events to the Google Tag Manager <a href=\"https://developers.google.com/tag-manager/devguide#datalayer\">data layer</a>.\nSee also <a href=\"https://coveo.github.io/search-ui/components/analytics.html#options.gtmdatalayername\"><code>gtmDataLayerName</code></a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "false"
}
},
{
"name": "Analytics.options.endpoint",
"notSupportedIn": "",
"comment": "<p>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 <code>https://analytics.cloud.coveo.com/rest/ua</code>, or\n<code>https://analytics-<REGION_ABBREVIATION>.cloud.coveo.com/rest/ua</code> if you have\n<a href=\"https://coveo.github.io/search-ui/classes/searchendpoint.html#configurecloudv2endpoint\">configured your search endpoint</a> to implement\ndata residency outside of the United States.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options.gtmDataLayerName",
"notSupportedIn": "",
"comment": "<p>The name of the Google Tag Manager data layer initialized in the page.\nSee also <a href=\"https://coveo.github.io/search-ui/components/analytics.html#options.autopushtogtmdatalayer\"><code>autoPushToGtmDataLayer</code></a>.</p>\n<p><strong>Note:</strong>\nSetting this option is only useful if the <a href=\"https://developers.google.com/tag-manager/devguide#renaming\">GTM data layer was renamed</a> in the page.</p>\n<p><strong>Default:</strong> <code>dataLayer</code></p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "dataLayer"
}
},
{
"name": "Analytics.options.organization",
"notSupportedIn": "",
"comment": "<p>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 <code>undefined</code>, and the value of this parameter will fallback to the organization used for the\nsearch endpoint.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options.searchHub",
"notSupportedIn": "",
"comment": "<p>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 <code>CommunitySite</code> value to refer to a search page on a public community site.</p>\n<p><strong>Note:</strong></p>\n<blockquote>\n<p>If 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\n<a href=\"https://docs.coveo.com/en/56/\">Search Token Authentication</a>).</p>\n</blockquote>\n<p>Default value is <code>default</code>.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "default"
}
},
{
"name": "Analytics.options.splitTestRunName",
"notSupportedIn": "",
"comment": "<p>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.</p>\n<p>Default value is <code>undefined</code> and no split test run name is reported to the Coveo Usage Analytics service.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options.splitTestRunVersion",
"notSupportedIn": "",
"comment": "<p>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.</p>\n<p>Default value is <code>undefined</code></p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options.token",
"notSupportedIn": "",
"comment": "<p>Specifies the token to use to access the usage analytics endpoint.\nDefault value is <code>undefined</code>, and the component uses the search token.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options.user",
"notSupportedIn": "",
"comment": "<p>Specifies the name of the user for the usage analytics logs.\nDefault value is <code>undefined</code></p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.options.userDisplayName",
"notSupportedIn": "",
"comment": "<p>Specifies the user display name for the usage analytics logs.\nDefault value is <code>undefined</code></p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Analytics.constructor",
"notSupportedIn": "",
"comment": "<p>Creates a new <code>Analytics</code> component. Creates the <a href=\"https://coveo.github.io/search-ui/interfaces/ianalyticsclient.html\"><code>AnalyticsClient</code></a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions",
"notSupportedIn": "",
"comment": "<p>The AnalyticsSuggestion component provides query suggestions based on the queries that a Coveo Analytics service most\ncommonly logs (see <a href=\"https://platform.cloud.coveo.com/docs?urls.primaryName=Usage%20Analytics%20Read#/Statistics%20API%20-%20Version%2015/get__v15_stats_topQueries\"><code>topQueries</code></a>).\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.</p>\n<p>The query suggestions appear in the <a href=\"https://coveo.github.io/search-ui/components/omnibox.html\">Omnibox</a> Component. The AnalyticsSuggestion component strongly\nrelates to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html\">Analytics</a> 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.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>\n",
"type": "QueryStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.root",
"notSupportedIn": "",
"comment": "<p>A reference to the root HTMLElement (the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>).</p>\n",
"type": "HTMLElement",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.searchInterface",
"notSupportedIn": "",
"comment": "<p>A reference to the root of every component, the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>.</p>\n",
"type": "SearchInterface",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.ID",
"notSupportedIn": "",
"comment": "<p>The static ID that each component needs in order to be identified.<br/>\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.usageAnalytics",
"notSupportedIn": "",
"comment": "<p>A reference to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html#client\">Analytics.client</a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.options",
"notSupportedIn": "",
"comment": "<p>The options for the component</p>\n",
"type": "object",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.options.headerTitle",
"notSupportedIn": "",
"comment": "<p>Specifies the title of the query suggestions group in the <a href=\"https://coveo.github.io/search-ui/components/omnibox.html\">Omnibox</a> component. This option is not available\nwhen using the default Lightning Friendly Theme.\nDefault value is the localized string for <code>"Suggested Queries"</code>.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AnalyticsSuggestions.options.numberOfSuggestions",
"notSupportedIn": "",
"comment": "<p>Specifies the number of query suggestions to request and display in the <a href=\"https://coveo.github.io/search-ui/components/omnibox.html\">Omnibox</a> component.\nDefault value is <code>5</code> and minimum value is <code>1</code>.</p>\n",
"type": "number",
"constrainedValues": [],
"miscAttributes": {
"min": "1",
"defaultValue": "5"
}
},
{
"name": "AnalyticsSuggestions.options.omniboxZIndex",
"notSupportedIn": "",
"comment": "<p>Specifies the z-index position at which the query suggestions render themselves in the <a href=\"https://coveo.github.io/search-ui/components/omnibox.html\">Omnibox</a>\ncomponent. Higher values are placed first.\nDefault value is <code>52</code> and minimum value is <code>0</code>.</p>\n",
"type": "number",
"constrainedValues": [],
"miscAttributes": {
"min": "0",
"defaultValue": "52"
}
},
{
"name": "AnalyticsSuggestions.constructor",
"notSupportedIn": "",
"comment": "<p>Creates a new AnalyticsSuggestions component.\nAlso binds event handlers so that when a user selects a suggestion, an <code>omniboxFromLink</code> usage analytics event is\nlogged if the suggestion comes from a standalone search box, or an <code>omniboxAnalytics</code> usage analytics\nevent is logged otherwise.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider",
"notSupportedIn": "",
"comment": "<p>The <code>AuthenticationProvider</code> 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 <a href=\"https://docs.coveo.com/en/113/\">Claims Authentication</a>).\nWhen necessary, this component handles redirecting the browser to the address that starts the authentication process.</p>\n<p>You can use the <code>data-tab</code> attribute to enable the <code>AuthenticationProvider</code> component only for the tabs of your\nsearch interface that require authentication (see the <a href=\"https://coveo.github.io/search-ui/components/tab.html\"><code>Tab</code></a> component).</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>\n",
"type": "QueryStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.root",
"notSupportedIn": "",
"comment": "<p>A reference to the root HTMLElement (the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>).</p>\n",
"type": "HTMLElement",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.searchInterface",
"notSupportedIn": "",
"comment": "<p>A reference to the root of every component, the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>.</p>\n",
"type": "SearchInterface",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.ID",
"notSupportedIn": "",
"comment": "<p>The static ID that each component needs in order to be identified.<br/>\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.usageAnalytics",
"notSupportedIn": "",
"comment": "<p>A reference to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html#client\">Analytics.client</a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.options",
"notSupportedIn": "",
"comment": "<p>The options for the component.</p>\n",
"type": "object",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.options.caption",
"notSupportedIn": "",
"comment": "<p>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 <a href=\"https://coveo.github.io/search-ui/components/authenticationprovider.html#options.name\"><code>name</code></a> option value.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.options.name",
"notSupportedIn": "",
"comment": "<p>Specifies the name of the authentication provider.\nSee <a href=\"https://docs.coveo.com/en/91/\">SAML Authentication</a>.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "AuthenticationProvider.options.showIFrame",
"notSupportedIn": "",
"comment": "<p>If the <a href=\"https://coveo.github.io/search-ui/components/authenticationprovider.html#options.useiframe\"><code>useIFrame</code></a> option is <code>true</code>, specifies whether to make\nthe authentication <code><iframe></code> 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 <code>false</code> reduces the visual\nimpact of the authentication process.</p>\n<p>Default value is <code>true</code>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"depend": "useIFrame",
"defaultValue": "true"
}
},
{
"name": "AuthenticationProvider.options.useIFrame",
"notSupportedIn": "",
"comment": "<p>Specifies whether to use an <code><iframe></code> to host the chain of redirection that make up the authentication\nprocess.\nUsing an <code><iframe></code> prevents leaving the search page as part of the authentication process. However, some login\nproviders refuse to load in an <code><iframe></code>.</p>\n<p>Default value is <code>false</code>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"defaultValue": "false"
}
},
{
"name": "AuthenticationProvider.constructor",
"notSupportedIn": "",
"comment": "<p>Creates a new <code>AuthenticationProvider</code> component.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop",
"notSupportedIn": "",
"comment": "<p>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:</p>\n<pre><code class=\"lang-html\"> <span class=\"hljs-tag\"><<span class=\"hljs-name\">div</span> <span class=\"hljs-attr\">class</span>=<span class=\"hljs-string\">\"CoveoBackdrop\"</span> <span class=\"hljs-attr\">data-image-field</span>=<span class=\"hljs-string\">\"ytthumbnailurl\"</span>></span>\n <span class=\"hljs-tag\"><<span class=\"hljs-name\">div</span> <span class=\"hljs-attr\">class</span>=<span class=\"hljs-string\">\"CoveoFieldValue\"</span> <span class=\"hljs-attr\">data-field</span>=<span class=\"hljs-string\">\"somefield\"</span>></span><span class=\"hljs-tag\"></<span class=\"hljs-name\">div</span>></span>\n <span class=\"hljs-tag\"></<span class=\"hljs-name\">div</span>></span>\n</code></pre>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>\n",
"type": "QueryStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.root",
"notSupportedIn": "",
"comment": "<p>A reference to the root HTMLElement (the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>).</p>\n",
"type": "HTMLElement",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.searchInterface",
"notSupportedIn": "",
"comment": "<p>A reference to the root of every component, the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>.</p>\n",
"type": "SearchInterface",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.ID",
"notSupportedIn": "",
"comment": "<p>The static ID that each component needs in order to be identified.<br/>\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.usageAnalytics",
"notSupportedIn": "",
"comment": "<p>A reference to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html#client\">Analytics.client</a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.options.imageField",
"notSupportedIn": "",
"comment": "<p>Specifies the field from which the background image will be pulled.\nIf <a href=\"https://coveo.github.io/search-ui/components/backdrop.html#options.imageurl\">Backdrop.options.imageUrl</a> is specified, it will override this option.</p>\n",
"type": "IFieldOption",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.options.imageUrl",
"notSupportedIn": "",
"comment": "<p>Specifies a direct URL from which the background image will be sourced.\nHas priority over <a href=\"https://coveo.github.io/search-ui/components/backdrop.html#options.imagefield\">Backdrop.options.imageField</a>.</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.options.overlayColor",
"notSupportedIn": "",
"comment": "<p>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 : "<code>rgba(101, 123, 76, 0.5)</code>"</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Backdrop.options.overlayGradient",
"notSupportedIn": "",
"comment": "<p>Specifies whether the overlay color should be instead be rendered as a top-to-bottom gradient from\n<a href=\"https://coveo.github.io/search-ui/components/backdrop.html#options.overlaycolor\">Backdrop.options.overlayColor</a> to transparent.\nDefault value is <code>false</code>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {
"depend": "overlayColor",
"defaultValue": "false"
}
},
{
"name": "Backdrop.constructor",
"notSupportedIn": "",
"comment": "<p>Creates a new Backdrop component.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge",
"notSupportedIn": "",
"comment": "<p>The Badge component outputs a field value with customizable colors and an icon preceding it.\nThis component is a result template component (see <a href=\"https://docs.coveo.com/en/413/\">Result Templates</a>). It\nextends the <a href=\"https://coveo.github.io/search-ui/components/fieldvalue.html\">FieldValue</a> component. Therefore all FieldValue options are also available for a Badge component.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>\n",
"type": "QueryStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.root",
"notSupportedIn": "",
"comment": "<p>A reference to the root HTMLElement (the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>).</p>\n",
"type": "HTMLElement",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.searchInterface",
"notSupportedIn": "",
"comment": "<p>A reference to the root of every component, the <a href=\"https://coveo.github.io/search-ui/components/searchinterface.html\">SearchInterface</a>.</p>\n",
"type": "SearchInterface",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.ID",
"notSupportedIn": "",
"comment": "<p>The static ID that each component needs in order to be identified.<br/>\nFor example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>\n",
"type": "string",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.usageAnalytics",
"notSupportedIn": "",
"comment": "<p>A reference to the <a href=\"https://coveo.github.io/search-ui/components/analytics.html#client\">Analytics.client</a>.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.options",
"notSupportedIn": "",
"comment": "<p>The options for the component</p>\n",
"type": "object",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.options.colors",
"notSupportedIn": "",
"comment": "<p>Specifies the colors for the Badge component.\nYou must specify the colors in a JSON format similar to what follows:</p>\n<pre><code class=\"lang-json\">{\n <span class=\"hljs-attr\">\"values\"</span>:{\n <span class=\"hljs-attr\">\"foo\"</span>:{\n <span class=\"hljs-attr\">\"icon\"</span>:<span class=\"hljs-string\">\"blue\"</span>,\n <span class=\"hljs-attr\">\"text\"</span>:<span class=\"hljs-string\">\"#222\"</span>\n },\n <span class=\"hljs-attr\">\"bar\"</span>:{\n <span class=\"hljs-attr\">\"icon\"</span>:<span class=\"hljs-string\">\"green\"</span>,\n <span class=\"hljs-attr\">\"text\"</span>:<span class=\"hljs-string\">\"lightgreen\"</span>\n }\n },\n <span class=\"hljs-attr\">\"icon\"</span>:<span class=\"hljs-string\">\"red\"</span>,\n <span class=\"hljs-attr\">\"text\"</span>:<span class=\"hljs-string\">\"#9ab52b\"</span>\n}\n</code></pre>\n<p>This format allows you to customize both the icon and text colors for each field value as well as the default\nvalues.</p>\n<p>Colors can be specified in HTML or hexadecimal format.</p>\n",
"type": "IBadgeColors",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Badge.constructor",
"notSupportedIn": "",
"comment": "<p>Creates a new Badge component.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb",
"notSupportedIn": "",
"comment": "<p>The Breadcrumb component displays a summary of the currently active query filters.\nFor example, when the user selects a <a href=\"https://coveo.github.io/search-ui/components/facet.html\">Facet</a> value, the breadcrumbs display this value.</p>\n<p>The active filters are obtained by the component by firing an event in the Breadcrumb component.</p>\n<p>All other components having an active state can react to this event by providing custom bits of HTML to display\ninside the breadcrumbs.</p>\n<p>Thus, it is possible to easily extend the Breadcrumb component using custom code to display information about custom\nstates and filters.</p>\n<p>See <a href=\"https://coveo.github.io/search-ui/classes/breadcrumbevents.html\">BreadcrumbEvents</a> for the list of events and parameters sent when a Breadcrumb component is populated.</p>\n",
"type": "",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb.bind",
"notSupportedIn": "",
"comment": "<p>Allows the component to bind events and execute them only when it is enabled.</p>\n",
"type": "ComponentEvents",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb.componentOptionsModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of options for different components. Mainly used by <a href=\"https://coveo.github.io/search-ui/components/resultlink.html\">ResultLink</a>.</p>\n",
"type": "ComponentOptionsModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb.componentStateModel",
"notSupportedIn": "",
"comment": "<p>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.</p>\n",
"type": "ComponentStateModel",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb.disabled",
"notSupportedIn": "",
"comment": "<p>A disabled component will not participate in the query, or listen to <a href=\"https://coveo.github.io/search-ui/classes/componentevents.html\">ComponentEvents</a>.</p>\n",
"type": "boolean",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb.logger",
"notSupportedIn": "",
"comment": "<p>Allows component to log in the dev console.</p>\n",
"type": "Logger",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb.queryController",
"notSupportedIn": "",
"comment": "<p>Contains the singleton that allows to trigger queries.</p>\n",
"type": "QueryController",
"constrainedValues": [],
"miscAttributes": {}
},
{
"name": "Breadcrumb.queryStateModel",
"notSupportedIn": "",
"comment": "<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each