Specifies the width of a column in a column layout.
Default value is
225. Minimum value is
Specifies the maximum height of a row in a row layout.
Default value is
250. Minimum value is
Specifies the type of layout to display image results with. Available values are:
row: Resizes images to make them fit the width of the container and have the same height for each row.
column: Displays the images in fixed-size columns. Default value is
Builds and returns an HTMLElement for the given result.
the result to build an HTMLElement from.
Builds and returns an array of HTMLElement with the given result set.
the result set to build an array of HTMLElement from.
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.
Executes a query to fetch new results. After the query returns, renders the new results.
Asserts that there are more results to display by verifying whether the last query has returned as many results as requested.
Asserts that the ResultList is not currently fetching results.
The number of results to fetch and display.
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.
Get the fields needed to be automatically included in the query for this result list.
Return the bindings, or environment, for the current component.
Gets the list of currently displayed result.
Gets the list of currently displayed result HTMLElement.
Empties the current result list content and appends the given array of HTMLElement.
Can append to existing elements in the result list, or replace them.
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 differents component. Mainly used by ResultLink.
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.
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.
A reference to the Analytics.client.
The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Creates a new ImageResultList component.
The HTMLElement on which to instantiate the component.
The options for the ImageResultList component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The class that this component should instantiate. Components that extend the base
ResultList component use this. Default value is