|
docs
Community
Feedback
News
Guides
Searching With Coveo
Project Guide
Services
API Reference
JavaScript Search Framework
Headless
Push API
Field API
Search API
Usage Analytics API
Other APIs
Extensions
Coveo for Commerce
Coveo for Salesforce
Coveo for ServiceNow
Coveo for Sitecore
Filter
Inherited
Globals
Omnibox
Result
List
build
Result
build
Results
debug
Info
disable
display
More
Results
enable
get
Auto
Selected
Fields
ToInclude
get
Bindings
get
Displayed
Results
get
Displayed
Results
Elements
render
Results
get
bind
component
Options
Model
component
State
Model
disabled
logger
query
Controller
query
State
Model
root
search
Interface
ID
elements
ToIgnore
usage
Analytics
options
constructor
Globals
OmniboxResultList
Coveo OmniboxResultList Component (CoveoOmniboxResultList)
Index
Methods
build
Result
build
Results
debug
Info
disable
display
More
Results
enable
get
Auto
Selected
Fields
ToInclude
get
Bindings
get
Displayed
Results
get
Displayed
Results
Elements
render
Results
get
Properties
bind
component
Options
Model
component
State
Model
disabled
logger
query
Controller
query
State
Model
root
search
Interface
ID
elements
ToIgnore
Accessors
usage
Analytics
Component Options
header
Title
omniboxZIndex
on
Select
query
Override
Constructors
constructor
Methods
build
Result
build
Result
(
result
:
IQueryResult
)
:
Promise
<
HTMLElement
>
Parameters
result:
IQueryResult
Returns
Promise
<
HTMLElement
>
build
Results
build
Results
(
results
:
IQueryResults
)
:
Promise
<
HTMLElement[]
>
Parameters
results:
IQueryResults
Returns
Promise
<
HTMLElement[]
>
debug
Info
debug
Info
(
)
:
any
Returns
any
disable
disable
(
)
:
void
Returns
void
display
More
Results
display
More
Results
(
count
:
number
)
:
Promise
<
IQueryResults
>
Parameters
count:
number
Returns
Promise
<
IQueryResults
>
enable
enable
(
)
:
void
Returns
void
get
Auto
Selected
Fields
ToInclude
get
Auto
Selected
Fields
ToInclude
(
)
:
string[]
Returns
string[]
get
Bindings
get
Bindings
(
)
:
IComponentBindings
Returns
IComponentBindings
get
Displayed
Results
get
Displayed
Results
(
)
:
IQueryResult[]
Returns
IQueryResult[]
get
Displayed
Results
Elements
get
Displayed
Results
Elements
(
)
:
HTMLElement[]
Returns
HTMLElement[]
render
Results
render
Results
(
resultElements
:
HTMLElement[]
, append
?:
boolean
)
:
Promise
<
any
>
Parameters
resultElements:
HTMLElement[]
Default value
append:
boolean
= false
Returns
Promise
<
any
>
Static
get
get
(
element
:
HTMLElement
, componentClass
?:
any
, noThrow
?:
boolean
)
:
BaseComponent
Parameters
element:
HTMLElement
Optional
componentClass:
any
Optional
noThrow:
boolean
Returns
BaseComponent
Properties
bind
bind
:
ComponentEvents
component
Options
Model
component
Options
Model
:
ComponentOptionsModel
component
State
Model
component
State
Model
:
ComponentStateModel
disabled
disabled
:
boolean
logger
logger
:
Logger
query
Controller
query
Controller
:
QueryController
query
State
Model
query
State
Model
:
QueryStateModel
root
root
:
HTMLElement
search
Interface
search
Interface
:
SearchInterface
Static
ID
ID
:
string
Static
elements
ToIgnore
elements
ToIgnore
:
string[]
Accessors
usage
Analytics
usage
Analytics
:
Component Options
header
Title
header
Title
:
string
Markup configuration example(s) :
data-header-title='foo'
omniboxZIndex
omniboxZIndex
:
number
Markup configuration example(s) :
data-omnibox-z-index='10'
on
Select
on
Select
:
function
Type declaration
(
result
:
IQueryResult
, resultElement
:
HTMLElement
, omniboxObject
:
IPopulateOmniboxEventArgs
)
:
void
Parameters
result:
IQueryResult
resultElement:
HTMLElement
omniboxObject:
IPopulateOmniboxEventArgs
Returns
void
query
Override
query
Override
:
string
Markup configuration example(s) :
data-query-override='foo'
Constructors
constructor
new
Omnibox
Result
List
(
element
:
HTMLElement
, options
?:
IOmniboxResultListOptions
, bindings
?:
IComponentBindings
)
:
OmniboxResultList
Parameters
element:
HTMLElement
Optional
options:
IOmniboxResultListOptions
Optional
bindings:
IComponentBindings
Returns
OmniboxResultList
Implements
IComponentBindings