Support Menu

Coveo component ExportToExcel

Coveo ExportToExcel Component (CoveoExportToExcel)

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).

Index

Component Options

fieldsToInclude

fieldsToInclude: Array<IFieldOption>

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.

Markup configuration example(s) :
data-fields-to-include='@foo,@foo2'

numberOfResults

numberOfResults: number

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 1.

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

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void
  • 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.

    Returns void

download

  • download(): void

enable

  • enable(): void
  • Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

getBindings

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent
  • Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
    If there is multiple component bound to the current HTMLElement, you must specify the component class.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger component state event when modified. Each component can listen to those events.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton

Constructors

constructor

  • Creates a new ExportToExcel component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IExportToExcelOptions

      The options for the ExportToExcel component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    • Optional _window: Window

      The global Window object (used to download the Excel link).

    Returns ExportToExcel