Appearance
@tmrw-realityos/charm • Docs
@tmrw-realityos/charm / ROSPlayer
Class: ROSPlayer
Can load and display GLTF models.
Examples
Use as a web component
HTML properties:
- environmentURL: IBL light environment to load
- transparent-background
html
<ros-player transparent-background environmentURL="environments/field.hdre">
<ros-model model-url="path-to-file.glb"></ros-model>
</ros-player>
Use from typescript and javascript
typescript
const renderer = new ROSPlayer()
renderer.transparentBackground = false
renderer.appendChild(new ROSModel('assets/scene.gltf'))
renderer.environmentURL = 'environments/field.hdre'
document.body.appendChild(renderer)
Extends
LitElement
Implements
Constructors
new ROSPlayer()
new ROSPlayer():
ROSPlayer
Returns
Overrides
LitElement.constructor
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:176
HTML Properties
alwaysRerender
alwaysRerender:
boolean
=false
Force rendering in the frame loop, otherwise only render on demand.
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:90
backgroundColor
backgroundColor:
RGBAColor
Set the background color Color is in the format of rgba(n,n,n,a) or rgb(n,n,n) where n is 0-255 and a is 0.0-1.0 The alpha blending with other html elements is controled via transparent-background
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:103
highlightColor
highlightColor:
RGBAColor
Set the highlight color of a selected object
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:128
outlineColor
outlineColor:
RGBAColor
Set the outline color of a selected object Color is in the format rgb(n,n,n) where n is 0-255
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:116
HTML Properties
Environment map used for reflections and lightning. Must be in the HDRE format.
environmentURL?
optional
environmentURL:string
=""
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:80
Other
_offCameraMoved?
optional
_offCameraMoved:RemoveEventListener
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:200
_offKeyUp?
optional
_offKeyUp:RemoveEventListener
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:173
_offRenderAlpha?
optional
_offRenderAlpha:RemoveEventListener
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:174
accessKey
accessKey:
string
Inherited from
LitElement.accessKey
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10036
accessKeyLabel
readonly
accessKeyLabel:string
Inherited from
LitElement.accessKeyLabel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10038
ariaAtomic
ariaAtomic:
null
|string
Implementation of
Inherited from
LitElement.ariaAtomic
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2229
ariaAutoComplete
ariaAutoComplete:
null
|string
Implementation of
Inherited from
LitElement.ariaAutoComplete
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2231
ariaBrailleLabel
ariaBrailleLabel:
null
|string
Implementation of
Inherited from
LitElement.ariaBrailleLabel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2233
ariaBrailleRoleDescription
ariaBrailleRoleDescription:
null
|string
Implementation of
ROSHost
.ariaBrailleRoleDescription
Inherited from
LitElement.ariaBrailleRoleDescription
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2235
ariaBusy
ariaBusy:
null
|string
Implementation of
Inherited from
LitElement.ariaBusy
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2237
ariaChecked
ariaChecked:
null
|string
Implementation of
Inherited from
LitElement.ariaChecked
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2239
ariaColCount
ariaColCount:
null
|string
Implementation of
Inherited from
LitElement.ariaColCount
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2241
ariaColIndex
ariaColIndex:
null
|string
Implementation of
Inherited from
LitElement.ariaColIndex
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2243
ariaColSpan
ariaColSpan:
null
|string
Implementation of
Inherited from
LitElement.ariaColSpan
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2245
ariaCurrent
ariaCurrent:
null
|string
Implementation of
Inherited from
LitElement.ariaCurrent
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2247
ariaDescription
ariaDescription:
null
|string
Implementation of
Inherited from
LitElement.ariaDescription
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2249
ariaDisabled
ariaDisabled:
null
|string
Implementation of
Inherited from
LitElement.ariaDisabled
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2251
ariaExpanded
ariaExpanded:
null
|string
Implementation of
Inherited from
LitElement.ariaExpanded
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2253
ariaHasPopup
ariaHasPopup:
null
|string
Implementation of
Inherited from
LitElement.ariaHasPopup
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2255
ariaHidden
ariaHidden:
null
|string
Implementation of
Inherited from
LitElement.ariaHidden
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2257
ariaInvalid
ariaInvalid:
null
|string
Implementation of
Inherited from
LitElement.ariaInvalid
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2258
ariaKeyShortcuts
ariaKeyShortcuts:
null
|string
Implementation of
Inherited from
LitElement.ariaKeyShortcuts
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2260
ariaLabel
ariaLabel:
null
|string
Implementation of
Inherited from
LitElement.ariaLabel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2262
ariaLevel
ariaLevel:
null
|string
Implementation of
Inherited from
LitElement.ariaLevel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2264
ariaLive
ariaLive:
null
|string
Implementation of
Inherited from
LitElement.ariaLive
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2266
ariaModal
ariaModal:
null
|string
Implementation of
Inherited from
LitElement.ariaModal
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2268
ariaMultiLine
ariaMultiLine:
null
|string
Implementation of
Inherited from
LitElement.ariaMultiLine
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2270
ariaMultiSelectable
ariaMultiSelectable:
null
|string
Implementation of
Inherited from
LitElement.ariaMultiSelectable
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2272
ariaOrientation
ariaOrientation:
null
|string
Implementation of
Inherited from
LitElement.ariaOrientation
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2274
ariaPlaceholder
ariaPlaceholder:
null
|string
Implementation of
Inherited from
LitElement.ariaPlaceholder
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2276
ariaPosInSet
ariaPosInSet:
null
|string
Implementation of
Inherited from
LitElement.ariaPosInSet
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2278
ariaPressed
ariaPressed:
null
|string
Implementation of
Inherited from
LitElement.ariaPressed
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2280
ariaReadOnly
ariaReadOnly:
null
|string
Implementation of
Inherited from
LitElement.ariaReadOnly
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2282
ariaRequired
ariaRequired:
null
|string
Implementation of
Inherited from
LitElement.ariaRequired
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2284
ariaRoleDescription
ariaRoleDescription:
null
|string
Implementation of
Inherited from
LitElement.ariaRoleDescription
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2286
ariaRowCount
ariaRowCount:
null
|string
Implementation of
Inherited from
LitElement.ariaRowCount
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2288
ariaRowIndex
ariaRowIndex:
null
|string
Implementation of
Inherited from
LitElement.ariaRowIndex
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2290
ariaRowSpan
ariaRowSpan:
null
|string
Implementation of
Inherited from
LitElement.ariaRowSpan
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2292
ariaSelected
ariaSelected:
null
|string
Implementation of
Inherited from
LitElement.ariaSelected
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2294
ariaSetSize
ariaSetSize:
null
|string
Implementation of
Inherited from
LitElement.ariaSetSize
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2296
ariaSort
ariaSort:
null
|string
Implementation of
Inherited from
LitElement.ariaSort
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2298
ariaValueMax
ariaValueMax:
null
|string
Implementation of
Inherited from
LitElement.ariaValueMax
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2300
ariaValueMin
ariaValueMin:
null
|string
Implementation of
Inherited from
LitElement.ariaValueMin
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2302
ariaValueNow
ariaValueNow:
null
|string
Implementation of
Inherited from
LitElement.ariaValueNow
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2304
ariaValueText
ariaValueText:
null
|string
Implementation of
Inherited from
LitElement.ariaValueText
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2306
assignedSlot
readonly
assignedSlot:null
|HTMLSlotElement
Implementation of
Inherited from
LitElement.assignedSlot
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:21074
ATTRIBUTE_NODE
readonly
ATTRIBUTE_NODE:2
Implementation of
Inherited from
LitElement.ATTRIBUTE_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15963
attributes
readonly
attributes:NamedNodeMap
Implementation of
Inherited from
LitElement.attributes
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7687
attributeStyleMap
readonly
attributeStyleMap:StylePropertyMap
Inherited from
LitElement.attributeStyleMap
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7950
autocapitalize
autocapitalize:
string
Inherited from
LitElement.autocapitalize
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10040
autofocus
autofocus:
boolean
Inherited from
LitElement.autofocus
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:11845
baseURI
readonly
baseURI:string
Returns node's node document's document base URL.
Implementation of
Inherited from
LitElement.baseURI
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15832
bloom
bloom:
number
=0.5
Bloom postprocessing effect persitence. Only applicable if postfx is true.
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:151
CDATA_SECTION_NODE
readonly
CDATA_SECTION_NODE:4
node is a CDATASection node.
Implementation of
Inherited from
LitElement.CDATA_SECTION_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15967
childElementCount
readonly
childElementCount:number
Implementation of
Inherited from
LitElement.childElementCount
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16525
childNodes
readonly
childNodes:NodeListOf
<ChildNode
>
Returns the children.
Implementation of
Inherited from
LitElement.childNodes
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15838
children
readonly
children:HTMLCollection
Returns the child elements.
Implementation of
Inherited from
LitElement.children
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16531
classList
readonly
classList:DOMTokenList
Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Implementation of
Inherited from
LitElement.classList
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7693
className
className:
string
Returns the value of element's class content attribute. Can be set to change it.
Implementation of
Inherited from
LitElement.className
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7699
clientHeight
readonly
clientHeight:number
Implementation of
Inherited from
LitElement.clientHeight
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7701
clientLeft
readonly
clientLeft:number
Implementation of
Inherited from
LitElement.clientLeft
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7703
clientTop
readonly
clientTop:number
Implementation of
Inherited from
LitElement.clientTop
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7705
clientWidth
readonly
clientWidth:number
Implementation of
Inherited from
LitElement.clientWidth
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7707
COMMENT_NODE
readonly
COMMENT_NODE:8
node is a Comment node.
Implementation of
Inherited from
LitElement.COMMENT_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15973
contentEditable
contentEditable:
string
Inherited from
LitElement.contentEditable
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7957
dataset
readonly
dataset:DOMStringMap
Inherited from
LitElement.dataset
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:11847
dir
dir:
string
Inherited from
LitElement.dir
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10042
DOCUMENT_FRAGMENT_NODE
readonly
DOCUMENT_FRAGMENT_NODE:11
node is a DocumentFragment node.
Implementation of
ROSHost
.DOCUMENT_FRAGMENT_NODE
Inherited from
LitElement.DOCUMENT_FRAGMENT_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15979
DOCUMENT_NODE
readonly
DOCUMENT_NODE:9
node is a document.
Implementation of
Inherited from
LitElement.DOCUMENT_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15975
DOCUMENT_POSITION_CONTAINED_BY
readonly
DOCUMENT_POSITION_CONTAINED_BY:16
Set when other is a descendant of node.
Implementation of
ROSHost
.DOCUMENT_POSITION_CONTAINED_BY
Inherited from
LitElement.DOCUMENT_POSITION_CONTAINED_BY
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15990
DOCUMENT_POSITION_CONTAINS
readonly
DOCUMENT_POSITION_CONTAINS:8
Set when other is an ancestor of node.
Implementation of
ROSHost
.DOCUMENT_POSITION_CONTAINS
Inherited from
LitElement.DOCUMENT_POSITION_CONTAINS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15988
DOCUMENT_POSITION_DISCONNECTED
readonly
DOCUMENT_POSITION_DISCONNECTED:1
Set when node and other are not in the same tree.
Implementation of
ROSHost
.DOCUMENT_POSITION_DISCONNECTED
Inherited from
LitElement.DOCUMENT_POSITION_DISCONNECTED
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15982
DOCUMENT_POSITION_FOLLOWING
readonly
DOCUMENT_POSITION_FOLLOWING:4
Set when other is following node.
Implementation of
ROSHost
.DOCUMENT_POSITION_FOLLOWING
Inherited from
LitElement.DOCUMENT_POSITION_FOLLOWING
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15986
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonly
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC:32
Implementation of
ROSHost
.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
Inherited from
LitElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15991
DOCUMENT_POSITION_PRECEDING
readonly
DOCUMENT_POSITION_PRECEDING:2
Set when other is preceding node.
Implementation of
ROSHost
.DOCUMENT_POSITION_PRECEDING
Inherited from
LitElement.DOCUMENT_POSITION_PRECEDING
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15984
DOCUMENT_TYPE_NODE
readonly
DOCUMENT_TYPE_NODE:10
node is a doctype.
Implementation of
Inherited from
LitElement.DOCUMENT_TYPE_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15977
draggable
draggable:
boolean
Inherited from
LitElement.draggable
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10044
ELEMENT_NODE
readonly
ELEMENT_NODE:1
node is an element.
Implementation of
Inherited from
LitElement.ELEMENT_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15962
enterKeyHint
enterKeyHint:
string
Inherited from
LitElement.enterKeyHint
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7959
ENTITY_NODE
readonly
ENTITY_NODE:6
Implementation of
Inherited from
LitElement.ENTITY_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15969
ENTITY_REFERENCE_NODE
readonly
ENTITY_REFERENCE_NODE:5
Implementation of
Inherited from
LitElement.ENTITY_REFERENCE_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15968
environmentFormat?
optional
environmentFormat:string
=""
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:83
exposure
exposure:
number
=1
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:131
firstChild
readonly
firstChild:null
|ChildNode
Returns the first child.
Implementation of
Inherited from
LitElement.firstChild
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15844
firstElementChild
readonly
firstElementChild:null
|Element
Returns the first child that is an element, and null otherwise.
Implementation of
Inherited from
LitElement.firstElementChild
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16537
hidden
hidden:
boolean
Inherited from
LitElement.hidden
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10046
id
id:
string
Returns the value of element's id content attribute. Can be set to change it.
Implementation of
Inherited from
LitElement.id
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7713
inert
inert:
boolean
Inherited from
LitElement.inert
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10048
innerHTML
innerHTML:
string
Implementation of
Inherited from
LitElement.innerHTML
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7715
innerText
innerText:
string
Inherited from
LitElement.innerText
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10050
inputMode
inputMode:
string
Inherited from
LitElement.inputMode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7961
isConnected
readonly
isConnected:boolean
Returns true if node is connected and false otherwise.
Implementation of
Inherited from
LitElement.isConnected
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15850
isContentEditable
readonly
isContentEditable:boolean
Inherited from
LitElement.isContentEditable
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7963
lang
lang:
string
Inherited from
LitElement.lang
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10052
lastChild
readonly
lastChild:null
|ChildNode
Returns the last child.
Implementation of
Inherited from
LitElement.lastChild
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15856
lastElementChild
readonly
lastElementChild:null
|Element
Returns the last child that is an element, and null otherwise.
Implementation of
Inherited from
LitElement.lastElementChild
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16543
localName
readonly
localName:string
Returns the local name.
Implementation of
Inherited from
LitElement.localName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7721
main_node
main_node:
Node
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:159
msaa
msaa:
number
=1
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:139
namespaceURI
readonly
namespaceURI:null
|string
Returns the namespace.
Implementation of
Inherited from
LitElement.namespaceURI
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7727
nextElementSibling
readonly
nextElementSibling:null
|Element
Returns the first following sibling that is an element, and null otherwise.
Implementation of
Inherited from
LitElement.nextElementSibling
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16112
nextSibling
readonly
nextSibling:null
|ChildNode
Returns the next sibling.
Implementation of
Inherited from
LitElement.nextSibling
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15862
nodeName
readonly
nodeName:string
Returns a string appropriate for the type of node.
Implementation of
Inherited from
LitElement.nodeName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15868
nodeType
readonly
nodeType:number
Returns the type of node.
Implementation of
Inherited from
LitElement.nodeType
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15874
nodeValue
nodeValue:
null
|string
Implementation of
Inherited from
LitElement.nodeValue
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15876
nonce?
optional
nonce:string
Inherited from
LitElement.nonce
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:11849
NOTATION_NODE
readonly
NOTATION_NODE:12
Implementation of
Inherited from
LitElement.NOTATION_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15980
offsetHeight
readonly
offsetHeight:number
Inherited from
LitElement.offsetHeight
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10054
offsetLeft
readonly
offsetLeft:number
Inherited from
LitElement.offsetLeft
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10056
offsetParent
readonly
offsetParent:null
|Element
Inherited from
LitElement.offsetParent
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10058
offsetTop
readonly
offsetTop:number
Inherited from
LitElement.offsetTop
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10060
offsetWidth
readonly
offsetWidth:number
Inherited from
LitElement.offsetWidth
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10062
onabort
onabort:
null
| (this
,ev
) =>any
Fires when the user aborts the download.
Param
The event.
Inherited from
LitElement.onabort
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9032
onanimationcancel
onanimationcancel:
null
| (this
,ev
) =>any
Inherited from
LitElement.onanimationcancel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9034
onanimationend
onanimationend:
null
| (this
,ev
) =>any
Inherited from
LitElement.onanimationend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9036
onanimationiteration
onanimationiteration:
null
| (this
,ev
) =>any
Inherited from
LitElement.onanimationiteration
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9038
onanimationstart
onanimationstart:
null
| (this
,ev
) =>any
Inherited from
LitElement.onanimationstart
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9040
onauxclick
onauxclick:
null
| (this
,ev
) =>any
Inherited from
LitElement.onauxclick
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9042
onbeforeinput
onbeforeinput:
null
| (this
,ev
) =>any
Inherited from
LitElement.onbeforeinput
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9044
onbeforetoggle
onbeforetoggle:
null
| (this
,ev
) =>any
Inherited from
LitElement.onbeforetoggle
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9046
onblur
onblur:
null
| (this
,ev
) =>any
Fires when the object loses the input focus.
Param
The focus event.
Inherited from
LitElement.onblur
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9053
oncancel
oncancel:
null
| (this
,ev
) =>any
Inherited from
LitElement.oncancel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9055
oncanplay
oncanplay:
null
| (this
,ev
) =>any
Occurs when playback is possible, but would require further buffering.
Param
The event.
Inherited from
LitElement.oncanplay
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9062
oncanplaythrough
oncanplaythrough:
null
| (this
,ev
) =>any
Inherited from
LitElement.oncanplaythrough
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9064
onchange
onchange:
null
| (this
,ev
) =>any
Fires when the contents of the object or selection have changed.
Param
The event.
Inherited from
LitElement.onchange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9071
onclick
onclick:
null
| (this
,ev
) =>any
Fires when the user clicks the left mouse button on the object
Param
The mouse event.
Inherited from
LitElement.onclick
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9078
onclose
onclose:
null
| (this
,ev
) =>any
Inherited from
LitElement.onclose
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9080
oncontextlost
oncontextlost:
null
| (this
,ev
) =>any
Inherited from
LitElement.oncontextlost
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9082
oncontextmenu
oncontextmenu:
null
| (this
,ev
) =>any
Fires when the user clicks the right mouse button in the client area, opening the context menu.
Param
The mouse event.
Inherited from
LitElement.oncontextmenu
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9089
oncontextrestored
oncontextrestored:
null
| (this
,ev
) =>any
Inherited from
LitElement.oncontextrestored
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9091
oncopy
oncopy:
null
| (this
,ev
) =>any
Inherited from
LitElement.oncopy
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9093
oncuechange
oncuechange:
null
| (this
,ev
) =>any
Inherited from
LitElement.oncuechange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9095
oncut
oncut:
null
| (this
,ev
) =>any
Inherited from
LitElement.oncut
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9097
ondblclick
ondblclick:
null
| (this
,ev
) =>any
Fires when the user double-clicks the object.
Param
The mouse event.
Inherited from
LitElement.ondblclick
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9104
ondrag
ondrag:
null
| (this
,ev
) =>any
Fires on the source object continuously during a drag operation.
Param
The event.
Inherited from
LitElement.ondrag
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9111
ondragend
ondragend:
null
| (this
,ev
) =>any
Fires on the source object when the user releases the mouse at the close of a drag operation.
Param
The event.
Inherited from
LitElement.ondragend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9118
ondragenter
ondragenter:
null
| (this
,ev
) =>any
Fires on the target element when the user drags the object to a valid drop target.
Param
The drag event.
Inherited from
LitElement.ondragenter
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9125
ondragleave
ondragleave:
null
| (this
,ev
) =>any
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Param
The drag event.
Inherited from
LitElement.ondragleave
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9132
ondragover
ondragover:
null
| (this
,ev
) =>any
Fires on the target element continuously while the user drags the object over a valid drop target.
Param
The event.
Inherited from
LitElement.ondragover
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9139
ondragstart
ondragstart:
null
| (this
,ev
) =>any
Fires on the source object when the user starts to drag a text selection or selected object.
Param
The event.
Inherited from
LitElement.ondragstart
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9146
ondrop
ondrop:
null
| (this
,ev
) =>any
Inherited from
LitElement.ondrop
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9148
ondurationchange
ondurationchange:
null
| (this
,ev
) =>any
Occurs when the duration attribute is updated.
Param
The event.
Inherited from
LitElement.ondurationchange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9155
onemptied
onemptied:
null
| (this
,ev
) =>any
Occurs when the media element is reset to its initial state.
Param
The event.
Inherited from
LitElement.onemptied
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9162
onended
onended:
null
| (this
,ev
) =>any
Occurs when the end of playback is reached.
Param
The event
Inherited from
LitElement.onended
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9169
onerror
onerror:
OnErrorEventHandler
Fires when an error occurs during object loading.
Param
The event.
Inherited from
LitElement.onerror
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9176
onfocus
onfocus:
null
| (this
,ev
) =>any
Fires when the object receives focus.
Param
The event.
Inherited from
LitElement.onfocus
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9183
onformdata
onformdata:
null
| (this
,ev
) =>any
Inherited from
LitElement.onformdata
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9185
onfullscreenchange
onfullscreenchange:
null
| (this
,ev
) =>any
Implementation of
Inherited from
LitElement.onfullscreenchange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7729
onfullscreenerror
onfullscreenerror:
null
| (this
,ev
) =>any
Implementation of
Inherited from
LitElement.onfullscreenerror
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7731
ongotpointercapture
ongotpointercapture:
null
| (this
,ev
) =>any
Inherited from
LitElement.ongotpointercapture
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9187
oninput
oninput:
null
| (this
,ev
) =>any
Inherited from
LitElement.oninput
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9189
oninvalid
oninvalid:
null
| (this
,ev
) =>any
Inherited from
LitElement.oninvalid
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9191
onkeydown
onkeydown:
null
| (this
,ev
) =>any
Fires when the user presses a key.
Param
The keyboard event
Inherited from
LitElement.onkeydown
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9198
onkeypress
onkeypress:
null
| (this
,ev
) =>any
Fires when the user presses an alphanumeric key.
Param
The event.
Deprecated
Inherited from
LitElement.onkeypress
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9206
onkeyup
onkeyup:
null
| (this
,ev
) =>any
Fires when the user releases a key.
Param
The keyboard event
Inherited from
LitElement.onkeyup
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9213
onload
onload:
null
| (this
,ev
) =>any
Fires immediately after the browser loads the object.
Param
The event.
Inherited from
LitElement.onload
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9220
onloadeddata
onloadeddata:
null
| (this
,ev
) =>any
Occurs when media data is loaded at the current playback position.
Param
The event.
Inherited from
LitElement.onloadeddata
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9227
onloadedmetadata
onloadedmetadata:
null
| (this
,ev
) =>any
Occurs when the duration and dimensions of the media have been determined.
Param
The event.
Inherited from
LitElement.onloadedmetadata
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9234
onloadstart
onloadstart:
null
| (this
,ev
) =>any
Occurs when Internet Explorer begins looking for media data.
Param
The event.
Inherited from
LitElement.onloadstart
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9241
onlostpointercapture
onlostpointercapture:
null
| (this
,ev
) =>any
Inherited from
LitElement.onlostpointercapture
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9243
onmousedown
onmousedown:
null
| (this
,ev
) =>any
Fires when the user clicks the object with either mouse button.
Param
The mouse event.
Inherited from
LitElement.onmousedown
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9250
onmouseenter
onmouseenter:
null
| (this
,ev
) =>any
Inherited from
LitElement.onmouseenter
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9252
onmouseleave
onmouseleave:
null
| (this
,ev
) =>any
Inherited from
LitElement.onmouseleave
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9254
onmousemove
onmousemove:
null
| (this
,ev
) =>any
Fires when the user moves the mouse over the object.
Param
The mouse event.
Inherited from
LitElement.onmousemove
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9261
onmouseout
onmouseout:
null
| (this
,ev
) =>any
Fires when the user moves the mouse pointer outside the boundaries of the object.
Param
The mouse event.
Inherited from
LitElement.onmouseout
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9268
onmouseover
onmouseover:
null
| (this
,ev
) =>any
Fires when the user moves the mouse pointer into the object.
Param
The mouse event.
Inherited from
LitElement.onmouseover
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9275
onmouseup
onmouseup:
null
| (this
,ev
) =>any
Fires when the user releases a mouse button while the mouse is over the object.
Param
The mouse event.
Inherited from
LitElement.onmouseup
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9282
onpaste
onpaste:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpaste
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9284
onpause
onpause:
null
| (this
,ev
) =>any
Occurs when playback is paused.
Param
The event.
Inherited from
LitElement.onpause
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9291
onplay
onplay:
null
| (this
,ev
) =>any
Occurs when the play method is requested.
Param
The event.
Inherited from
LitElement.onplay
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9298
onplaying
onplaying:
null
| (this
,ev
) =>any
Occurs when the audio or video has started playing.
Param
The event.
Inherited from
LitElement.onplaying
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9305
onpointercancel
onpointercancel:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointercancel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9307
onpointerdown
onpointerdown:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointerdown
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9309
onpointerenter
onpointerenter:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointerenter
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9311
onpointerleave
onpointerleave:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointerleave
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9313
onpointermove
onpointermove:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointermove
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9315
onpointerout
onpointerout:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointerout
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9317
onpointerover
onpointerover:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointerover
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9319
onpointerup
onpointerup:
null
| (this
,ev
) =>any
Inherited from
LitElement.onpointerup
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9321
onprogress
onprogress:
null
| (this
,ev
) =>any
Occurs to indicate progress while downloading media data.
Param
The event.
Inherited from
LitElement.onprogress
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9328
onratechange
onratechange:
null
| (this
,ev
) =>any
Occurs when the playback rate is increased or decreased.
Param
The event.
Inherited from
LitElement.onratechange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9335
onreset
onreset:
null
| (this
,ev
) =>any
Fires when the user resets a form.
Param
The event.
Inherited from
LitElement.onreset
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9342
onresize
onresize:
null
| (this
,ev
) =>any
Inherited from
LitElement.onresize
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9344
onscroll
onscroll:
null
| (this
,ev
) =>any
Fires when the user repositions the scroll box in the scroll bar on the object.
Param
The event.
Inherited from
LitElement.onscroll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9351
onscrollend
onscrollend:
null
| (this
,ev
) =>any
Inherited from
LitElement.onscrollend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9353
onsecuritypolicyviolation
onsecuritypolicyviolation:
null
| (this
,ev
) =>any
Inherited from
LitElement.onsecuritypolicyviolation
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9355
onseeked
onseeked:
null
| (this
,ev
) =>any
Occurs when the seek operation ends.
Param
The event.
Inherited from
LitElement.onseeked
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9362
onseeking
onseeking:
null
| (this
,ev
) =>any
Occurs when the current playback position is moved.
Param
The event.
Inherited from
LitElement.onseeking
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9369
onselect
onselect:
null
| (this
,ev
) =>any
Fires when the current selection changes.
Param
The event.
Inherited from
LitElement.onselect
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9376
onselectionchange
onselectionchange:
null
| (this
,ev
) =>any
Inherited from
LitElement.onselectionchange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9378
onselectstart
onselectstart:
null
| (this
,ev
) =>any
Inherited from
LitElement.onselectstart
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9380
onslotchange
onslotchange:
null
| (this
,ev
) =>any
Inherited from
LitElement.onslotchange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9382
onstalled
onstalled:
null
| (this
,ev
) =>any
Occurs when the download has stopped.
Param
The event.
Inherited from
LitElement.onstalled
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9389
onsubmit
onsubmit:
null
| (this
,ev
) =>any
Inherited from
LitElement.onsubmit
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9391
onsuspend
onsuspend:
null
| (this
,ev
) =>any
Occurs if the load operation has been intentionally halted.
Param
The event.
Inherited from
LitElement.onsuspend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9398
ontimeupdate
ontimeupdate:
null
| (this
,ev
) =>any
Occurs to indicate the current playback position.
Param
The event.
Inherited from
LitElement.ontimeupdate
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9405
ontoggle
ontoggle:
null
| (this
,ev
) =>any
Inherited from
LitElement.ontoggle
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9407
ontouchcancel?
optional
ontouchcancel:null
| (this
,ev
) =>any
Inherited from
LitElement.ontouchcancel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9409
ontouchend?
optional
ontouchend:null
| (this
,ev
) =>any
Inherited from
LitElement.ontouchend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9411
ontouchmove?
optional
ontouchmove:null
| (this
,ev
) =>any
Inherited from
LitElement.ontouchmove
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9413
ontouchstart?
optional
ontouchstart:null
| (this
,ev
) =>any
Inherited from
LitElement.ontouchstart
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9415
ontransitioncancel
ontransitioncancel:
null
| (this
,ev
) =>any
Inherited from
LitElement.ontransitioncancel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9417
ontransitionend
ontransitionend:
null
| (this
,ev
) =>any
Inherited from
LitElement.ontransitionend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9419
ontransitionrun
ontransitionrun:
null
| (this
,ev
) =>any
Inherited from
LitElement.ontransitionrun
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9421
ontransitionstart
ontransitionstart:
null
| (this
,ev
) =>any
Inherited from
LitElement.ontransitionstart
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9423
onvolumechange
onvolumechange:
null
| (this
,ev
) =>any
Occurs when the volume is changed, or playback is muted or unmuted.
Param
The event.
Inherited from
LitElement.onvolumechange
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9430
onwaiting
onwaiting:
null
| (this
,ev
) =>any
Occurs when playback stops because the next frame of a video resource is not available.
Param
The event.
Inherited from
LitElement.onwaiting
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9437
onwebkitanimationend
onwebkitanimationend:
null
| (this
,ev
) =>any
Deprecated
This is a legacy alias of onanimationend
.
Inherited from
LitElement.onwebkitanimationend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9443
onwebkitanimationiteration
onwebkitanimationiteration:
null
| (this
,ev
) =>any
Deprecated
This is a legacy alias of onanimationiteration
.
Inherited from
LitElement.onwebkitanimationiteration
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9449
onwebkitanimationstart
onwebkitanimationstart:
null
| (this
,ev
) =>any
Deprecated
This is a legacy alias of onanimationstart
.
Inherited from
LitElement.onwebkitanimationstart
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9455
onwebkittransitionend
onwebkittransitionend:
null
| (this
,ev
) =>any
Deprecated
This is a legacy alias of ontransitionend
.
Inherited from
LitElement.onwebkittransitionend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9461
onwheel
onwheel:
null
| (this
,ev
) =>any
Inherited from
LitElement.onwheel
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:9463
outerHTML
outerHTML:
string
Implementation of
Inherited from
LitElement.outerHTML
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7733
outerText
outerText:
string
Inherited from
LitElement.outerText
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10064
ownerDocument
readonly
ownerDocument:Document
Returns the node document. Returns null for documents.
Implementation of
Inherited from
LitElement.ownerDocument
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7734
parentElement
readonly
parentElement:null
|HTMLElement
Returns the parent element.
Implementation of
Inherited from
LitElement.parentElement
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15888
parentNode
readonly
parentNode:null
|ParentNode
Returns the parent.
Implementation of
Inherited from
LitElement.parentNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15894
part
readonly
part:DOMTokenList
Implementation of
Inherited from
LitElement.part
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7736
popover
popover:
null
|string
Inherited from
LitElement.popover
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10066
postfx
postfx:
boolean
=false
Apply post processing effects
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:145
prefix
readonly
prefix:null
|string
Returns the namespace prefix.
Implementation of
Inherited from
LitElement.prefix
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7742
previousElementSibling
readonly
previousElementSibling:null
|Element
Returns the first preceding sibling that is an element, and null otherwise.
Implementation of
ROSHost
.previousElementSibling
Inherited from
LitElement.previousElementSibling
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16118
previousSibling
readonly
previousSibling:null
|ChildNode
Returns the previous sibling.
Implementation of
Inherited from
LitElement.previousSibling
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15900
PROCESSING_INSTRUCTION_NODE
readonly
PROCESSING_INSTRUCTION_NODE:7
node is a ProcessingInstruction node.
Implementation of
ROSHost
.PROCESSING_INSTRUCTION_NODE
Inherited from
LitElement.PROCESSING_INSTRUCTION_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15971
refreshHint
refreshHint:
eRefreshHint
=eRefreshHint.ON_FRAME
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:170
renderer?
optional
renderer:WebGPURenderer
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:163
rendererReady?
optional
rendererReady:Promise
<RendererInterface
>
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:162
role
role:
null
|string
Implementation of
Inherited from
LitElement.role
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2307
scene
scene:
Scene
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:158
scrollHeight
readonly
scrollHeight:number
Implementation of
Inherited from
LitElement.scrollHeight
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7744
scrollLeft
scrollLeft:
number
Implementation of
Inherited from
LitElement.scrollLeft
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7746
scrollTop
scrollTop:
number
Implementation of
Inherited from
LitElement.scrollTop
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7748
scrollWidth
readonly
scrollWidth:number
Implementation of
Inherited from
LitElement.scrollWidth
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7750
shadowRoot
readonly
shadowRoot:null
|ShadowRoot
Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Implementation of
Inherited from
LitElement.shadowRoot
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7756
skybox
skybox:
boolean
=false
Show a 360˚ skybox when an environment is loaded using .
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:136
slot
slot:
string
Returns the value of element's slot content attribute. Can be set to change it.
Implementation of
Inherited from
LitElement.slot
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7762
spellcheck
spellcheck:
boolean
Inherited from
LitElement.spellcheck
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10068
style
readonly
style:CSSStyleDeclaration
Inherited from
LitElement.style
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7952
tabIndex
tabIndex:
number
Inherited from
LitElement.tabIndex
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:11851
tagName
readonly
tagName:string
Returns the HTML-uppercased qualified name.
Implementation of
Inherited from
LitElement.tagName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7768
TEXT_NODE
readonly
TEXT_NODE:3
node is a Text node.
Implementation of
Inherited from
LitElement.TEXT_NODE
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15965
textContent
textContent:
null
|string
Implementation of
Inherited from
LitElement.textContent
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15902
title
title:
string
Inherited from
LitElement.title
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10070
translate
translate:
boolean
Inherited from
LitElement.translate
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10072
_$litElement$
static
_$litElement$:boolean
Inherited from
LitElement._$litElement$
Defined in
node_modules/.pnpm/lit-element@4.0.4/node_modules/lit-element/development/lit-element.d.ts:84
_initializers?
static
optional
_initializers:Initializer
[]
Inherited from
LitElement._initializers
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:258
[metadata]
static
[metadata]:object
&Record
<PropertyKey
,unknown
>
Inherited from
LitElement.[metadata]
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:417
finalized
protected
static
finalized:undefined
|true
Marks class as having been finalized, which includes creating properties from static properties
, but does not include all properties created from decorators.
Nocollapse
Inherited from
LitElement.finalized
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:272
camera
get
camera():Camera
Returns
Implementation of
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:202
debugInfo
get
debugInfo():DebugInfo
Returns
Implementation of
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:665
frameMs
get
frameMs():number
Returns
number
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:268
models
get
models():object
Returns
object
add()
add: (
node
,sourceModel
,url
) =>void
Parameters
• node: Node
• sourceModel: unknown
• url: string
Returns
void
remove()
remove: (
node
) =>void
Parameters
• node: Node
Returns
void
Implementation of
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:691
plugins
get
plugins():ROSPlugin
[]
Returns
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:315
transparentBackground
get
transparentBackground():boolean
Returns
boolean
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:216
addEventListener()
addEventListener(type, listener, options)
addEventListener<
K
>(type
,listener
,options
?):void
Type Parameters
• K extends keyof HTMLElementEventMap
Parameters
• type: K
• listener
• options?: boolean
| AddEventListenerOptions
Returns
void
Implementation of
Inherited from
LitElement.addEventListener
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10083
addEventListener(type, listener, options)
addEventListener(
type
,listener
,options
?):void
Parameters
• type: string
• listener: EventListenerOrEventListenerObject
• options?: boolean
| AddEventListenerOptions
Returns
void
Implementation of
ROSHost.addEventListener
Inherited from
LitElement.addEventListener
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10084
after()
after(...
nodes
):void
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string
| Node
)[]
Returns
void
Implementation of
Inherited from
LitElement.after
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:5712
afterFrame()
afterFrame(
elapsedTime
):void
Parameters
• elapsedTime: number
Returns
void
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:531
animate()
animate(
keyframes
,options
?):Animation
Parameters
• keyframes: null
| Keyframe
[] | PropertyIndexedKeyframes
• options?: number
| KeyframeAnimationOptions
Returns
Animation
Implementation of
Inherited from
LitElement.animate
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2459
append()
append(...
nodes
):void
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string
| Node
)[]
Returns
void
Implementation of
Inherited from
LitElement.append
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16551
appendChild()
appendChild<
T
>(node
):T
Type Parameters
• T extends Node
Parameters
• node: T
Returns
T
Implementation of
Inherited from
LitElement.appendChild
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15904
attachInternals()
attachInternals():
ElementInternals
Returns
ElementInternals
Inherited from
LitElement.attachInternals
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10074
attachShadow()
attachShadow(
init
):ShadowRoot
Creates a shadow root for element and returns it.
Parameters
• init: ShadowRootInit
Returns
ShadowRoot
Implementation of
Inherited from
LitElement.attachShadow
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7774
before()
before(...
nodes
):void
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string
| Node
)[]
Returns
void
Implementation of
Inherited from
LitElement.before
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:5720
beforeFrame()
beforeFrame(
elapsedTime
):void
Parameters
• elapsedTime: number
Returns
void
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:501
blur()
blur():
void
Returns
void
Inherited from
LitElement.blur
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:11853
checkVisibility()
checkVisibility(
options
?):boolean
Parameters
• options?: CheckVisibilityOptions
Returns
boolean
Implementation of
Inherited from
LitElement.checkVisibility
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7776
click()
click():
void
Returns
void
Inherited from
LitElement.click
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10076
cloneNode()
cloneNode(
deep
?):Node
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Parameters
• deep?: boolean
Returns
Node
Implementation of
Inherited from
LitElement.cloneNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15910
closest()
closest(selector)
closest<
K
>(selector
):null
|HTMLElementTagNameMap
[K
]
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Type Parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• selector: K
Returns
null
| HTMLElementTagNameMap
[K
]
Implementation of
Inherited from
LitElement.closest
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7782
closest(selector)
closest<
K
>(selector
):null
|SVGElementTagNameMap
[K
]
Type Parameters
• K extends keyof SVGElementTagNameMap
Parameters
• selector: K
Returns
null
| SVGElementTagNameMap
[K
]
Implementation of
Inherited from
LitElement.closest
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7783
closest(selector)
closest<
K
>(selector
):null
|MathMLElementTagNameMap
[K
]
Type Parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• selector: K
Returns
null
| MathMLElementTagNameMap
[K
]
Implementation of
Inherited from
LitElement.closest
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7784
closest(selectors)
closest<
E
>(selectors
):null
|E
Type Parameters
• E extends Element
= Element
Parameters
• selectors: string
Returns
null
| E
Implementation of
Inherited from
LitElement.closest
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7785
compareDocumentPosition()
compareDocumentPosition(
other
):number
Returns a bitmask indicating the position of other relative to node.
Parameters
• other: Node
Returns
number
Implementation of
ROSHost
.compareDocumentPosition
Inherited from
LitElement.compareDocumentPosition
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15916
computedStyleMap()
computedStyleMap():
StylePropertyMapReadOnly
Returns
StylePropertyMapReadOnly
Implementation of
Inherited from
LitElement.computedStyleMap
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7787
contains()
contains(
other
):boolean
Returns true if other is an inclusive descendant of node, and false otherwise.
Parameters
• other: null
| Node
Returns
boolean
Implementation of
Inherited from
LitElement.contains
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15922
createMarkerNode()
createMarkerNode(
node
):Node
Parameters
• node: Node
Returns
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:279
dispatchEvent()
dispatchEvent(
event
):boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
• event: Event
Returns
boolean
Implementation of
Inherited from
LitElement.dispatchEvent
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:8309
focus()
focus(
options
?):void
Parameters
• options?: FocusOptions
Returns
void
Inherited from
LitElement.focus
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:11855
getAnimations()
getAnimations(
options
?):Animation
[]
Parameters
• options?: GetAnimationsOptions
Returns
Animation
[]
Implementation of
Inherited from
LitElement.getAnimations
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:2461
getAttribute()
getAttribute(
qualifiedName
):null
|string
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.
Parameters
• qualifiedName: string
Returns
null
| string
Implementation of
Inherited from
LitElement.getAttribute
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7793
getAttributeNames()
getAttributeNames():
string
[]
Returns the qualified names of all element's attributes. Can contain duplicates.
Returns
string
[]
Implementation of
Inherited from
LitElement.getAttributeNames
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7805
getAttributeNode()
getAttributeNode(
qualifiedName
):null
|Attr
Parameters
• qualifiedName: string
Returns
null
| Attr
Implementation of
Inherited from
LitElement.getAttributeNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7807
getAttributeNodeNS()
getAttributeNodeNS(
namespace
,localName
):null
|Attr
Parameters
• namespace: null
| string
• localName: string
Returns
null
| Attr
Implementation of
Inherited from
LitElement.getAttributeNodeNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7809
getAttributeNS()
getAttributeNS(
namespace
,localName
):null
|string
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.
Parameters
• namespace: null
| string
• localName: string
Returns
null
| string
Implementation of
Inherited from
LitElement.getAttributeNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7799
getBoundingClientRect()
getBoundingClientRect():
DOMRect
Returns
DOMRect
Implementation of
Inherited from
LitElement.getBoundingClientRect
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7811
getClientRects()
getClientRects():
DOMRectList
Returns
DOMRectList
Implementation of
Inherited from
LitElement.getClientRects
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7813
getElementsByClassName()
getElementsByClassName(
classNames
):HTMLCollectionOf
<Element
>
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.
Parameters
• classNames: string
Returns
HTMLCollectionOf
<Element
>
Implementation of
ROSHost
.getElementsByClassName
Inherited from
LitElement.getElementsByClassName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7819
getElementsByTagName()
getElementsByTagName(qualifiedName)
getElementsByTagName<
K
>(qualifiedName
):HTMLCollectionOf
<HTMLElementTagNameMap
[K
]>
Type Parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf
<HTMLElementTagNameMap
[K
]>
Implementation of
Inherited from
LitElement.getElementsByTagName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7821
getElementsByTagName(qualifiedName)
getElementsByTagName<
K
>(qualifiedName
):HTMLCollectionOf
<SVGElementTagNameMap
[K
]>
Type Parameters
• K extends keyof SVGElementTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf
<SVGElementTagNameMap
[K
]>
Implementation of
Inherited from
LitElement.getElementsByTagName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7822
getElementsByTagName(qualifiedName)
getElementsByTagName<
K
>(qualifiedName
):HTMLCollectionOf
<MathMLElementTagNameMap
[K
]>
Type Parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf
<MathMLElementTagNameMap
[K
]>
Implementation of
Inherited from
LitElement.getElementsByTagName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7823
getElementsByTagName(qualifiedName)
getElementsByTagName<
K
>(qualifiedName
):HTMLCollectionOf
<HTMLElementDeprecatedTagNameMap
[K
]>
Type Parameters
• K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf
<HTMLElementDeprecatedTagNameMap
[K
]>
Deprecated
Implementation of
Inherited from
LitElement.getElementsByTagName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7825
getElementsByTagName(qualifiedName)
getElementsByTagName(
qualifiedName
):HTMLCollectionOf
<Element
>
Parameters
• qualifiedName: string
Returns
HTMLCollectionOf
<Element
>
Implementation of
Inherited from
LitElement.getElementsByTagName
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7826
getElementsByTagNameNS()
getElementsByTagNameNS(namespaceURI, localName)
getElementsByTagNameNS(
namespaceURI
,localName
):HTMLCollectionOf
<HTMLElement
>
Parameters
• namespaceURI: "http://www.w3.org/1999/xhtml"
• localName: string
Returns
HTMLCollectionOf
<HTMLElement
>
Implementation of
ROSHost
.getElementsByTagNameNS
Inherited from
LitElement.getElementsByTagNameNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7828
getElementsByTagNameNS(namespaceURI, localName)
getElementsByTagNameNS(
namespaceURI
,localName
):HTMLCollectionOf
<SVGElement
>
Parameters
• namespaceURI: "http://www.w3.org/2000/svg"
• localName: string
Returns
HTMLCollectionOf
<SVGElement
>
Implementation of
ROSHost
.getElementsByTagNameNS
Inherited from
LitElement.getElementsByTagNameNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7829
getElementsByTagNameNS(namespaceURI, localName)
getElementsByTagNameNS(
namespaceURI
,localName
):HTMLCollectionOf
<MathMLElement
>
Parameters
• namespaceURI: "http://www.w3.org/1998/Math/MathML"
• localName: string
Returns
HTMLCollectionOf
<MathMLElement
>
Implementation of
ROSHost
.getElementsByTagNameNS
Inherited from
LitElement.getElementsByTagNameNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7830
getElementsByTagNameNS(namespace, localName)
getElementsByTagNameNS(
namespace
,localName
):HTMLCollectionOf
<Element
>
Parameters
• namespace: null
| string
• localName: string
Returns
HTMLCollectionOf
<Element
>
Implementation of
ROSHost
.getElementsByTagNameNS
Inherited from
LitElement.getElementsByTagNameNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7831
getHTML()
getHTML(
options
?):string
Parameters
• options?: GetHTMLOptions
Returns
string
Implementation of
Inherited from
LitElement.getHTML
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7833
getRootNode()
getRootNode(
options
?):Node
Returns node's root.
Parameters
• options?: GetRootNodeOptions
Returns
Node
Implementation of
Inherited from
LitElement.getRootNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15928
hasAttribute()
hasAttribute(
qualifiedName
):boolean
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Parameters
• qualifiedName: string
Returns
boolean
Implementation of
Inherited from
LitElement.hasAttribute
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7839
hasAttributeNS()
hasAttributeNS(
namespace
,localName
):boolean
Returns true if element has an attribute whose namespace is namespace and local name is localName.
Parameters
• namespace: null
| string
• localName: string
Returns
boolean
Implementation of
Inherited from
LitElement.hasAttributeNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7845
hasAttributes()
hasAttributes():
boolean
Returns true if element has attributes, and false otherwise.
Returns
boolean
Implementation of
Inherited from
LitElement.hasAttributes
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7851
hasChildNodes()
hasChildNodes():
boolean
Returns whether node has children.
Returns
boolean
Implementation of
Inherited from
LitElement.hasChildNodes
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15934
hasPointerCapture()
hasPointerCapture(
pointerId
):boolean
Parameters
• pointerId: number
Returns
boolean
Implementation of
Inherited from
LitElement.hasPointerCapture
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7853
hidePopover()
hidePopover():
void
Returns
void
Inherited from
LitElement.hidePopover
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10078
insertAdjacentElement()
insertAdjacentElement(
where
,element
):null
|Element
Parameters
• where: InsertPosition
• element: Element
Returns
null
| Element
Implementation of
Inherited from
LitElement.insertAdjacentElement
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7855
insertAdjacentHTML()
insertAdjacentHTML(
position
,string
):void
Parameters
• position: InsertPosition
• string: string
Returns
void
Implementation of
Inherited from
LitElement.insertAdjacentHTML
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7857
insertAdjacentText()
insertAdjacentText(
where
,data
):void
Parameters
• where: InsertPosition
• data: string
Returns
void
Implementation of
Inherited from
LitElement.insertAdjacentText
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7859
insertBefore()
insertBefore<
T
>(node
,child
):T
Type Parameters
• T extends Node
Parameters
• node: T
• child: null
| Node
Returns
T
Implementation of
Inherited from
LitElement.insertBefore
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15936
isDefaultNamespace()
isDefaultNamespace(
namespace
):boolean
Parameters
• namespace: null
| string
Returns
boolean
Implementation of
Inherited from
LitElement.isDefaultNamespace
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15938
isEqualNode()
isEqualNode(
otherNode
):boolean
Returns whether node and otherNode have the same properties.
Parameters
• otherNode: null
| Node
Returns
boolean
Implementation of
Inherited from
LitElement.isEqualNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15944
isSameNode()
isSameNode(
otherNode
):boolean
Parameters
• otherNode: null
| Node
Returns
boolean
Implementation of
Inherited from
LitElement.isSameNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15946
loadEnvironment()
loadEnvironment(
path
,format
?):Promise
<void
>
Parameters
• path: string
• format?: string
Returns
Promise
<void
>
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:471
lookupNamespaceURI()
lookupNamespaceURI(
prefix
):null
|string
Parameters
• prefix: null
| string
Returns
null
| string
Implementation of
Inherited from
LitElement.lookupNamespaceURI
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15948
lookupPrefix()
lookupPrefix(
namespace
):null
|string
Parameters
• namespace: null
| string
Returns
null
| string
Implementation of
Inherited from
LitElement.lookupPrefix
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15950
matches()
matches(
selectors
):boolean
Returns true if matching selectors against element's root yields element, and false otherwise.
Parameters
• selectors: string
Returns
boolean
Implementation of
Inherited from
LitElement.matches
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7865
normalize()
normalize():
void
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Returns
void
Implementation of
Inherited from
LitElement.normalize
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15956
prepend()
prepend(...
nodes
):void
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string
| Node
)[]
Returns
void
Implementation of
Inherited from
LitElement.prepend
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16559
project()
project(
vec
,viewport
):vec3
Parameters
• vec: vec3
• viewport: vec4
Returns
vec3
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:206
querySelector()
querySelector(selectors)
querySelector<
K
>(selectors
):null
|HTMLElementTagNameMap
[K
]
Returns the first element that is a descendant of node that matches selectors.
Type Parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• selectors: K
Returns
null
| HTMLElementTagNameMap
[K
]
Implementation of
Inherited from
LitElement.querySelector
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16565
querySelector(selectors)
querySelector<
K
>(selectors
):null
|SVGElementTagNameMap
[K
]
Type Parameters
• K extends keyof SVGElementTagNameMap
Parameters
• selectors: K
Returns
null
| SVGElementTagNameMap
[K
]
Implementation of
Inherited from
LitElement.querySelector
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16566
querySelector(selectors)
querySelector<
K
>(selectors
):null
|MathMLElementTagNameMap
[K
]
Type Parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• selectors: K
Returns
null
| MathMLElementTagNameMap
[K
]
Implementation of
Inherited from
LitElement.querySelector
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16567
querySelector(selectors)
querySelector<
K
>(selectors
):null
|HTMLElementDeprecatedTagNameMap
[K
]
Type Parameters
• K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
• selectors: K
Returns
null
| HTMLElementDeprecatedTagNameMap
[K
]
Deprecated
Implementation of
Inherited from
LitElement.querySelector
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16569
querySelector(selectors)
querySelector<
E
>(selectors
):null
|E
Type Parameters
• E extends Element
= Element
Parameters
• selectors: string
Returns
null
| E
Implementation of
Inherited from
LitElement.querySelector
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16570
querySelectorAll()
querySelectorAll(selectors)
querySelectorAll<
K
>(selectors
):NodeListOf
<HTMLElementTagNameMap
[K
]>
Returns all element descendants of node that match selectors.
Type Parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• selectors: K
Returns
NodeListOf
<HTMLElementTagNameMap
[K
]>
Implementation of
Inherited from
LitElement.querySelectorAll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16576
querySelectorAll(selectors)
querySelectorAll<
K
>(selectors
):NodeListOf
<SVGElementTagNameMap
[K
]>
Type Parameters
• K extends keyof SVGElementTagNameMap
Parameters
• selectors: K
Returns
NodeListOf
<SVGElementTagNameMap
[K
]>
Implementation of
Inherited from
LitElement.querySelectorAll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16577
querySelectorAll(selectors)
querySelectorAll<
K
>(selectors
):NodeListOf
<MathMLElementTagNameMap
[K
]>
Type Parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• selectors: K
Returns
NodeListOf
<MathMLElementTagNameMap
[K
]>
Implementation of
Inherited from
LitElement.querySelectorAll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16578
querySelectorAll(selectors)
querySelectorAll<
K
>(selectors
):NodeListOf
<HTMLElementDeprecatedTagNameMap
[K
]>
Type Parameters
• K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
• selectors: K
Returns
NodeListOf
<HTMLElementDeprecatedTagNameMap
[K
]>
Deprecated
Implementation of
Inherited from
LitElement.querySelectorAll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16580
querySelectorAll(selectors)
querySelectorAll<
E
>(selectors
):NodeListOf
<E
>
Type Parameters
• E extends Element
= Element
Parameters
• selectors: string
Returns
NodeListOf
<E
>
Implementation of
Inherited from
LitElement.querySelectorAll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16581
releasePointerCapture()
releasePointerCapture(
pointerId
):void
Parameters
• pointerId: number
Returns
void
Implementation of
Inherited from
LitElement.releasePointerCapture
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7867
remove()
remove():
void
Removes node.
Returns
void
Implementation of
Inherited from
LitElement.remove
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:5726
removeAttribute()
removeAttribute(
qualifiedName
):void
Removes element's first attribute whose qualified name is qualifiedName.
Parameters
• qualifiedName: string
Returns
void
Implementation of
Inherited from
LitElement.removeAttribute
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7873
removeAttributeNode()
removeAttributeNode(
attr
):Attr
Parameters
• attr: Attr
Returns
Attr
Implementation of
Inherited from
LitElement.removeAttributeNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7881
removeAttributeNS()
removeAttributeNS(
namespace
,localName
):void
Removes element's attribute whose namespace is namespace and local name is localName.
Parameters
• namespace: null
| string
• localName: string
Returns
void
Implementation of
Inherited from
LitElement.removeAttributeNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7879
removeChild()
removeChild<
T
>(child
):T
Type Parameters
• T extends Node
Parameters
• child: T
Returns
T
Implementation of
Inherited from
LitElement.removeChild
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15958
removeEventListener()
removeEventListener(type, listener, options)
removeEventListener<
K
>(type
,listener
,options
?):void
Removes the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
• K extends keyof HTMLElementEventMap
Parameters
• type: K
• listener
• options?: boolean
| EventListenerOptions
Returns
void
Implementation of
Inherited from
LitElement.removeEventListener
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10085
removeEventListener(type, listener, options)
removeEventListener(
type
,listener
,options
?):void
Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
• type: string
• listener: EventListenerOrEventListenerObject
• options?: boolean
| EventListenerOptions
Returns
void
Implementation of
Inherited from
LitElement.removeEventListener
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10086
replaceChild()
replaceChild<
T
>(node
,child
):T
Type Parameters
• T extends Node
Parameters
• node: Node
• child: T
Returns
T
Implementation of
Inherited from
LitElement.replaceChild
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:15960
replaceChildren()
replaceChildren(...
nodes
):void
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string
| Node
)[]
Returns
void
Implementation of
Inherited from
LitElement.replaceChildren
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:16589
replaceWith()
replaceWith(...
nodes
):void
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string
| Node
)[]
Returns
void
Implementation of
Inherited from
LitElement.replaceWith
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:5734
requestFullscreen()
requestFullscreen(
options
?):Promise
<void
>
Displays element fullscreen and resolves promise when done.
When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.
Parameters
• options?: FullscreenOptions
Returns
Promise
<void
>
Implementation of
Inherited from
LitElement.requestFullscreen
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7889
requestPointerLock()
requestPointerLock(
options
?):Promise
<void
>
Parameters
• options?: PointerLockOptions
Returns
Promise
<void
>
Implementation of
Inherited from
LitElement.requestPointerLock
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7891
scroll()
scroll(options)
scroll(
options
?):void
Parameters
• options?: ScrollToOptions
Returns
void
Implementation of
Inherited from
LitElement.scroll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7893
scroll(x, y)
scroll(
x
,y
):void
Parameters
• x: number
• y: number
Returns
void
Implementation of
Inherited from
LitElement.scroll
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7894
scrollBy()
scrollBy(options)
scrollBy(
options
?):void
Parameters
• options?: ScrollToOptions
Returns
void
Implementation of
Inherited from
LitElement.scrollBy
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7896
scrollBy(x, y)
scrollBy(
x
,y
):void
Parameters
• x: number
• y: number
Returns
void
Implementation of
Inherited from
LitElement.scrollBy
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7897
scrollIntoView()
scrollIntoView(
arg
?):void
Parameters
• arg?: boolean
| ScrollIntoViewOptions
Returns
void
Implementation of
Inherited from
LitElement.scrollIntoView
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7899
scrollTo()
scrollTo(options)
scrollTo(
options
?):void
Parameters
• options?: ScrollToOptions
Returns
void
Implementation of
Inherited from
LitElement.scrollTo
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7901
scrollTo(x, y)
scrollTo(
x
,y
):void
Parameters
• x: number
• y: number
Returns
void
Implementation of
Inherited from
LitElement.scrollTo
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7902
setAttribute()
setAttribute(
qualifiedName
,value
):void
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
Parameters
• qualifiedName: string
• value: string
Returns
void
Implementation of
Inherited from
LitElement.setAttribute
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7908
setAttributeNode()
setAttributeNode(
attr
):null
|Attr
Parameters
• attr: Attr
Returns
null
| Attr
Implementation of
Inherited from
LitElement.setAttributeNode
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7916
setAttributeNodeNS()
setAttributeNodeNS(
attr
):null
|Attr
Parameters
• attr: Attr
Returns
null
| Attr
Implementation of
Inherited from
LitElement.setAttributeNodeNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7918
setAttributeNS()
setAttributeNS(
namespace
,qualifiedName
,value
):void
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.
Parameters
• namespace: null
| string
• qualifiedName: string
• value: string
Returns
void
Implementation of
Inherited from
LitElement.setAttributeNS
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7914
setHTMLUnsafe()
setHTMLUnsafe(
html
):void
Parameters
• html: string
Returns
void
Implementation of
Inherited from
LitElement.setHTMLUnsafe
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7920
setPointerCapture()
setPointerCapture(
pointerId
):void
Parameters
• pointerId: number
Returns
void
Implementation of
Inherited from
LitElement.setPointerCapture
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7922
showPopover()
showPopover():
void
Returns
void
Inherited from
LitElement.showPopover
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10080
toggleAttribute()
toggleAttribute(
qualifiedName
,force
?):boolean
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.
Returns true if qualifiedName is now present, and false otherwise.
Parameters
• qualifiedName: string
• force?: boolean
Returns
boolean
Implementation of
Inherited from
LitElement.toggleAttribute
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7930
togglePopover()
togglePopover(
force
?):boolean
Parameters
• force?: boolean
Returns
boolean
Inherited from
LitElement.togglePopover
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:10082
unproject()
unproject(
vec
,viewport
):vec3
Parameters
• vec: vec3
• viewport: vec4
Returns
vec3
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:211
webkitMatchesSelector()
webkitMatchesSelector(
selectors
):boolean
Parameters
• selectors: string
Returns
boolean
Deprecated
This is a legacy alias of matches
.
Implementation of
Inherited from
LitElement.webkitMatchesSelector
Defined in
node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/lib/lib.dom.d.ts:7936
addInitializer()
static
addInitializer(initializer
):void
Adds an initializer function to the class that is called during instance construction.
This is useful for code that runs against a ReactiveElement
subclass, such as a decorator, that needs to do work for each instance, such as setting up a ReactiveController
.
ts
const myDecorator = (target: typeof ReactiveElement, key: string) => {
target.addInitializer((instance: ReactiveElement) => {
// This is run during construction of the element
new MyController(instance);
});
}
Decorating a field will then cause each instance to run an initializer that adds a controller:
ts
class MyElement extends LitElement {
@myDecorator foo;
}
Initializers are stored per-constructor. Adding an initializer to a subclass does not add it to a superclass. Since initializers are run in constructors, initializers will run in order of the class hierarchy, starting with superclasses and progressing to the instance's class.
Parameters
• initializer: Initializer
Returns
void
Nocollapse
Inherited from
LitElement.addInitializer
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:257
finalize()
protected
static
finalize():void
Finishes setting up the class so that it's ready to be registered as a custom element and instantiated.
This method is called by the ReactiveElement.observedAttributes getter. If you override the observedAttributes getter, you must either call super.observedAttributes to trigger finalization, or call finalize() yourself.
Returns
void
Nocollapse
Inherited from
LitElement.finalize
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:441
attributes
observedAttributes
get
static
observedAttributes():string
[]
Returns a list of attributes corresponding to the registered properties.
Nocollapse
Returns
string
[]
Inherited from
LitElement.observedAttributes
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:346
attributeChangedCallback()
attributeChangedCallback(
name
,_old
,value
):void
Synchronizes property values when attributes change.
Specifically, when an attribute is set, the corresponding property is set. You should rarely need to implement this callback. If this method is overridden, super.attributeChangedCallback(name, _old, value)
must be called.
See using the lifecycle callbacks on MDN for more information about the attributeChangedCallback
.
Parameters
• name: string
• _old: null
| string
• value: null
| string
Returns
void
Inherited from
LitElement.attributeChangedCallback
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:580
controllers
addController()
addController(
controller
):void
Registers a ReactiveController
to participate in the element's reactive update cycle. The element automatically calls into any registered controllers during its lifecycle callbacks.
If the element is connected when addController()
is called, the controller's hostConnected()
callback will be immediately called.
Parameters
• controller: ReactiveController
Returns
void
Inherited from
LitElement.addController
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:519
removeController()
removeController(
controller
):void
Removes a ReactiveController
from the element.
Parameters
• controller: ReactiveController
Returns
void
Inherited from
LitElement.removeController
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:524
dev-mode
disableWarning()?
static
optional
disableWarning: (warningKind
) =>void
Disable the given warning category for this class.
This method only exists in development builds, so it should be accessed with a guard like:
ts
// Disable for all ReactiveElement subclasses
ReactiveElement.disableWarning?.('migration');
// Disable for only MyElement and subclasses
MyElement.disableWarning?.('migration');
Parameters
• warningKind: WarningKind
Returns
void
Nocollapse
Inherited from
LitElement.disableWarning
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:223
enabledWarnings?
static
optional
enabledWarnings:WarningKind
[]
Read or set all the enabled warning categories for this class.
This property is only used in development builds.
Nocollapse
Inherited from
LitElement.enabledWarnings
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:187
enableWarning()?
static
optional
enableWarning: (warningKind
) =>void
Enable the given warning category for this class.
This method only exists in development builds, so it should be accessed with a guard like:
ts
// Enable for all ReactiveElement subclasses
ReactiveElement.enableWarning?.('migration');
// Enable for only MyElement and subclasses
MyElement.enableWarning?.('migration');
Parameters
• warningKind: WarningKind
Returns
void
Nocollapse
Inherited from
LitElement.enableWarning
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:205
lifecycle
connectedCallback()
connectedCallback():
Promise
<void
>
Invoked when the component is added to the document's DOM.
In connectedCallback()
you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.
ts
connectedCallback() {
super.connectedCallback();
addEventListener('keydown', this._handleKeydown);
}
Typically, anything done in connectedCallback()
should be undone when the element is disconnected, in disconnectedCallback()
.
Returns
Promise
<void
>
Overrides
LitElement.connectedCallback
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:342
disconnectedCallback()
disconnectedCallback():
Promise
<void
>
Invoked when the component is removed from the document's DOM.
This callback is the main signal to the element that it may no longer be used. disconnectedCallback()
should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.
ts
disconnectedCallback() {
super.disconnectedCallback();
window.removeEventListener('keydown', this._handleKeydown);
}
An element may be re-connected after being disconnected.
Returns
Promise
<void
>
Overrides
LitElement.disconnectedCallback
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:458
properties
elementProperties
static
elementProperties:PropertyDeclarationMap
Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
LitElement.elementProperties
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:280
properties
static
properties:PropertyDeclarations
User-supplied object that maps property names to PropertyDeclaration
objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.
By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.
Generally, properties that are changed by the element should be private or protected fields and should use the state: true
option. Properties marked as state
do not reflect from the corresponding attribute
However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked
property when clicked and fires a changed
event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true
option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.
Nocollapse
Inherited from
LitElement.properties
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:306
createProperty()
static
createProperty(name
,options
?):void
Creates a property accessor on the element prototype if one does not exist and stores a PropertyDeclaration for the property with the given options. The property setter calls the property's hasChanged
property option or uses a strict identity check to determine whether or not to request an update.
This method may be overridden to customize properties; however, when doing so, it's important to call super.createProperty
to ensure the property is setup correctly. This method calls getPropertyDescriptor
internally to get a descriptor to install. To customize what properties do when they are get or set, override getPropertyDescriptor
. To customize the options for a property, implement createProperty
like this:
ts
static createProperty(name, options) {
options = Object.assign(options, {myOption: true});
super.createProperty(name, options);
}
Parameters
• name: PropertyKey
• options?: PropertyDeclaration
<unknown
, unknown
>
Returns
void
Nocollapse
Inherited from
LitElement.createProperty
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:373
getPropertyDescriptor()
protected
static
getPropertyDescriptor(name
,key
,options
):undefined
|PropertyDescriptor
Returns a property descriptor to be defined on the given named property. If no descriptor is returned, the property will not become an accessor. For example,
ts
class MyElement extends LitElement {
static getPropertyDescriptor(name, key, options) {
const defaultDescriptor =
super.getPropertyDescriptor(name, key, options);
const setter = defaultDescriptor.set;
return {
get: defaultDescriptor.get,
set(value) {
setter.call(this, value);
// custom action.
},
configurable: true,
enumerable: true
}
}
}
Parameters
• name: PropertyKey
• key: string
| symbol
• options: PropertyDeclaration
<unknown
, unknown
>
Returns
undefined
| PropertyDescriptor
Nocollapse
Inherited from
LitElement.getPropertyDescriptor
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:401
getPropertyOptions()
static
getPropertyOptions(name
):PropertyDeclaration
<unknown
,unknown
>
Returns the property options associated with the given property. These options are defined with a PropertyDeclaration
via the properties
object or the @property
decorator and are registered in createProperty(...)
.
Note, this method should be considered "final" and not overridden. To customize the options for a given property, override createProperty
.
Parameters
• name: PropertyKey
Returns
PropertyDeclaration
<unknown
, unknown
>
Nocollapse
Final
Inherited from
LitElement.getPropertyOptions
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:416
rendering
renderOptions
readonly
renderOptions:RenderOptions
Inherited from
LitElement.renderOptions
Defined in
node_modules/.pnpm/lit-element@4.0.4/node_modules/lit-element/development/lit-element.d.ts:88
renderRoot
readonly
renderRoot:HTMLElement
|DocumentFragment
Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.
Inherited from
LitElement.renderRoot
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:473
shadowRootOptions
static
shadowRootOptions:ShadowRootInit
Options used when calling attachShadow
. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}
.
Note, these options are used in createRenderRoot
. If this method is customized, options should be respected if possible.
Nocollapse
Inherited from
LitElement.shadowRootOptions
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:452
createRenderRoot()
protected
createRenderRoot():HTMLElement
|DocumentFragment
Returns
HTMLElement
| DocumentFragment
Inherited from
LitElement.createRenderRoot
Defined in
node_modules/.pnpm/lit-element@4.0.4/node_modules/lit-element/development/lit-element.d.ts:93
render()
render():
TemplateResult
<1
>
Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart
- typically a TemplateResult
. Setting properties inside this method will not trigger the element to update.
Returns
TemplateResult
<1
>
Overrides
LitElement.render
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:196
styles
elementStyles
static
elementStyles:CSSResultOrNative
[]
Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
LitElement.elementStyles
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:313
styles
static
styles:CSSResult
Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.
Note on Content Security Policy:
Element styles are implemented with <style>
tags when the browser doesn't support adopted StyleSheets. To use such <style>
tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value>
with <base64-value>
replaced be a server-generated nonce.
To provide a nonce to use on generated <style>
elements, set window.litNonce
to a server-generated nonce in your page's HTML, before loading application code:
html
<script>
// Generated and unique per request:
window.litNonce = 'a1b2c3d4';
</script>
Nocollapse
Overrides
LitElement.styles
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:184
finalizeStyles()
protected
static
finalizeStyles(styles
?):CSSResultOrNative
[]
Takes the styles the user supplied via the static styles
property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.
Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.
Parameters
• styles?: CSSResultGroup
Returns
CSSResultOrNative
[]
Nocollapse
Inherited from
LitElement.finalizeStyles
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:467
updates
hasUpdated
hasUpdated:
boolean
Is set to true
after the first update. The element code cannot assume that renderRoot
exists before the element hasUpdated
.
Inherited from
LitElement.hasUpdated
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:491
isUpdatePending
isUpdatePending:
boolean
True if there is a pending update as a result of calling requestUpdate()
. Should only be read.
Inherited from
LitElement.isUpdatePending
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:485
updateComplete
get
updateComplete():Promise
<boolean
>
Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true
if the element completed the update without triggering another update. The Promise result is false
if a property was set inside updated()
. If the Promise is rejected, an exception was thrown during the update.
To await additional asynchronous work, override the getUpdateComplete
method. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.getUpdateComplete()
, then any subsequent state.
Returns
Promise
<boolean
>
A promise of a boolean that resolves to true if the update completed without triggering another update.
Inherited from
LitElement.updateComplete
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:669
enableUpdating()
protected
enableUpdating(_requestedUpdate
):void
Note, this method should be considered final and not overridden. It is overridden on the element instance with a function that triggers the first update.
Parameters
• _requestedUpdate: boolean
Returns
void
Inherited from
LitElement.enableUpdating
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:560
firstUpdated()
firstUpdated():
void
Invoked when the element is first updated. Implement to perform one time work on the element after update.
ts
firstUpdated() {
this.renderRoot.getElementById('my-text-area').focus();
}
Setting properties inside this method will trigger the element to update again after this update cycle completes.
Returns
void
Overrides
LitElement.firstUpdated
Defined in
packages/charm/src/webComponents/ROSPlayer.ts:291
getUpdateComplete()
protected
getUpdateComplete():Promise
<boolean
>
Override point for the updateComplete
promise.
It is not safe to override the updateComplete
getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)
) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:
ts
class MyElement extends LitElement {
override async getUpdateComplete() {
const result = await super.getUpdateComplete();
await this._myChild.updateComplete;
return result;
}
}
Returns
Promise
<boolean
>
A promise of a boolean that resolves to true if the update completed without triggering another update.
Inherited from
LitElement.getUpdateComplete
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:693
performUpdate()
protected
performUpdate():void
Performs an element update. Note, if an exception is thrown during the update, firstUpdated
and updated
will not be called.
Call performUpdate()
to immediately process a pending update. This should generally not be needed, but it can be done in rare cases when you need to update synchronously.
Returns
void
Inherited from
LitElement.performUpdate
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:629
requestUpdate()
requestUpdate(
name
?,oldValue
?,options
?):void
Requests an update which is processed asynchronously. This should be called when an element should update based on some state not triggered by setting a reactive property. In this case, pass no arguments. It should also be called when manually implementing a property setter. In this case, pass the property name
and oldValue
to ensure that any configured property options are honored.
Parameters
• name?: PropertyKey
name of requesting property
• oldValue?: unknown
old value of requesting property
• options?: PropertyDeclaration
<unknown
, unknown
>
property options to use instead of the previously configured options
Returns
void
Inherited from
LitElement.requestUpdate
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:596
scheduleUpdate()
protected
scheduleUpdate():void
|Promise
<unknown
>
Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate()
must be called.
For instance, to schedule updates to occur just before the next frame:
ts
override protected async scheduleUpdate(): Promise<unknown> {
await new Promise((resolve) => requestAnimationFrame(() => resolve()));
super.scheduleUpdate();
}
Returns
void
| Promise
<unknown
>
Inherited from
LitElement.scheduleUpdate
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:618
shouldUpdate()
protected
shouldUpdate(_changedProperties
):boolean
Controls whether or not update()
should be called when the element requests an update. By default, this method always returns true
, but this can be customized to control when to update.
Parameters
• _changedProperties: PropertyValueMap
<any
> | Map
<PropertyKey
, unknown
>
Map of changed properties with old values
Returns
boolean
Inherited from
LitElement.shouldUpdate
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:702
update()
protected
update(changedProperties
):void
Updates the element. This method reflects property values to attributes and calls render
to render DOM via lit-html. Setting properties inside this method will not trigger another update.
Parameters
• changedProperties: PropertyValueMap
<any
> | Map
<PropertyKey
, unknown
>
Map of changed properties with old values
Returns
void
Inherited from
LitElement.update
Defined in
node_modules/.pnpm/lit-element@4.0.4/node_modules/lit-element/development/lit-element.d.ts:101
updated()
protected
updated(_changedProperties
):void
Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.
Setting properties inside this method will trigger the element to update again after this update cycle completes.
Parameters
• _changedProperties: PropertyValueMap
<any
> | Map
<PropertyKey
, unknown
>
Map of changed properties with old values
Returns
void
Inherited from
LitElement.updated
Defined in
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:723
willUpdate()
willUpdate(
changedProperties
):Promise
<void
>
Invoked before update()
to compute values needed during the update.
Implement willUpdate
to compute property values that depend on other properties and are used in the rest of the update process.
ts
willUpdate(changedProperties) {
// only need to check changed properties for an expensive computation.
if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
}
}
render() {
return html`SHA: ${this.sha}`;
}
Parameters
• changedProperties: PropertyValueMap
<ROSPlayer
>
Returns
Promise
<void
>
Overrides
LitElement.willUpdate