Class: ROSPlayer

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:72

Can load and display GLTF models.

Examples

Use as a web component

HTML properties:

environment-url: IBL light environment to load
background-color: RGBA color of the background

html

<ros-player background-color="rgba(0, 0, 0, 0)" environment-url="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.backgroundColor = [0, 0, 0, 0]
 renderer.appendChild(new ROSModel('assets/scene.gltf'))
 renderer.environmentURL = 'environments/field.hdre'
 document.body.appendChild(renderer)

Extends

LitElement

Implements

ROSHost

Constructors

new ROSPlayer()

new ROSPlayer(): ROSPlayer

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:186

Returns

ROSPlayer

Overrides

LitElement.constructor

HTML Properties

alwaysRerender

alwaysRerender: boolean = false

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:98

Force rendering in the frame loop, otherwise only render on demand.

backgroundColor

backgroundColor: RGBAColor

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:111

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

highlightColor

highlightColor: RGBAColor

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:136

Set the highlight color of a selected object

outlineColor

outlineColor: RGBAColor

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:124

Set the outline color of a selected object Color is in the format rgb(n,n,n) where n is 0-255

HTML Properties

Environment map used for reflections and lightning. Must be in the HDR, KTX2, KTX, or HDRE format.

environmentURL?

optional environmentURL: string = ""

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:79

Other

_offCameraMoved?

optional _offCameraMoved: RemoveEventListener

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:207

_offKeyUp?

optional _offKeyUp: RemoveEventListener

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:183

_offRenderAlpha?

optional _offRenderAlpha: RemoveEventListener

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:184

accessKey

accessKey: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10496

MDN Reference

Inherited from

LitElement.accessKey

accessKeyLabel

readonly accessKeyLabel: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10498

MDN Reference

Inherited from

LitElement.accessKeyLabel

ariaAtomic

ariaAtomic: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2405

MDN Reference

Implementation of

ROSHost.ariaAtomic

Inherited from

LitElement.ariaAtomic

ariaAutoComplete

ariaAutoComplete: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2407

MDN Reference

Implementation of

ROSHost.ariaAutoComplete

Inherited from

LitElement.ariaAutoComplete

ariaBrailleLabel

ariaBrailleLabel: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2409

MDN Reference

Implementation of

ROSHost.ariaBrailleLabel

Inherited from

LitElement.ariaBrailleLabel

ariaBrailleRoleDescription

ariaBrailleRoleDescription: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2411

MDN Reference

Implementation of

ROSHost.ariaBrailleRoleDescription

Inherited from

LitElement.ariaBrailleRoleDescription

ariaBusy

ariaBusy: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2413

MDN Reference

Implementation of

ROSHost.ariaBusy

Inherited from

LitElement.ariaBusy

ariaChecked

ariaChecked: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2415

MDN Reference

Implementation of

ROSHost.ariaChecked

Inherited from

LitElement.ariaChecked

ariaColCount

ariaColCount: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2417

MDN Reference

Implementation of

ROSHost.ariaColCount

Inherited from

LitElement.ariaColCount

ariaColIndex

ariaColIndex: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2419

MDN Reference

Implementation of

ROSHost.ariaColIndex

Inherited from

LitElement.ariaColIndex

ariaColIndexText

ariaColIndexText: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2421

MDN Reference

Implementation of

ROSHost.ariaColIndexText

Inherited from

LitElement.ariaColIndexText

ariaColSpan

ariaColSpan: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2423

MDN Reference

Implementation of

ROSHost.ariaColSpan

Inherited from

LitElement.ariaColSpan

ariaCurrent

ariaCurrent: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2425

MDN Reference

Implementation of

ROSHost.ariaCurrent

Inherited from

LitElement.ariaCurrent

ariaDescription

ariaDescription: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2427

MDN Reference

Implementation of

ROSHost.ariaDescription

Inherited from

LitElement.ariaDescription

ariaDisabled

ariaDisabled: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2429

MDN Reference

Implementation of

ROSHost.ariaDisabled

Inherited from

LitElement.ariaDisabled

ariaExpanded

ariaExpanded: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2431

MDN Reference

Implementation of

ROSHost.ariaExpanded

Inherited from

LitElement.ariaExpanded

ariaHasPopup

ariaHasPopup: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2433

MDN Reference

Implementation of

ROSHost.ariaHasPopup

Inherited from

LitElement.ariaHasPopup

ariaHidden

ariaHidden: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2435

MDN Reference

Implementation of

ROSHost.ariaHidden

Inherited from

LitElement.ariaHidden

ariaInvalid

ariaInvalid: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2436

Implementation of

ROSHost.ariaInvalid

Inherited from

LitElement.ariaInvalid

ariaKeyShortcuts

ariaKeyShortcuts: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2438

MDN Reference

Implementation of

ROSHost.ariaKeyShortcuts

Inherited from

LitElement.ariaKeyShortcuts

ariaLabel

ariaLabel: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2440

MDN Reference

Implementation of

ROSHost.ariaLabel

Inherited from

LitElement.ariaLabel

ariaLevel

ariaLevel: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2442

MDN Reference

Implementation of

ROSHost.ariaLevel

Inherited from

LitElement.ariaLevel

ariaLive

ariaLive: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2444

MDN Reference

Implementation of

ROSHost.ariaLive

Inherited from

LitElement.ariaLive

ariaModal

ariaModal: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2446

MDN Reference

Implementation of

ROSHost.ariaModal

Inherited from

LitElement.ariaModal

ariaMultiLine

ariaMultiLine: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2448

MDN Reference

Implementation of

ROSHost.ariaMultiLine

Inherited from

LitElement.ariaMultiLine

ariaMultiSelectable

ariaMultiSelectable: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2450

MDN Reference

Implementation of

ROSHost.ariaMultiSelectable

Inherited from

LitElement.ariaMultiSelectable

ariaOrientation

ariaOrientation: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2452

MDN Reference

Implementation of

ROSHost.ariaOrientation

Inherited from

LitElement.ariaOrientation

ariaPlaceholder

ariaPlaceholder: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2454

MDN Reference

Implementation of

ROSHost.ariaPlaceholder

Inherited from

LitElement.ariaPlaceholder

ariaPosInSet

ariaPosInSet: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2456

MDN Reference

Implementation of

ROSHost.ariaPosInSet

Inherited from

LitElement.ariaPosInSet

ariaPressed

ariaPressed: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2458

MDN Reference

Implementation of

ROSHost.ariaPressed

Inherited from

LitElement.ariaPressed

ariaReadOnly

ariaReadOnly: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2460

MDN Reference

Implementation of

ROSHost.ariaReadOnly

Inherited from

LitElement.ariaReadOnly

ariaRequired

ariaRequired: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2462

MDN Reference

Implementation of

ROSHost.ariaRequired

Inherited from

LitElement.ariaRequired

ariaRoleDescription

ariaRoleDescription: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2464

MDN Reference

Implementation of

ROSHost.ariaRoleDescription

Inherited from

LitElement.ariaRoleDescription

ariaRowCount

ariaRowCount: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2466

MDN Reference

Implementation of

ROSHost.ariaRowCount

Inherited from

LitElement.ariaRowCount

ariaRowIndex

ariaRowIndex: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2468

MDN Reference

Implementation of

ROSHost.ariaRowIndex

Inherited from

LitElement.ariaRowIndex

ariaRowIndexText

ariaRowIndexText: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2470

MDN Reference

Implementation of

ROSHost.ariaRowIndexText

Inherited from

LitElement.ariaRowIndexText

ariaRowSpan

ariaRowSpan: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2472

MDN Reference

Implementation of

ROSHost.ariaRowSpan

Inherited from

LitElement.ariaRowSpan

ariaSelected

ariaSelected: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2474

MDN Reference

Implementation of

ROSHost.ariaSelected

Inherited from

LitElement.ariaSelected

ariaSetSize

ariaSetSize: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2476

MDN Reference

Implementation of

ROSHost.ariaSetSize

Inherited from

LitElement.ariaSetSize

ariaSort

ariaSort: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2478

MDN Reference

Implementation of

ROSHost.ariaSort

Inherited from

LitElement.ariaSort

ariaValueMax

ariaValueMax: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2480

MDN Reference

Implementation of

ROSHost.ariaValueMax

Inherited from

LitElement.ariaValueMax

ariaValueMin

ariaValueMin: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2482

MDN Reference

Implementation of

ROSHost.ariaValueMin

Inherited from

LitElement.ariaValueMin

ariaValueNow

ariaValueNow: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2484

MDN Reference

Implementation of

ROSHost.ariaValueNow

Inherited from

LitElement.ariaValueNow

ariaValueText

ariaValueText: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2486

MDN Reference

Implementation of

ROSHost.ariaValueText

Inherited from

LitElement.ariaValueText

assignedSlot

readonly assignedSlot: null | HTMLSlotElement

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:21934

MDN Reference

Implementation of

