|
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
Share
Query
close
debug
Info
disable
enable
get
Bindings
get
Complete
Query
get
Link
ToThis
Query
open
set
Complete
Query
set
Link
ToThis
Query
get
bind
component
Options
Model
component
State
Model
disabled
logger
query
Controller
query
State
Model
root
search
Interface
ID
usage
Analytics
constructor
Globals
ShareQuery
Coveo ShareQuery Component (CoveoShareQuery)
Index
Methods
close
debug
Info
disable
enable
get
Bindings
get
Complete
Query
get
Link
ToThis
Query
open
set
Complete
Query
set
Link
ToThis
Query
get
Properties
bind
component
Options
Model
component
State
Model
disabled
logger
query
Controller
query
State
Model
root
search
Interface
ID
Accessors
usage
Analytics
Constructors
constructor
Methods
close
close
(
)
:
void
Returns
void
debug
Info
debug
Info
(
)
:
any
Returns
any
disable
disable
(
)
:
void
Returns
void
enable
enable
(
)
:
void
Returns
void
get
Bindings
get
Bindings
(
)
:
IComponentBindings
Returns
IComponentBindings
get
Complete
Query
get
Complete
Query
(
)
:
string
Returns
string
get
Link
ToThis
Query
get
Link
ToThis
Query
(
)
:
string
Returns
string
open
open
(
)
:
void
Returns
void
set
Complete
Query
set
Complete
Query
(
completeQuery
:
string
)
:
void
Parameters
completeQuery:
string
Returns
void
set
Link
ToThis
Query
set
Link
ToThis
Query
(
link
:
string
)
:
void
Parameters
link:
string
Returns
void
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
Accessors
usage
Analytics
usage
Analytics
:
Constructors
constructor
new
Share
Query
(
element
:
HTMLElement
, options
:
IShareQueryOptions
, bindings
?:
IComponentBindings
, ModalBox
?:
any
)
:
ShareQuery
Parameters
element:
HTMLElement
options:
IShareQueryOptions
Optional
bindings:
IComponentBindings
Default value
ModalBox:
any
= ModalBoxModule
Returns
ShareQuery