|
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
Dom
add
Class
append
can
Handle
Event
children
clone
closest
css
detach
empty
find
find
All
find
Class
find
Id
focus
get
Attribute
get
Class
has
Class
height
hide
insert
After
insert
Before
is
is
Descendant
is
Empty
is
Valid
is
Visible
off
offset
offset
Parent
on
one
parent
parents
position
prepend
remove
remove
Class
replace
With
set
Attribute
set
Html
show
siblings
text
toggle
toggle
Class
trigger
unhide
width
create
Element
node
List
ToArray
use
Native
Java
Script
Events
constructor
Globals
Dom
Class Dom
Index
Methods
add
Class
append
can
Handle
Event
children
clone
closest
css
detach
empty
find
find
All
find
Class
find
Id
focus
get
Attribute
get
Class
has
Class
height
hide
insert
After
insert
Before
is
is
Descendant
is
Empty
is
Valid
is
Visible
off
offset
offset
Parent
on
one
parent
parents
position
prepend
remove
remove
Class
replace
With
set
Attribute
set
Html
show
siblings
text
toggle
toggle
Class
trigger
unhide
width
create
Element
node
List
ToArray
Properties
use
Native
Java
Script
Events
Constructors
constructor
Methods
add
Class
add
Class
(
classNames
:
string[]
)
:
void
Parameters
classNames:
string[]
Returns
void
append
append
(
element
:
HTMLElement
)
:
void
Parameters
element:
HTMLElement
Returns
void
can
Handle
Event
can
Handle
Event
(
eventName
:
string
)
:
boolean
Parameters
eventName:
string
Returns
boolean
children
children
(
)
:
HTMLElement[]
Returns
HTMLElement[]
clone
clone
(
deep
?:
boolean
)
:
Dom
Parameters
Default value
deep:
boolean
= false
Returns
Dom
closest
closest
(
className
:
string
)
:
HTMLElement
Parameters
className:
string
Returns
HTMLElement
css
css
(
property
:
string
)
:
string
Parameters
property:
string
Returns
string
detach
detach
(
)
:
void
Returns
void
empty
empty
(
)
:
void
Returns
void
find
find
(
selector
:
string
)
:
HTMLElement
Parameters
selector:
string
Returns
HTMLElement
find
All
find
All
(
selector
:
string
)
:
HTMLElement[]
Parameters
selector:
string
Returns
HTMLElement[]
find
Class
find
Class
(
className
:
string
)
:
HTMLElement[]
Parameters
className:
string
Returns
HTMLElement[]
find
Id
find
Id
(
id
:
string
)
:
HTMLElement
Parameters
id:
string
Returns
HTMLElement
focus
focus
(
preserveScroll
:
boolean
)
:
void
Parameters
preserveScroll:
boolean
Returns
void
get
Attribute
get
Attribute
(
name
:
string
)
:
string
Parameters
name:
string
Returns
string
get
Class
get
Class
(
)
:
string[]
Returns
string[]
has
Class
has
Class
(
className
:
string
)
:
boolean
Parameters
className:
string
Returns
boolean
height
height
(
)
:
number
Returns
number
hide
hide
(
)
:
void
Returns
void
insert
After
insert
After
(
refNode
:
HTMLElement
)
:
void
Parameters
refNode:
HTMLElement
Returns
void
insert
Before
insert
Before
(
refNode
:
HTMLElement
)
:
void
Parameters
refNode:
HTMLElement
Returns
void
is
is
(
selector
:
string
)
:
boolean
Parameters
selector:
string
Returns
boolean
is
Descendant
is
Descendant
(
parent
:
HTMLElement
)
:
boolean
Parameters
parent:
HTMLElement
Returns
boolean
is
Empty
is
Empty
(
)
:
boolean
Returns
boolean
is
Valid
is
Valid
(
)
:
boolean
Returns
boolean
is
Visible
is
Visible
(
)
:
boolean
Returns
boolean
off
off
(
types
:
string[]
, eventHandle
:
function
)
:
void
Parameters
types:
string[]
eventHandle:
function
(
evt
:
Event
, arg
?:
any
)
:
void
Parameters
evt:
Event
Optional
arg:
any
Returns
void
Returns
void
offset
offset
(
)
:
IOffset
Returns
IOffset
offset
Parent
offset
Parent
(
)
:
HTMLElement
Returns
HTMLElement
on
on
(
types
:
string[]
, eventHandle
:
function
)
:
void
Parameters
types:
string[]
eventHandle:
function
(
evt
:
Event
, data
:
any
)
:
void
Parameters
evt:
Event
data:
any
Returns
void
Returns
void
one
one
(
types
:
string[]
, eventHandle
:
function
)
:
void
Parameters
types:
string[]
eventHandle:
function
(
evt
:
Event
, args
?:
any
)
:
void
Parameters
evt:
Event
Optional
args:
any
Returns
void
Returns
void
parent
parent
(
className
:
string
)
:
HTMLElement
Parameters
className:
string
Returns
HTMLElement
parents
parents
(
className
:
string
)
:
HTMLElement[]
Parameters
className:
string
Returns
HTMLElement[]
position
position
(
)
:
IOffset
Returns
IOffset
prepend
prepend
(
toPrepend
:
HTMLElement
)
:
void
Parameters
toPrepend:
HTMLElement
Returns
void
remove
remove
(
)
:
void
Returns
void
remove
Class
remove
Class
(
className
:
string
)
:
void
Parameters
className:
string
Returns
void
replace
With
replace
With
(
otherElem
:
HTMLElement
)
:
void
Parameters
otherElem:
HTMLElement
Returns
void
set
Attribute
set
Attribute
(
name
:
string
, value
:
string
)
:
void
Parameters
name:
string
value:
string
Returns
void
set
Html
set
Html
(
html
:
string
)
:
void
Parameters
html:
string
Returns
void
show
show
(
)
:
void
Returns
void
siblings
siblings
(
selector
:
string
)
:
HTMLElement[]
Parameters
selector:
string
Returns
HTMLElement[]
text
text
(
txt
?:
string
)
:
string
Parameters
Optional
txt:
string
Returns
string
toggle
toggle
(
visible
?:
boolean
)
:
void
Parameters
Optional
visible:
boolean
Returns
void
toggle
Class
toggle
Class
(
className
:
string
, swtch
?:
boolean
)
:
void
Parameters
className:
string
Optional
swtch:
boolean
Returns
void
trigger
trigger
(
type
:
string
, data
?:
object
)
:
void
Parameters
type:
string
Optional
data:
object
[
key:
string
]:
any
Returns
void
unhide
unhide
(
)
:
void
Returns
void
width
width
(
)
:
number
Returns
number
Static
create
Element
create
Element
(
type
:
string
, props
?:
Object
,
...
children
:
Array
<
string
|
HTMLElement
|
Dom
>
)
:
HTMLElement
Parameters
type:
string
Optional
props:
Object
Rest
...
children:
Array
<
string
|
HTMLElement
|
Dom
>
Returns
HTMLElement
Static
node
List
ToArray
node
List
ToArray
(
nodeList
:
NodeList
)
:
HTMLElement[]
Parameters
nodeList:
NodeList
Returns
HTMLElement[]
Properties
Static
use
Native
Java
Script
Events
use
Native
Java
Script
Events
:
boolean
Constructors
constructor
new
Dom
(
el
:
HTMLElement
)
:
Dom
Parameters
el:
HTMLElement
Returns
Dom
Hierarchy
Dom