ROSHost.assignedSlot

Inherited from

LitElement.assignedSlot

ATTRIBUTE_NODE

readonly ATTRIBUTE_NODE: 2

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16718

Implementation of

ROSHost.ATTRIBUTE_NODE

Inherited from

LitElement.ATTRIBUTE_NODE

attributes

readonly attributes: NamedNodeMap

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8076

MDN Reference

Implementation of

ROSHost.attributes

Inherited from

LitElement.attributes

attributeStyleMap

readonly attributeStyleMap: StylePropertyMap

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8341

MDN Reference

Inherited from

LitElement.attributeStyleMap

autocapitalize

autocapitalize: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10500

MDN Reference

Inherited from

LitElement.autocapitalize

autofocus

autofocus: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:12508

MDN Reference

Inherited from

LitElement.autofocus

baseURI

readonly baseURI: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16587

Returns node's node document's document base URL.

MDN Reference

Implementation of

ROSHost.baseURI

Inherited from

LitElement.baseURI

bloom

bloom: number = 0.5

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:159

Bloom postprocessing effect persitence. Only applicable if postfx is true.

cameraController?

optional cameraController: OrbitControl

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:174

CDATA_SECTION_NODE

readonly CDATA_SECTION_NODE: 4

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16722

node is a CDATASection node.

Implementation of

ROSHost.CDATA_SECTION_NODE

Inherited from

LitElement.CDATA_SECTION_NODE

childElementCount

readonly childElementCount: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17281

MDN Reference

Implementation of

ROSHost.childElementCount

Inherited from

LitElement.childElementCount

childNodes

readonly childNodes: NodeListOf<ChildNode>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16593

Returns the children.

MDN Reference

Implementation of

ROSHost.childNodes

Inherited from

LitElement.childNodes

children

readonly children: HTMLCollection

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17287

Returns the child elements.

MDN Reference

Implementation of

ROSHost.children

Inherited from

LitElement.children

classList

readonly classList: DOMTokenList

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8082

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

MDN Reference

Implementation of

ROSHost.classList

Inherited from

LitElement.classList

className

className: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8088

Returns the value of element's class content attribute. Can be set to change it.

MDN Reference

Implementation of

ROSHost.className

Inherited from

LitElement.className

clientHeight

readonly clientHeight: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8090

MDN Reference

Implementation of

ROSHost.clientHeight

Inherited from

LitElement.clientHeight

clientLeft

readonly clientLeft: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8092

MDN Reference

Implementation of

ROSHost.clientLeft

Inherited from

LitElement.clientLeft

clientTop

readonly clientTop: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8094

MDN Reference

Implementation of

ROSHost.clientTop

Inherited from

LitElement.clientTop

clientWidth

readonly clientWidth: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8096

MDN Reference

Implementation of

ROSHost.clientWidth

Inherited from

LitElement.clientWidth

COMMENT_NODE

readonly COMMENT_NODE: 8

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16728

node is a Comment node.

Implementation of

ROSHost.COMMENT_NODE

Inherited from

LitElement.COMMENT_NODE

contentEditable

contentEditable: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8348

MDN Reference

Inherited from

LitElement.contentEditable

currentCSSZoom

readonly currentCSSZoom: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8098

MDN Reference

Implementation of

ROSHost.currentCSSZoom

Inherited from

LitElement.currentCSSZoom

dataset

readonly dataset: DOMStringMap

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:12510

MDN Reference

Inherited from

LitElement.dataset

dir

dir: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10502

MDN Reference

Inherited from

LitElement.dir

DOCUMENT_FRAGMENT_NODE

readonly DOCUMENT_FRAGMENT_NODE: 11

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16734

node is a DocumentFragment node.

Implementation of

ROSHost.DOCUMENT_FRAGMENT_NODE

Inherited from

LitElement.DOCUMENT_FRAGMENT_NODE

DOCUMENT_NODE

readonly DOCUMENT_NODE: 9

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16730

node is a document.

Implementation of

ROSHost.DOCUMENT_NODE

Inherited from

LitElement.DOCUMENT_NODE

DOCUMENT_POSITION_CONTAINED_BY

readonly DOCUMENT_POSITION_CONTAINED_BY: 16

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16745

Set when other is a descendant of node.

Implementation of

ROSHost.DOCUMENT_POSITION_CONTAINED_BY

Inherited from

LitElement.DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINS

readonly DOCUMENT_POSITION_CONTAINS: 8

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16743

Set when other is an ancestor of node.

Implementation of

ROSHost.DOCUMENT_POSITION_CONTAINS

Inherited from

LitElement.DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_DISCONNECTED

readonly DOCUMENT_POSITION_DISCONNECTED: 1

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16737

Set when node and other are not in the same tree.

Implementation of

ROSHost.DOCUMENT_POSITION_DISCONNECTED

Inherited from

LitElement.DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_FOLLOWING

readonly DOCUMENT_POSITION_FOLLOWING: 4

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16741

Set when other is following node.

Implementation of

ROSHost.DOCUMENT_POSITION_FOLLOWING

Inherited from

LitElement.DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16746

Implementation of

ROSHost.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Inherited from

LitElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_PRECEDING

readonly DOCUMENT_POSITION_PRECEDING: 2

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16739

Set when other is preceding node.

Implementation of

ROSHost.DOCUMENT_POSITION_PRECEDING

Inherited from

LitElement.DOCUMENT_POSITION_PRECEDING

DOCUMENT_TYPE_NODE

readonly DOCUMENT_TYPE_NODE: 10

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16732

node is a doctype.

Implementation of

ROSHost.DOCUMENT_TYPE_NODE

Inherited from

LitElement.DOCUMENT_TYPE_NODE

draggable

draggable: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10504

MDN Reference

Inherited from

LitElement.draggable

ELEMENT_NODE

readonly ELEMENT_NODE: 1

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16717

node is an element.

Implementation of

ROSHost.ELEMENT_NODE

Inherited from

LitElement.ELEMENT_NODE

engineName

engineName: string = ""

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:91

enterKeyHint

enterKeyHint: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8350

MDN Reference

Inherited from

LitElement.enterKeyHint

ENTITY_NODE

readonly ENTITY_NODE: 6

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16724

Implementation of

ROSHost.ENTITY_NODE

Inherited from

LitElement.ENTITY_NODE

ENTITY_REFERENCE_NODE

readonly ENTITY_REFERENCE_NODE: 5

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16723

Implementation of

ROSHost.ENTITY_REFERENCE_NODE

Inherited from

LitElement.ENTITY_REFERENCE_NODE

environmentAngle

environmentAngle: number = 0

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:82

environmentFormat?

optional environmentFormat: string = ""

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:88

environmentMipmap

environmentMipmap: number = 0

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:85

exposure

exposure: number = 1

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:139

firstChild

readonly firstChild: null | ChildNode

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16599

Returns the first child.

MDN Reference

Implementation of

ROSHost.firstChild

Inherited from

LitElement.firstChild

firstElementChild

readonly firstElementChild: null | Element

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17293

Returns the first child that is an element, and null otherwise.

MDN Reference

Implementation of

ROSHost.firstElementChild

Inherited from

LitElement.firstElementChild

hidden

hidden: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10506

MDN Reference

Inherited from

LitElement.hidden

id

id: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8104

Returns the value of element's id content attribute. Can be set to change it.

MDN Reference

Implementation of

ROSHost.id

Inherited from

LitElement.id

inert

inert: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10508

MDN Reference

Inherited from

LitElement.inert

innerHTML

innerHTML: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8106

MDN Reference

Implementation of

ROSHost.innerHTML

Inherited from

LitElement.innerHTML

innerText

innerText: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10510

MDN Reference

Inherited from

LitElement.innerText

inputMode

inputMode: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8352

MDN Reference

Inherited from

LitElement.inputMode

isConnected

readonly isConnected: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16605

Returns true if node is connected and false otherwise.

MDN Reference

Implementation of

ROSHost.isConnected

Inherited from

LitElement.isConnected

isContentEditable

readonly isContentEditable: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8354

MDN Reference

Inherited from

LitElement.isContentEditable

lang

lang: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10512

MDN Reference

Inherited from

LitElement.lang

lastChild

readonly lastChild: null | ChildNode

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16611

Returns the last child.

MDN Reference

Implementation of

ROSHost.lastChild

Inherited from

LitElement.lastChild

lastElementChild

readonly lastElementChild: null | Element

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17299

Returns the last child that is an element, and null otherwise.

MDN Reference

Implementation of

ROSHost.lastElementChild

Inherited from

LitElement.lastElementChild

localName

readonly localName: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8112

Returns the local name.

MDN Reference

Implementation of

ROSHost.localName

Inherited from

LitElement.localName

msaa

msaa: number = 1

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:147

namespaceURI

readonly namespaceURI: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8118

Returns the namespace.

MDN Reference

Implementation of

ROSHost.namespaceURI

