The ExportToExcel component renders an item in the Settings menu to allow the end user to export the current search results to the Microsoft Excel format (.xlsx).
Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Component are enabled by default on creation.
Downloads the Excel representation of the current query.
Also logs an
exportToExcel event in the usage analytics.
Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Return the bindings, or environment, for the current component.
Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
If there is multiple component bound to the current HTMLElement, you must specify the component class.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for different components. Mainly used by ResultLink.
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Specifies the fields to include in the CSV output.
Note that this does not affect top level properties such as the title, clickUri, printableUri and sysUri, for example.
Default value is
undefined, meaning all fields will be exported.
Specifies the number of results to include in the resulting Excel file.
Generating and downloading the Excel file should take a reasonably short amount of time when using the default value. However, this amount of time will increase exponentially as you set the value higher.
Consequently, you should avoid setting this value above the default index limit of 1000 search results.
Default value is
100. Minimum value is
Creates a new ExportToExcel component.
The HTMLElement on which to instantiate the component.
The options for the ExportToExcel component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The global Window object (used to download the Excel link).