Inherited from

LitElement.namespaceURI

nextElementSibling

readonly nextElementSibling: null | Element

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16867

Returns the first following sibling that is an element, and null otherwise.

MDN Reference

Implementation of

ROSHost.nextElementSibling

Inherited from

LitElement.nextElementSibling

nextSibling

readonly nextSibling: null | ChildNode

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16617

Returns the next sibling.

MDN Reference

Implementation of

ROSHost.nextSibling

Inherited from

LitElement.nextSibling

nodeName

readonly nodeName: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16623

Returns a string appropriate for the type of node.

MDN Reference

Implementation of

ROSHost.nodeName

Inherited from

LitElement.nodeName

nodeType

readonly nodeType: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16629

Returns the type of node.

MDN Reference

Implementation of

ROSHost.nodeType

Inherited from

LitElement.nodeType

nodeValue

nodeValue: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16631

MDN Reference

Implementation of

ROSHost.nodeValue

Inherited from

LitElement.nodeValue

nonce?

optional nonce: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:12512

MDN Reference

Inherited from

LitElement.nonce

NOTATION_NODE

readonly NOTATION_NODE: 12

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16735

Implementation of

ROSHost.NOTATION_NODE

Inherited from

LitElement.NOTATION_NODE

offsetHeight

readonly offsetHeight: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10514

MDN Reference

Inherited from

LitElement.offsetHeight

offsetLeft

readonly offsetLeft: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10516

MDN Reference

Inherited from

LitElement.offsetLeft

offsetParent

readonly offsetParent: null | Element

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10518

MDN Reference

Inherited from

LitElement.offsetParent

offsetTop

readonly offsetTop: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10520

MDN Reference

Inherited from

LitElement.offsetTop

offsetWidth

readonly offsetWidth: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10522

MDN Reference

Inherited from

LitElement.offsetWidth

onabort

onabort: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9452

Fires when the user aborts the download.

Param

The event.

MDN Reference

Inherited from

LitElement.onabort

onanimationcancel

onanimationcancel: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9454

MDN Reference

Inherited from

LitElement.onanimationcancel

onanimationend

onanimationend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9456

MDN Reference

Inherited from

LitElement.onanimationend

onanimationiteration

onanimationiteration: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9458

MDN Reference

Inherited from

LitElement.onanimationiteration

onanimationstart

onanimationstart: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9460

MDN Reference

Inherited from

LitElement.onanimationstart

onauxclick

onauxclick: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9462

MDN Reference

Inherited from

LitElement.onauxclick

onbeforeinput

onbeforeinput: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9464

MDN Reference

Inherited from

LitElement.onbeforeinput

onbeforetoggle

onbeforetoggle: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9466

MDN Reference

Inherited from

LitElement.onbeforetoggle

onblur

onblur: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9473

Fires when the object loses the input focus.

Param

The focus event.

MDN Reference

Inherited from

LitElement.onblur

oncancel

oncancel: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9475

MDN Reference

Inherited from

LitElement.oncancel

oncanplay

oncanplay: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9482

Occurs when playback is possible, but would require further buffering.

Param

The event.

MDN Reference

Inherited from

LitElement.oncanplay

oncanplaythrough

oncanplaythrough: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9484

MDN Reference

Inherited from

LitElement.oncanplaythrough

onchange

onchange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9491

Fires when the contents of the object or selection have changed.

Param

The event.

MDN Reference

Inherited from

LitElement.onchange

onclick

onclick: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9498

Fires when the user clicks the left mouse button on the object

Param

The mouse event.

MDN Reference

Inherited from

LitElement.onclick

onclose

onclose: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9500

MDN Reference

Inherited from

LitElement.onclose

oncontextlost

oncontextlost: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9502

MDN Reference

Inherited from

LitElement.oncontextlost

oncontextmenu

oncontextmenu: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9509

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Param

The mouse event.

MDN Reference

Inherited from

LitElement.oncontextmenu

oncontextrestored

oncontextrestored: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9511

MDN Reference

Inherited from

LitElement.oncontextrestored

oncopy

oncopy: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9513

MDN Reference

Inherited from

LitElement.oncopy

oncuechange

oncuechange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9515

MDN Reference

Inherited from

LitElement.oncuechange

oncut

oncut: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9517

MDN Reference

Inherited from

LitElement.oncut

ondblclick

ondblclick: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9524

Fires when the user double-clicks the object.

Param

The mouse event.

MDN Reference

Inherited from

LitElement.ondblclick

ondrag

ondrag: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9531

Fires on the source object continuously during a drag operation.

Param

The event.

MDN Reference

Inherited from

LitElement.ondrag

ondragend

ondragend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9538

Fires on the source object when the user releases the mouse at the close of a drag operation.

Param

The event.

MDN Reference

Inherited from

LitElement.ondragend

ondragenter

ondragenter: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9545

Fires on the target element when the user drags the object to a valid drop target.

Param

The drag event.

MDN Reference

Inherited from

LitElement.ondragenter

ondragleave

ondragleave: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9552

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.

MDN Reference

Inherited from

LitElement.ondragleave

ondragover

ondragover: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9559

Fires on the target element continuously while the user drags the object over a valid drop target.

Param

The event.

MDN Reference

Inherited from

LitElement.ondragover

ondragstart

ondragstart: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9566

Fires on the source object when the user starts to drag a text selection or selected object.

Param

The event.

MDN Reference

Inherited from

LitElement.ondragstart

ondrop

ondrop: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9568

MDN Reference

Inherited from

LitElement.ondrop

ondurationchange

ondurationchange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9575

Occurs when the duration attribute is updated.

Param

The event.

MDN Reference

Inherited from

LitElement.ondurationchange

onemptied

onemptied: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9582

Occurs when the media element is reset to its initial state.

Param

The event.

MDN Reference

Inherited from

LitElement.onemptied

onended

onended: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9589

Occurs when the end of playback is reached.

Param

The event

MDN Reference

Inherited from

LitElement.onended

onerror

onerror: OnErrorEventHandler

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9596

Fires when an error occurs during object loading.

Param

The event.

MDN Reference

Inherited from

LitElement.onerror

onfocus

onfocus: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9603

Fires when the object receives focus.

Param

The event.

MDN Reference

Inherited from

LitElement.onfocus

onformdata

onformdata: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9605

MDN Reference

Inherited from

LitElement.onformdata

onfullscreenchange

onfullscreenchange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8120

MDN Reference

Implementation of

ROSHost.onfullscreenchange

Inherited from

LitElement.onfullscreenchange

onfullscreenerror

onfullscreenerror: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8122

MDN Reference

Implementation of

ROSHost.onfullscreenerror

Inherited from

LitElement.onfullscreenerror

ongotpointercapture

ongotpointercapture: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9607

MDN Reference

Inherited from

LitElement.ongotpointercapture

oninput

oninput: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9609

MDN Reference

Inherited from

LitElement.oninput

oninvalid

oninvalid: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9611

MDN Reference

Inherited from

LitElement.oninvalid

onkeydown

onkeydown: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9618

Fires when the user presses a key.

Param

The keyboard event

MDN Reference

Inherited from

LitElement.onkeydown

onkeypress

onkeypress: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9626

Fires when the user presses an alphanumeric key.

Param

The event.

Deprecated

MDN Reference

Inherited from

LitElement.onkeypress

onkeyup

onkeyup: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9633

Fires when the user releases a key.

Param

The keyboard event

MDN Reference

Inherited from

LitElement.onkeyup

onload

onload: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9640

Fires immediately after the browser loads the object.

Param

The event.

MDN Reference

Inherited from

LitElement.onload

onloadeddata

onloadeddata: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9647

Occurs when media data is loaded at the current playback position.

Param

The event.

MDN Reference

Inherited from

LitElement.onloadeddata

onloadedmetadata

onloadedmetadata: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9654

Occurs when the duration and dimensions of the media have been determined.

Param

The event.

MDN Reference

Inherited from

LitElement.onloadedmetadata

onloadstart

onloadstart: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9661

Occurs when Internet Explorer begins looking for media data.

Param

The event.

MDN Reference

Inherited from

LitElement.onloadstart

onlostpointercapture

onlostpointercapture: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9663

MDN Reference

Inherited from

LitElement.onlostpointercapture

onmousedown

onmousedown: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9670

Fires when the user clicks the object with either mouse button.

Param

The mouse event.

MDN Reference

Inherited from

LitElement.onmousedown

onmouseenter

onmouseenter: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9672

MDN Reference

Inherited from

LitElement.onmouseenter

onmouseleave

onmouseleave: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9674

MDN Reference

Inherited from

LitElement.onmouseleave

onmousemove

onmousemove: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9681

Fires when the user moves the mouse over the object.

Param

The mouse event.

MDN Reference

Inherited from

LitElement.onmousemove

onmouseout

onmouseout: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9688

Fires when the user moves the mouse pointer outside the boundaries of the object.

Param

The mouse event.

MDN Reference

Inherited from

LitElement.onmouseout

onmouseover

onmouseover: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9695

Fires when the user moves the mouse pointer into the object.

Param

The mouse event.

MDN Reference

Inherited from

LitElement.onmouseover

onmouseup

onmouseup: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9702

Fires when the user releases a mouse button while the mouse is over the object.

Param

The mouse event.

MDN Reference

Inherited from

LitElement.onmouseup

onpaste

onpaste: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9704

MDN Reference

Inherited from

LitElement.onpaste

onpause

onpause: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9711

Occurs when playback is paused.

Param

The event.

MDN Reference

Inherited from

LitElement.onpause

onplay

onplay: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9718

Occurs when the play method is requested.

Param

The event.

MDN Reference

Inherited from

LitElement.onplay

onplaying

onplaying: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9725

Occurs when the audio or video has started playing.

Param

The event.

MDN Reference

Inherited from

LitElement.onplaying

onpointercancel

onpointercancel: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9727

MDN Reference

Inherited from

LitElement.onpointercancel

onpointerdown

onpointerdown: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9729

MDN Reference

Inherited from

LitElement.onpointerdown

onpointerenter

onpointerenter: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9731

MDN Reference

Inherited from

LitElement.onpointerenter

onpointerleave

onpointerleave: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9733

MDN Reference

Inherited from

LitElement.onpointerleave

onpointermove

onpointermove: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9735

MDN Reference

Inherited from

LitElement.onpointermove

onpointerout

onpointerout: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9737

MDN Reference

Inherited from

LitElement.onpointerout

onpointerover

onpointerover: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9739

MDN Reference

Inherited from

LitElement.onpointerover

onpointerup

onpointerup: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9741

MDN Reference

Inherited from

LitElement.onpointerup

onprogress

onprogress: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9748

Occurs to indicate progress while downloading media data.

Param

The event.

MDN Reference

Inherited from

LitElement.onprogress

onratechange

onratechange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9755

Occurs when the playback rate is increased or decreased.

Param

The event.

MDN Reference

Inherited from

LitElement.onratechange

onreset

onreset: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9762

Fires when the user resets a form.

Param

The event.

MDN Reference

Inherited from

LitElement.onreset

onresize

onresize: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9764

MDN Reference

Inherited from

LitElement.onresize

onscroll

onscroll: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9771

Fires when the user repositions the scroll box in the scroll bar on the object.

Param

The event.

MDN Reference

Inherited from

LitElement.onscroll

onscrollend

onscrollend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9773

MDN Reference

Inherited from

LitElement.onscrollend

onsecuritypolicyviolation

onsecuritypolicyviolation: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9775

MDN Reference

Inherited from

LitElement.onsecuritypolicyviolation

onseeked

onseeked: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9782

Occurs when the seek operation ends.

Param

The event.

MDN Reference

Inherited from

LitElement.onseeked

onseeking

onseeking: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9789

Occurs when the current playback position is moved.

Param

The event.

MDN Reference

Inherited from

LitElement.onseeking

onselect

onselect: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9796

Fires when the current selection changes.

Param

The event.

MDN Reference

Inherited from

LitElement.onselect

onselectionchange

onselectionchange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9798

MDN Reference

Inherited from

LitElement.onselectionchange

onselectstart

onselectstart: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9800

MDN Reference

Inherited from

LitElement.onselectstart

onslotchange

onslotchange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9802

MDN Reference

Inherited from

LitElement.onslotchange

onstalled

onstalled: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9809

Occurs when the download has stopped.

Param

The event.

MDN Reference

Inherited from

LitElement.onstalled

onsubmit

onsubmit: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9811

MDN Reference

Inherited from

LitElement.onsubmit

onsuspend

onsuspend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9818

Occurs if the load operation has been intentionally halted.

Param

The event.

MDN Reference

Inherited from

LitElement.onsuspend

ontimeupdate

ontimeupdate: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9825

Occurs to indicate the current playback position.

Param

The event.

MDN Reference

Inherited from

LitElement.ontimeupdate

ontoggle

ontoggle: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9827

MDN Reference

Inherited from

LitElement.ontoggle

ontouchcancel?

optional ontouchcancel: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9829

MDN Reference

Inherited from

LitElement.ontouchcancel

ontouchend?

optional ontouchend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9831

MDN Reference

Inherited from

LitElement.ontouchend

ontouchmove?

optional ontouchmove: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9833

MDN Reference

Inherited from

LitElement.ontouchmove

ontouchstart?

optional ontouchstart: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9835

MDN Reference

Inherited from

LitElement.ontouchstart

ontransitioncancel

ontransitioncancel: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9837

MDN Reference

Inherited from

LitElement.ontransitioncancel

ontransitionend

ontransitionend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9839

MDN Reference

Inherited from

LitElement.ontransitionend

ontransitionrun

ontransitionrun: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9841

MDN Reference

Inherited from

LitElement.ontransitionrun

ontransitionstart

ontransitionstart: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9843

MDN Reference

Inherited from

LitElement.ontransitionstart

onvolumechange

onvolumechange: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9850

Occurs when the volume is changed, or playback is muted or unmuted.

Param

The event.

MDN Reference

Inherited from

LitElement.onvolumechange

onwaiting

onwaiting: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9857

Occurs when playback stops because the next frame of a video resource is not available.

Param

The event.

MDN Reference

Inherited from

LitElement.onwaiting

onwebkitanimationend

onwebkitanimationend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9863

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

Inherited from

LitElement.onwebkitanimationend

onwebkitanimationiteration

onwebkitanimationiteration: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9869

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

Inherited from

LitElement.onwebkitanimationiteration

onwebkitanimationstart

onwebkitanimationstart: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9875

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

Inherited from

LitElement.onwebkitanimationstart

onwebkittransitionend

onwebkittransitionend: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9881

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

Inherited from

LitElement.onwebkittransitionend

onwheel

onwheel: null | (this, ev) => any

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:9883

MDN Reference

Inherited from

LitElement.onwheel

outerHTML

outerHTML: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8124

MDN Reference

Implementation of

ROSHost.outerHTML

Inherited from

LitElement.outerHTML

outerText

outerText: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10524

MDN Reference

Inherited from

LitElement.outerText

ownerDocument

readonly ownerDocument: Document

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8125

Returns the node document. Returns null for documents.

MDN Reference

Implementation of

ROSHost.ownerDocument

Inherited from

LitElement.ownerDocument

parentElement

readonly parentElement: null | HTMLElement

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16643

Returns the parent element.

MDN Reference

Implementation of

ROSHost.parentElement

Inherited from

LitElement.parentElement

parentNode

readonly parentNode: null | ParentNode

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16649

Returns the parent.

MDN Reference

Implementation of

ROSHost.parentNode

Inherited from

LitElement.parentNode

part

readonly part: DOMTokenList

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8127

MDN Reference

Implementation of

ROSHost.part

Inherited from

LitElement.part

popover: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10526

MDN Reference

Inherited from

LitElement.popover

postfx

postfx: boolean = false

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:153

Apply post processing effects

prefix

readonly prefix: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8133

Returns the namespace prefix.

MDN Reference

Implementation of

ROSHost.prefix

Inherited from

LitElement.prefix

previousElementSibling

readonly previousElementSibling: null | Element

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16873

Returns the first preceding sibling that is an element, and null otherwise.

MDN Reference

Implementation of

ROSHost.previousElementSibling

Inherited from

LitElement.previousElementSibling

previousSibling

readonly previousSibling: null | ChildNode

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16655

Returns the previous sibling.

MDN Reference

Implementation of

ROSHost.previousSibling

Inherited from

LitElement.previousSibling

PROCESSING_INSTRUCTION_NODE

readonly PROCESSING_INSTRUCTION_NODE: 7

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16726

node is a ProcessingInstruction node.

Implementation of

ROSHost.PROCESSING_INSTRUCTION_NODE

Inherited from

LitElement.PROCESSING_INSTRUCTION_NODE

refreshHint

refreshHint: eRefreshHint = eRefreshHint.ON_FRAME

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:180

renderer?

optional renderer: RendererInterface

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:173

rendererReady?

optional rendererReady: Promise<RendererInterface>

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:172

role

role: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2487

Implementation of

ROSHost.role

Inherited from

LitElement.role

scene

scene: Scene

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:169

scrollHeight

readonly scrollHeight: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8135

MDN Reference

Implementation of

ROSHost.scrollHeight

Inherited from

LitElement.scrollHeight

scrollLeft

scrollLeft: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8137

MDN Reference

Implementation of

ROSHost.scrollLeft

Inherited from

LitElement.scrollLeft

scrollTop

scrollTop: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8139

MDN Reference

Implementation of

ROSHost.scrollTop

Inherited from

LitElement.scrollTop

scrollWidth

readonly scrollWidth: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8141

MDN Reference

Implementation of

ROSHost.scrollWidth

Inherited from

LitElement.scrollWidth

shadowRoot

readonly shadowRoot: null | ShadowRoot

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8147

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

MDN Reference

Implementation of

ROSHost.shadowRoot

Inherited from

LitElement.shadowRoot

skybox

skybox: boolean = false

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:144

Show a 360˚ skybox when an environment is loaded using .

slot

slot: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8153

Returns the value of element's slot content attribute. Can be set to change it.

MDN Reference

Implementation of

ROSHost.slot

Inherited from

LitElement.slot

spellcheck

spellcheck: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10528

MDN Reference

Inherited from

LitElement.spellcheck

style

readonly style: CSSStyleDeclaration

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8343

MDN Reference

Inherited from

LitElement.style

tabIndex

tabIndex: number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:12514

MDN Reference

Inherited from

LitElement.tabIndex

tagName

readonly tagName: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8159

Returns the HTML-uppercased qualified name.

MDN Reference

Implementation of

ROSHost.tagName

Inherited from

LitElement.tagName

TEXT_NODE

readonly TEXT_NODE: 3

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16720

node is a Text node.

Implementation of

ROSHost.TEXT_NODE

Inherited from

LitElement.TEXT_NODE

textContent

textContent: null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16657

MDN Reference

Implementation of

ROSHost.textContent

Inherited from

LitElement.textContent

title

title: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10530

MDN Reference

Inherited from

LitElement.title

translate

translate: boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10532

MDN Reference

Inherited from

LitElement.translate

viewmode

viewmode: string = "FINAL"

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:162

writingSuggestions

writingSuggestions: string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10533

Inherited from

LitElement.writingSuggestions

_$litElement$

static _$litElement$: boolean

Defined in: node_modules/.pnpm/lit-element@4.1.1/node_modules/lit-element/development/lit-element.d.ts:84

Inherited from

LitElement._$litElement$

_initializers?

static optional _initializers: Initializer[]

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:258

Inherited from

LitElement._initializers

[metadata]

static [metadata]: object & Record<PropertyKey, unknown>

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:417

Inherited from

LitElement.[metadata]

finalized

protected static finalized: undefined | true

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:272

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

camera

Get Signature

get camera(): Camera

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:209

Returns

Camera

Implementation of

ROSHost.camera

frameMs

Get Signature

get frameMs(): number

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:289

Returns

number

models

Get Signature

get models(): object

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:759

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

ROSHost.models

plugins

Get Signature

get plugins(): ROSPlugin[]

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:326

Returns

ROSPlugin[]

transparentBackground

Get Signature

get transparentBackground(): boolean

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:223

Returns

boolean

addEventListener()

Call Signature

addEventListener<K>(type, listener, options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10544

Type Parameters

• K extends keyof HTMLElementEventMap

Parameters

type

K

listener

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Implementation of

ROSHost.addEventListener

Inherited from

LitElement.addEventListener

Call Signature

addEventListener(type, listener, options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10545

Parameters

type

string

listener

EventListenerOrEventListenerObject

options?

boolean | AddEventListenerOptions

Returns

void

Implementation of

ROSHost.addEventListener

Inherited from

LitElement.addEventListener

after()

after(...nodes): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:6051

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.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Implementation of

ROSHost.after

Inherited from

LitElement.after

afterFrame()

afterFrame(elapsedTime): void

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:608

Parameters

elapsedTime

number

Returns

void

animate()

animate(keyframes, options?): Animation

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2639

MDN Reference

Parameters

keyframes

null | Keyframe[] | PropertyIndexedKeyframes

options?

number | KeyframeAnimationOptions

Returns

Animation

Implementation of

ROSHost.animate

Inherited from

LitElement.animate

append()

append(...nodes): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17307

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.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Implementation of

ROSHost.append

Inherited from

LitElement.append

appendChild()

appendChild<T>(node): T

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16659

MDN Reference

Type Parameters

• T extends Node

Parameters

node

T

Returns

T

Implementation of

ROSHost.appendChild

Inherited from

LitElement.appendChild

attachInternals()

attachInternals(): ElementInternals

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10535

MDN Reference

Returns

ElementInternals

Inherited from

LitElement.attachInternals

attachShadow()

attachShadow(init): ShadowRoot

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8165

Creates a shadow root for element and returns it.

MDN Reference

Parameters

init

ShadowRootInit

Returns

ShadowRoot

Implementation of

ROSHost.attachShadow

Inherited from

LitElement.attachShadow

before()

before(...nodes): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:6059

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.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Implementation of

ROSHost.before

Inherited from

LitElement.before

beforeFrame()

beforeFrame(elapsedTime): void

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:578

Parameters

elapsedTime

number

Returns

void

blur()

blur(): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:12516

MDN Reference

Returns

void

Inherited from

LitElement.blur

checkVisibility()

checkVisibility(options?): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8167

MDN Reference

Parameters

options?

CheckVisibilityOptions

Returns

boolean

Implementation of

ROSHost.checkVisibility

Inherited from

LitElement.checkVisibility

click()

click(): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10537

MDN Reference

Returns

void

Inherited from

LitElement.click

cloneNode()

cloneNode(deep?): Node

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16665

Returns a copy of node. If deep is true, the copy also includes the node's descendants.

MDN Reference

Parameters

deep?

boolean

Returns

Node

Implementation of

ROSHost.cloneNode

Inherited from

LitElement.cloneNode

closest()

Call Signature

closest<K>(selector): null | HTMLElementTagNameMap[K]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8173

Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

MDN Reference

Type Parameters

• K extends keyof HTMLElementTagNameMap

Parameters

selector

K

Returns

null | HTMLElementTagNameMap[K]

Implementation of

ROSHost.closest

Inherited from

LitElement.closest

Call Signature

closest<K>(selector): null | SVGElementTagNameMap[K]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8174

Type Parameters

• K extends keyof SVGElementTagNameMap

Parameters

selector

K

Returns

null | SVGElementTagNameMap[K]

Implementation of

ROSHost.closest

Inherited from

LitElement.closest

Call Signature

closest<K>(selector): null | MathMLElementTagNameMap[K]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8175

Type Parameters

• K extends keyof MathMLElementTagNameMap

Parameters

selector

K

Returns

null | MathMLElementTagNameMap[K]

Implementation of

ROSHost.closest

Inherited from

LitElement.closest

Call Signature

closest<E>(selectors): null | E

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8176

Type Parameters

• E extends Element = Element

Parameters

selectors

string

Returns

null | E

Implementation of

ROSHost.closest

Inherited from

LitElement.closest

compareDocumentPosition()

compareDocumentPosition(other): number

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16671

Returns a bitmask indicating the position of other relative to node.

MDN Reference

Parameters

other

Node

Returns

number

Implementation of

ROSHost.compareDocumentPosition

Inherited from

LitElement.compareDocumentPosition

computedStyleMap()

computedStyleMap(): StylePropertyMapReadOnly

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8178

MDN Reference

Returns

StylePropertyMapReadOnly

Implementation of

ROSHost.computedStyleMap

Inherited from

LitElement.computedStyleMap

contains()

contains(other): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16677

Returns true if other is an inclusive descendant of node, and false otherwise.

MDN Reference

Parameters

other

null | Node

Returns

boolean

Implementation of

ROSHost.contains

Inherited from

LitElement.contains

dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8719

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.

MDN Reference

Parameters

event

Event

Returns

boolean

Implementation of

ROSHost.dispatchEvent

Inherited from

LitElement.dispatchEvent

focus()

focus(options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:12518

MDN Reference

Parameters

options?

FocusOptions

Returns

void

Inherited from

LitElement.focus

focusOnNode()

focusOnNode(n): void

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:330

Parameters

n

Node

Returns

void

getAnimations()

getAnimations(options?): Animation[]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:2641

MDN Reference

Parameters

options?

GetAnimationsOptions

Returns

Animation[]

Implementation of

ROSHost.getAnimations

Inherited from

LitElement.getAnimations

getAttribute()

getAttribute(qualifiedName): null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8184

Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

MDN Reference

Parameters

qualifiedName

string

Returns

null | string

Implementation of

ROSHost.getAttribute

Inherited from

LitElement.getAttribute

getAttributeNames()

getAttributeNames(): string[]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8196

Returns the qualified names of all element's attributes. Can contain duplicates.

MDN Reference

Returns

string[]

Implementation of

ROSHost.getAttributeNames

Inherited from

LitElement.getAttributeNames

getAttributeNode()

getAttributeNode(qualifiedName): null | Attr

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8198

MDN Reference

Parameters

qualifiedName

string

Returns

null | Attr

Implementation of

ROSHost.getAttributeNode

Inherited from

LitElement.getAttributeNode

getAttributeNodeNS()

getAttributeNodeNS(namespace, localName): null | Attr

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8200

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

null | Attr

Implementation of

ROSHost.getAttributeNodeNS

Inherited from

LitElement.getAttributeNodeNS

getAttributeNS()

getAttributeNS(namespace, localName): null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8190

Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

null | string

Implementation of

ROSHost.getAttributeNS

Inherited from

LitElement.getAttributeNS

getBoundingClientRect()

getBoundingClientRect(): DOMRect

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8202

MDN Reference

Returns

DOMRect

Implementation of

ROSHost.getBoundingClientRect

Inherited from

LitElement.getBoundingClientRect

getClientRects()

getClientRects(): DOMRectList

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8204

MDN Reference

Returns

DOMRectList

Implementation of

ROSHost.getClientRects

Inherited from

LitElement.getClientRects

getElementsByClassName()

getElementsByClassName(classNames): HTMLCollectionOf<Element>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8210

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.

MDN Reference

Parameters

classNames

string

Returns

HTMLCollectionOf<Element>

Implementation of

ROSHost.getElementsByClassName

Inherited from

LitElement.getElementsByClassName

getElementsByTagName()

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8212

MDN Reference

Type Parameters

• K extends keyof HTMLElementTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<HTMLElementTagNameMap[K]>

Implementation of

ROSHost.getElementsByTagName

Inherited from

LitElement.getElementsByTagName

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8213

Type Parameters

• K extends keyof SVGElementTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<SVGElementTagNameMap[K]>

Implementation of

ROSHost.getElementsByTagName

Inherited from

LitElement.getElementsByTagName

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8214

Type Parameters

• K extends keyof MathMLElementTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<MathMLElementTagNameMap[K]>

Implementation of

ROSHost.getElementsByTagName

Inherited from

LitElement.getElementsByTagName

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8216

Type Parameters

• K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated

Implementation of

ROSHost.getElementsByTagName

Inherited from

LitElement.getElementsByTagName

Call Signature

getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8217

Parameters

qualifiedName

string

Returns

HTMLCollectionOf<Element>

Implementation of

ROSHost.getElementsByTagName

Inherited from

LitElement.getElementsByTagName

getElementsByTagNameNS()

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8219

MDN Reference

Parameters

namespaceURI

"http://www.w3.org/1999/xhtml"

localName

string

Returns

HTMLCollectionOf<HTMLElement>

Implementation of

ROSHost.getElementsByTagNameNS

Inherited from

LitElement.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8220

Parameters

namespaceURI

"http://www.w3.org/2000/svg"

localName

string

Returns

HTMLCollectionOf<SVGElement>

Implementation of

ROSHost.getElementsByTagNameNS

Inherited from

LitElement.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8221

Parameters

namespaceURI

"http://www.w3.org/1998/Math/MathML"

localName

string

Returns

HTMLCollectionOf<MathMLElement>

Implementation of

ROSHost.getElementsByTagNameNS

Inherited from

LitElement.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8222

Parameters

namespace

null | string

localName

string

Returns

HTMLCollectionOf<Element>

Implementation of

ROSHost.getElementsByTagNameNS

Inherited from

LitElement.getElementsByTagNameNS

getHTML()

getHTML(options?): string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8224

MDN Reference

Parameters

options?

GetHTMLOptions

Returns

string

Implementation of

ROSHost.getHTML

Inherited from

LitElement.getHTML

getRootNode()

getRootNode(options?): Node

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16683

Returns node's root.

MDN Reference

Parameters

options?

GetRootNodeOptions

Returns

Node

Implementation of

ROSHost.getRootNode

Inherited from

LitElement.getRootNode

hasAttribute()

hasAttribute(qualifiedName): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8230

Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

MDN Reference

Parameters

qualifiedName

string

Returns

boolean

Implementation of

ROSHost.hasAttribute

Inherited from

LitElement.hasAttribute

hasAttributeNS()

hasAttributeNS(namespace, localName): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8236

Returns true if element has an attribute whose namespace is namespace and local name is localName.

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

boolean

Implementation of

ROSHost.hasAttributeNS

Inherited from

LitElement.hasAttributeNS

hasAttributes()

hasAttributes(): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8242

Returns true if element has attributes, and false otherwise.

MDN Reference

Returns

boolean

Implementation of

ROSHost.hasAttributes

Inherited from

LitElement.hasAttributes

hasChildNodes()

hasChildNodes(): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16689

Returns whether node has children.

MDN Reference

Returns

boolean

Implementation of

ROSHost.hasChildNodes

Inherited from

LitElement.hasChildNodes

hasPointerCapture()

hasPointerCapture(pointerId): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8244

MDN Reference

Parameters

pointerId

number

Returns

boolean

Implementation of

ROSHost.hasPointerCapture

Inherited from

LitElement.hasPointerCapture

hidePopover()

hidePopover(): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10539

MDN Reference

Returns

void

Inherited from

LitElement.hidePopover

insertAdjacentElement()

insertAdjacentElement(where, element): null | Element

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8246

MDN Reference

Parameters

where

InsertPosition

element

Element

Returns

null | Element

Implementation of

ROSHost.insertAdjacentElement

Inherited from

LitElement.insertAdjacentElement

insertAdjacentHTML()

insertAdjacentHTML(position, string): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8248

MDN Reference

Parameters

position

InsertPosition

string

string

Returns

void

Implementation of

ROSHost.insertAdjacentHTML

Inherited from

LitElement.insertAdjacentHTML

insertAdjacentText()

insertAdjacentText(where, data): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8250

MDN Reference

Parameters

where

InsertPosition

data

string

Returns

void

Implementation of

ROSHost.insertAdjacentText

Inherited from

LitElement.insertAdjacentText

insertBefore()

insertBefore<T>(node, child): T

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16691

MDN Reference

Type Parameters

• T extends Node

Parameters

node

T

child

null | Node

Returns

T

Implementation of

ROSHost.insertBefore

Inherited from

LitElement.insertBefore

isDefaultNamespace()

isDefaultNamespace(namespace): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16693

MDN Reference

Parameters

namespace

null | string

Returns

boolean

Implementation of

ROSHost.isDefaultNamespace

Inherited from

LitElement.isDefaultNamespace

isEqualNode()

isEqualNode(otherNode): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16699

Returns whether node and otherNode have the same properties.

MDN Reference

Parameters

otherNode

null | Node

Returns

boolean

Implementation of

ROSHost.isEqualNode

Inherited from

LitElement.isEqualNode

isSameNode()

isSameNode(otherNode): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16701

MDN Reference

Parameters

otherNode

null | Node

Returns

boolean

Implementation of

ROSHost.isSameNode

Inherited from

LitElement.isSameNode

isWithinShortDistanceOfPointerDown()

isWithinShortDistanceOfPointerDown(ev): boolean

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:391

Parameters

ev

PointerEvent

Returns

boolean

loadEnvironment()

loadEnvironment(path, format?): Promise<void>

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:543

Parameters

path

string

format?

string

Returns

Promise<void>

lookupNamespaceURI()

lookupNamespaceURI(prefix): null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16703

MDN Reference

Parameters

prefix

null | string

Returns

null | string

Implementation of

ROSHost.lookupNamespaceURI

Inherited from

LitElement.lookupNamespaceURI

lookupPrefix()

lookupPrefix(namespace): null | string

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16705

MDN Reference

Parameters

namespace

null | string

Returns

null | string

Implementation of

ROSHost.lookupPrefix

Inherited from

LitElement.lookupPrefix

matches()

matches(selectors): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8256

Returns true if matching selectors against element's root yields element, and false otherwise.

MDN Reference

Parameters

selectors

string

Returns

boolean

Implementation of

ROSHost.matches

Inherited from

LitElement.matches

normalize()

normalize(): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16711

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

MDN Reference

Returns

void

Implementation of

ROSHost.normalize

Inherited from

LitElement.normalize

pickScene()

pickScene(x, y, layers, shiftKey): Promise<undefined | Node>

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:337

Parameters

x

number

y

number

layers

number = 0xff

shiftKey

boolean = false

Returns

Promise<undefined | Node>

pointerHandler()

pointerHandler(event): void

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:367

Parameters

event

PointerEvent

Returns

void

prepend()

prepend(...nodes): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17315

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.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Implementation of

ROSHost.prepend

Inherited from

LitElement.prepend

project()

project(vec, viewport): vec3

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:213

Parameters

vec

vec3

viewport

vec4

Returns

vec3

querySelector()

Call Signature

querySelector<K>(selectors): null | HTMLElementTagNameMap[K]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17321

Returns the first element that is a descendant of node that matches selectors.

MDN Reference

Type Parameters

• K extends keyof HTMLElementTagNameMap

Parameters

selectors

K

Returns

null | HTMLElementTagNameMap[K]

Implementation of

ROSHost.querySelector

Inherited from

LitElement.querySelector

Call Signature

querySelector<K>(selectors): null | SVGElementTagNameMap[K]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17322

Type Parameters

• K extends keyof SVGElementTagNameMap

Parameters

selectors

K

Returns

null | SVGElementTagNameMap[K]

Implementation of

ROSHost.querySelector

Inherited from

LitElement.querySelector

Call Signature

querySelector<K>(selectors): null | MathMLElementTagNameMap[K]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17323

Type Parameters

• K extends keyof MathMLElementTagNameMap

Parameters

selectors

K

Returns

null | MathMLElementTagNameMap[K]

Implementation of

ROSHost.querySelector

Inherited from

LitElement.querySelector

Call Signature

querySelector<K>(selectors): null | HTMLElementDeprecatedTagNameMap[K]

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17325

Type Parameters

• K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

selectors

K

Returns

null | HTMLElementDeprecatedTagNameMap[K]

Deprecated

Implementation of

ROSHost.querySelector

Inherited from

LitElement.querySelector

Call Signature

querySelector<E>(selectors): null | E

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17326

Type Parameters

• E extends Element = Element

Parameters

selectors

string

Returns

null | E

Implementation of

ROSHost.querySelector

Inherited from

LitElement.querySelector

querySelectorAll()

Call Signature

querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17332

Returns all element descendants of node that match selectors.

MDN Reference

Type Parameters

• K extends keyof HTMLElementTagNameMap

Parameters

selectors

K

Returns

NodeListOf<HTMLElementTagNameMap[K]>

Implementation of

ROSHost.querySelectorAll

Inherited from

LitElement.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17333

Type Parameters

• K extends keyof SVGElementTagNameMap

Parameters

selectors

K

Returns

NodeListOf<SVGElementTagNameMap[K]>

Implementation of

ROSHost.querySelectorAll

Inherited from

LitElement.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17334

Type Parameters

• K extends keyof MathMLElementTagNameMap

Parameters

selectors

K

Returns

NodeListOf<MathMLElementTagNameMap[K]>

Implementation of

ROSHost.querySelectorAll

Inherited from

LitElement.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17336

Type Parameters

• K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

selectors

K

Returns

NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated

Implementation of

ROSHost.querySelectorAll

Inherited from

LitElement.querySelectorAll

Call Signature

querySelectorAll<E>(selectors): NodeListOf<E>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17337

Type Parameters

• E extends Element = Element

Parameters

selectors

string

Returns

NodeListOf<E>

Implementation of

ROSHost.querySelectorAll

Inherited from

LitElement.querySelectorAll

releasePointerCapture()

releasePointerCapture(pointerId): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8258

MDN Reference

Parameters

pointerId

number

Returns

void

Implementation of

ROSHost.releasePointerCapture

Inherited from

LitElement.releasePointerCapture

remove()

remove(): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:6065

Removes node.

MDN Reference

Returns

void

Implementation of

ROSHost.remove

Inherited from

LitElement.remove

removeAttribute()

removeAttribute(qualifiedName): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8264

Removes element's first attribute whose qualified name is qualifiedName.

MDN Reference

Parameters

qualifiedName

string

Returns

void

Implementation of

ROSHost.removeAttribute

Inherited from

LitElement.removeAttribute

removeAttributeNode()

removeAttributeNode(attr): Attr

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8272

MDN Reference

Parameters

attr

Attr

Returns

Attr

Implementation of

ROSHost.removeAttributeNode

Inherited from

LitElement.removeAttributeNode

removeAttributeNS()

removeAttributeNS(namespace, localName): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8270

Removes element's attribute whose namespace is namespace and local name is localName.

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

void

Implementation of

ROSHost.removeAttributeNS

Inherited from

LitElement.removeAttributeNS

removeChild()

removeChild<T>(child): T

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16713

MDN Reference

Type Parameters

• T extends Node

Parameters

child

T

Returns

T

Implementation of

ROSHost.removeChild

Inherited from

LitElement.removeChild

removeEventListener()

Call Signature

removeEventListener<K>(type, listener, options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10546

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Type Parameters

• K extends keyof HTMLElementEventMap

Parameters

type

K

listener

(this, ev) => any

options?

boolean | EventListenerOptions

Returns

void

Implementation of

ROSHost.removeEventListener

Inherited from

LitElement.removeEventListener

Call Signature

removeEventListener(type, listener, options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10547

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters

type

string

listener

EventListenerOrEventListenerObject

options?

boolean | EventListenerOptions

Returns

void

Implementation of

ROSHost.removeEventListener

Inherited from

LitElement.removeEventListener

replaceChild()

replaceChild<T>(node, child): T

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:16715

MDN Reference

Type Parameters

• T extends Node

Parameters

node

Node

child

T

Returns

T

Implementation of

ROSHost.replaceChild

Inherited from

LitElement.replaceChild

replaceChildren()

replaceChildren(...nodes): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:17345

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.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Implementation of

ROSHost.replaceChildren

Inherited from

LitElement.replaceChildren

replaceWith()

replaceWith(...nodes): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:6073

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.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Implementation of

ROSHost.replaceWith

Inherited from

LitElement.replaceWith

requestFullscreen()

requestFullscreen(options?): Promise<void>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8280

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.

MDN Reference

Parameters

options?

FullscreenOptions

Returns

Promise<void>

Implementation of

ROSHost.requestFullscreen

Inherited from

LitElement.requestFullscreen

requestPointerLock()

requestPointerLock(options?): Promise<void>

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8282

MDN Reference

Parameters

options?

PointerLockOptions

Returns

Promise<void>

Implementation of

ROSHost.requestPointerLock

Inherited from

LitElement.requestPointerLock

scroll()

Call Signature

scroll(options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8284

MDN Reference

Parameters

options?

ScrollToOptions

Returns

void

Implementation of

ROSHost.scroll

Inherited from

LitElement.scroll

Call Signature

scroll(x, y): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8285

Parameters

x

number

y

number

Returns

void

Implementation of

ROSHost.scroll

Inherited from

LitElement.scroll

scrollBy()

Call Signature

scrollBy(options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8287

MDN Reference

Parameters

options?

ScrollToOptions

Returns

void

Implementation of

ROSHost.scrollBy

Inherited from

LitElement.scrollBy

Call Signature

scrollBy(x, y): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8288

Parameters

x

number

y

number

Returns

void

Implementation of

ROSHost.scrollBy

Inherited from

LitElement.scrollBy

scrollIntoView()

scrollIntoView(arg?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8290

MDN Reference

Parameters

arg?

boolean | ScrollIntoViewOptions

Returns

void

Implementation of

ROSHost.scrollIntoView

Inherited from

LitElement.scrollIntoView

scrollTo()

Call Signature

scrollTo(options?): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8292

MDN Reference

Parameters

options?

ScrollToOptions

Returns

void

Implementation of

ROSHost.scrollTo

Inherited from

LitElement.scrollTo

Call Signature

scrollTo(x, y): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8293

Parameters

x

number

y

number

Returns

void

Implementation of

ROSHost.scrollTo

Inherited from

LitElement.scrollTo

setAttribute()

setAttribute(qualifiedName, value): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8299

Sets the value of element's first attribute whose qualified name is qualifiedName to value.

MDN Reference

Parameters

qualifiedName

string

value

string

Returns

void

Implementation of

ROSHost.setAttribute

Inherited from

LitElement.setAttribute

setAttributeNode()

setAttributeNode(attr): null | Attr

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8307

MDN Reference

Parameters

attr

Attr

Returns

null | Attr

Implementation of

ROSHost.setAttributeNode

Inherited from

LitElement.setAttributeNode

setAttributeNodeNS()

setAttributeNodeNS(attr): null | Attr

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8309

MDN Reference

Parameters

attr

Attr

Returns

null | Attr

Implementation of

ROSHost.setAttributeNodeNS

Inherited from

LitElement.setAttributeNodeNS

setAttributeNS()

setAttributeNS(namespace, qualifiedName, value): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8305

Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

MDN Reference

Parameters

namespace

null | string

qualifiedName

string

value

string

Returns

void

Implementation of

ROSHost.setAttributeNS

Inherited from

LitElement.setAttributeNS

setHTMLUnsafe()

setHTMLUnsafe(html): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8311

MDN Reference

Parameters

html

string

Returns

void

Implementation of

ROSHost.setHTMLUnsafe

Inherited from

LitElement.setHTMLUnsafe

setPointerCapture()

setPointerCapture(pointerId): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8313

MDN Reference

Parameters

pointerId

number

Returns

void

Implementation of

ROSHost.setPointerCapture

Inherited from

LitElement.setPointerCapture

showPopover()

showPopover(): void

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10541

MDN Reference

Returns

void

Inherited from

LitElement.showPopover

toggleAttribute()

toggleAttribute(qualifiedName, force?): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8321

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.

MDN Reference

Parameters

qualifiedName

string

force?

boolean

Returns

boolean

Implementation of

ROSHost.toggleAttribute

Inherited from

LitElement.toggleAttribute

togglePopover()

togglePopover(force?): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:10543

MDN Reference

Parameters

force?

boolean

Returns

boolean

Inherited from

LitElement.togglePopover

unproject()

unproject(vec, viewport): vec3

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:218

Parameters

vec

vec3

viewport

vec4

Returns

vec3

webkitMatchesSelector()

webkitMatchesSelector(selectors): boolean

Defined in: node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts:8327

Parameters

selectors

string

Returns

boolean

Deprecated

This is a legacy alias of matches.

MDN Reference

Implementation of

ROSHost.webkitMatchesSelector

Inherited from

LitElement.webkitMatchesSelector

addInitializer()

static addInitializer(initializer): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:257

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.

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:

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

finalize()

protected static finalize(): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:441

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

attributes

observedAttributes

Get Signature

get static observedAttributes(): string[]

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:346

Returns a list of attributes corresponding to the registered properties.

Nocollapse

Returns

string[]

Inherited from

LitElement.observedAttributes

attributeChangedCallback()

attributeChangedCallback(name, _old, value): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:580

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

controllers

addController()

addController(controller): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:519

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

removeController()

removeController(controller): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:524

Removes a ReactiveController from the element.

Parameters

controller

ReactiveController

Returns

void

Inherited from

LitElement.removeController

dev-mode

disableWarning()?

static optional disableWarning: (warningKind) => void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:223

Disable the given warning category for this class.

This method only exists in development builds, so it should be accessed with a guard like:

// 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

enabledWarnings?

static optional enabledWarnings: WarningKind[]

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:187

Read or set all the enabled warning categories for this class.

This property is only used in development builds.

Nocollapse

Inherited from

LitElement.enabledWarnings

enableWarning()?

static optional enableWarning: (warningKind) => void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:205

Enable the given warning category for this class.

This method only exists in development builds, so it should be accessed with a guard like:

// 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

lifecycle

connectedCallback()

connectedCallback(): Promise<void>

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:424

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.

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

disconnectedCallback()

disconnectedCallback(): Promise<void>

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:529

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.

disconnectedCallback() {
  super.disconnectedCallback();
  window.removeEventListener('keydown', this._handleKeydown);
}

An element may be re-connected after being disconnected.

Returns

Promise<void>

Overrides

LitElement.disconnectedCallback

properties

elementProperties

static elementProperties: PropertyDeclarationMap

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:280

Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.

Nocollapse

Inherited from

LitElement.elementProperties

properties

static properties: PropertyDeclarations

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:306

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

createProperty()

static createProperty(name, options?): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:373

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:

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

getPropertyDescriptor()

protected static getPropertyDescriptor(name, key, options): undefined | PropertyDescriptor

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:401

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,

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

Returns

undefined | PropertyDescriptor

Nocollapse

Inherited from

LitElement.getPropertyDescriptor

getPropertyOptions()

static getPropertyOptions(name): PropertyDeclaration<unknown, unknown>

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:416

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

rendering

renderOptions

readonly renderOptions: RenderOptions

Defined in: node_modules/.pnpm/lit-element@4.1.1/node_modules/lit-element/development/lit-element.d.ts:88

Inherited from

LitElement.renderOptions

renderRoot

readonly renderRoot: HTMLElement | DocumentFragment

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:473

Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.

Inherited from

LitElement.renderRoot

shadowRootOptions

static shadowRootOptions: ShadowRootInit

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:452

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

createRenderRoot()

protected createRenderRoot(): HTMLElement | DocumentFragment

Defined in: node_modules/.pnpm/lit-element@4.1.1/node_modules/lit-element/development/lit-element.d.ts:93

Returns

HTMLElement | DocumentFragment

Inherited from

LitElement.createRenderRoot

render()

render(): TemplateResult<1>

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:203

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

styles

elementStyles

static elementStyles: CSSResultOrNative[]

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:313

Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.

Nocollapse

Inherited from

LitElement.elementStyles

styles

static styles: CSSResult

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:192

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

finalizeStyles()

protected static finalizeStyles(styles?): CSSResultOrNative[]

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:467

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

updates

hasUpdated

hasUpdated: boolean

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:491

Is set to true after the first update. The element code cannot assume that renderRoot exists before the element hasUpdated.

Inherited from

LitElement.hasUpdated

isUpdatePending

isUpdatePending: boolean

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:485

True if there is a pending update as a result of calling requestUpdate(). Should only be read.

Inherited from

LitElement.isUpdatePending

updateComplete

Get Signature

get updateComplete(): Promise<boolean>

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:669

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

enableUpdating()

protected enableUpdating(_requestedUpdate): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:560

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

firstUpdated()

firstUpdated(): void

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:301

Invoked when the element is first updated. Implement to perform one time work on the element after update.

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

getUpdateComplete()

protected getUpdateComplete(): Promise<boolean>

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:693

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:

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

performUpdate()

protected performUpdate(): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:629

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

requestUpdate()

requestUpdate(name?, oldValue?, options?): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:596

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

scheduleUpdate()

protected scheduleUpdate(): void | Promise<unknown>

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:618

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:

override protected async scheduleUpdate(): Promise<unknown> {
  await new Promise((resolve) => requestAnimationFrame(() => resolve()));
  super.scheduleUpdate();
}

Returns

void | Promise<unknown>

Inherited from

LitElement.scheduleUpdate

shouldUpdate()

protected shouldUpdate(_changedProperties): boolean

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:702

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

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

boolean

Inherited from

LitElement.shouldUpdate

update()

protected update(changedProperties): void

Defined in: node_modules/.pnpm/lit-element@4.1.1/node_modules/lit-element/development/lit-element.d.ts:101

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

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Inherited from

LitElement.update

updated()

protected updated(_changedProperties): void

Defined in: node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:723

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

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Inherited from

LitElement.updated

willUpdate()

willUpdate(changedProperties): Promise<void>

Defined in: packages/charm/src/webComponents/ROSPlayer.ts:636

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.

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

Class: ROSPlayer ​

Examples ​

Use as a web component ​

Use from typescript and javascript ​

Extends ​

Implements ​

Constructors ​

new ROSPlayer() ​

Returns ​

Overrides ​

HTML Properties ​

alwaysRerender ​

backgroundColor ​

highlightColor ​

outlineColor ​

HTML Properties ​

environmentURL? ​

Other ​

_offCameraMoved? ​

_offKeyUp? ​

_offRenderAlpha? ​

accessKey ​

Inherited from ​

accessKeyLabel ​

Inherited from ​

ariaAtomic ​

Implementation of ​

Inherited from ​

ariaAutoComplete ​

Implementation of ​

Inherited from ​

ariaBrailleLabel ​

Implementation of ​

Inherited from ​

ariaBrailleRoleDescription ​

Implementation of ​

Inherited from ​

ariaBusy ​

Implementation of ​

Inherited from ​

ariaChecked ​

Implementation of ​

Inherited from ​

ariaColCount ​

Implementation of ​

Inherited from ​

ariaColIndex ​

Implementation of ​

Inherited from ​

ariaColIndexText ​

Implementation of ​

Inherited from ​

ariaColSpan ​

Implementation of ​

Inherited from ​

ariaCurrent ​

Implementation of ​

Inherited from ​

ariaDescription ​

Implementation of ​

Inherited from ​

ariaDisabled ​

Implementation of ​

Inherited from ​

ariaExpanded ​

Implementation of ​

Inherited from ​

ariaHasPopup ​

Implementation of ​

Inherited from ​

ariaHidden ​

Implementation of ​

Inherited from ​

ariaInvalid ​

Implementation of ​

Inherited from ​

ariaKeyShortcuts ​

Implementation of ​

Inherited from ​

ariaLabel ​

Class: ROSPlayer

Examples

Use as a web component

Use from typescript and javascript

Extends

Implements

Constructors

new ROSPlayer()

Returns

Overrides

HTML Properties

alwaysRerender

backgroundColor

highlightColor

outlineColor

HTML Properties

environmentURL?

Other

_offCameraMoved?

_offKeyUp?

_offRenderAlpha?

accessKey

Inherited from

accessKeyLabel

Inherited from

ariaAtomic

Implementation of

Inherited from

ariaAutoComplete

Implementation of

Inherited from

ariaBrailleLabel

Implementation of

Inherited from

ariaBrailleRoleDescription

Implementation of

Inherited from

ariaBusy

Implementation of

Inherited from

ariaChecked

Implementation of

Inherited from

ariaColCount

Implementation of

Inherited from

ariaColIndex

Implementation of

Inherited from

ariaColIndexText

Implementation of

Inherited from

ariaColSpan

Implementation of

Inherited from

ariaCurrent

Implementation of

Inherited from

ariaDescription

Implementation of

Inherited from

ariaDisabled

Implementation of

Inherited from

ariaExpanded

Implementation of

Inherited from

ariaHasPopup

Implementation of

Inherited from

ariaHidden

Implementation of

Inherited from

ariaInvalid

Implementation of

Inherited from

ariaKeyShortcuts

Implementation of

Inherited from

ariaLabel