Class: StatusBar
Defined in: src/controls/StatusBar.ts:28
The StatusBar component displays critical state information from neuroimaging viewers. It shows five main pieces of information:
- Mouse Position - 2D pixel coordinates within the current slice view
- Volume Coordinate - 3D voxel coordinates in the volume coordinate system
- World Coordinate - 3D coordinates in the original world space (millimeters)
- Current Coord - The current 3D position (typically crosshair location)
- Slice Indices - Current slice number(s) being displayed
This component works with both single-slice viewers (SliceViewer) and orthogonal multi-view displays (OrthogonalImageViewer) by implementing adaptive rendering based on the viewer type.
Extends
LitElement
Constructors
Constructor
new StatusBar(): StatusBar;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:527
Returns
StatusBar
Inherited from
LitElement.constructorProperties
Other
_initializers?
static optional _initializers?: Initializer[];Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:276
Inherited from
LitElement._initializers[metadata]
static [metadata]: object & Record<PropertyKey, unknown>;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:435
Inherited from
LitElement.[metadata]_$litElement$
static _$litElement$: boolean;Defined in: node_modules/lit-element/lit-element.d.ts:84
Inherited from
LitElement._$litElement$viewer
viewer: ViewerStateInfo;Defined in: src/controls/StatusBar.ts:34
The viewer property accepts any object that implements the ViewerStateInfo interface. This allows the StatusBar to work with different viewer implementations like SliceViewer and OrthogonalImageViewer.
styles
static styles: CSSResult;Defined in: src/controls/StatusBar.ts:46
CSS styles for the StatusBar component. Defines layout, spacing, colors, and typography for the status display.
Overrides
LitElement.stylesariaAtomic
ariaAtomic: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2466
Inherited from
LitElement.ariaAtomicariaAutoComplete
ariaAutoComplete: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2468
Inherited from
LitElement.ariaAutoCompleteariaBrailleLabel
ariaBrailleLabel: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2470
Inherited from
LitElement.ariaBrailleLabelariaBrailleRoleDescription
ariaBrailleRoleDescription: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2472
Inherited from
LitElement.ariaBrailleRoleDescriptionariaBusy
ariaBusy: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2474
Inherited from
LitElement.ariaBusyariaChecked
ariaChecked: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2476
Inherited from
LitElement.ariaCheckedariaColCount
ariaColCount: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2478
Inherited from
LitElement.ariaColCountariaColIndex
ariaColIndex: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2480
Inherited from
LitElement.ariaColIndexariaColIndexText
ariaColIndexText: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2482
Inherited from
LitElement.ariaColIndexTextariaColSpan
ariaColSpan: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2484
Inherited from
LitElement.ariaColSpanariaCurrent
ariaCurrent: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2486
Inherited from
LitElement.ariaCurrentariaDescription
ariaDescription: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2488
Inherited from
LitElement.ariaDescriptionariaDisabled
ariaDisabled: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2490
Inherited from
LitElement.ariaDisabledariaExpanded
ariaExpanded: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2492
Inherited from
LitElement.ariaExpandedariaHasPopup
ariaHasPopup: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2494
Inherited from
LitElement.ariaHasPopupariaHidden
ariaHidden: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2496
Inherited from
LitElement.ariaHiddenariaInvalid
ariaInvalid: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2497
Inherited from
LitElement.ariaInvalidariaKeyShortcuts
ariaKeyShortcuts: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2499
Inherited from
LitElement.ariaKeyShortcutsariaLabel
ariaLabel: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2501
Inherited from
LitElement.ariaLabelariaLevel
ariaLevel: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2503
Inherited from
LitElement.ariaLevelariaLive
ariaLive: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2505
Inherited from
LitElement.ariaLiveariaModal
ariaModal: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2507
Inherited from
LitElement.ariaModalariaMultiLine
ariaMultiLine: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2509
Inherited from
LitElement.ariaMultiLineariaMultiSelectable
ariaMultiSelectable: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2511
Inherited from
LitElement.ariaMultiSelectableariaOrientation
ariaOrientation: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2513
Inherited from
LitElement.ariaOrientationariaPlaceholder
ariaPlaceholder: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2515
Inherited from
LitElement.ariaPlaceholderariaPosInSet
ariaPosInSet: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2517
Inherited from
LitElement.ariaPosInSetariaPressed
ariaPressed: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2519
Inherited from
LitElement.ariaPressedariaReadOnly
ariaReadOnly: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2521
Inherited from
LitElement.ariaReadOnlyariaRelevant
ariaRelevant: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2523
Inherited from
LitElement.ariaRelevantariaRequired
ariaRequired: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2525
Inherited from
LitElement.ariaRequiredariaRoleDescription
ariaRoleDescription: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2527
Inherited from
LitElement.ariaRoleDescriptionariaRowCount
ariaRowCount: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2529
Inherited from
LitElement.ariaRowCountariaRowIndex
ariaRowIndex: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2531
Inherited from
LitElement.ariaRowIndexariaRowIndexText
ariaRowIndexText: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2533
Inherited from
LitElement.ariaRowIndexTextariaRowSpan
ariaRowSpan: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2535
Inherited from
LitElement.ariaRowSpanariaSelected
ariaSelected: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2537
Inherited from
LitElement.ariaSelectedariaSetSize
ariaSetSize: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2539
Inherited from
LitElement.ariaSetSizeariaSort
ariaSort: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2541
Inherited from
LitElement.ariaSortariaValueMax
ariaValueMax: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2543
Inherited from
LitElement.ariaValueMaxariaValueMin
ariaValueMin: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2545
Inherited from
LitElement.ariaValueMinariaValueNow
ariaValueNow: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2547
Inherited from
LitElement.ariaValueNowariaValueText
ariaValueText: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2549
Inherited from
LitElement.ariaValueTextrole
role: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2550
Inherited from
LitElement.roleattributes
readonly attributes: NamedNodeMap;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8231
Inherited from
LitElement.attributesclassName
className: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8244
Returns the value of element's class content attribute. Can be set to change it.
Inherited from
LitElement.classNameclientHeight
readonly clientHeight: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8246
Inherited from
LitElement.clientHeightclientLeft
readonly clientLeft: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8248
Inherited from
LitElement.clientLeftclientTop
readonly clientTop: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8250
Inherited from
LitElement.clientTopclientWidth
readonly clientWidth: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8252
Inherited from
LitElement.clientWidthcurrentCSSZoom
readonly currentCSSZoom: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8254
Inherited from
LitElement.currentCSSZoomid
id: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8260
Returns the value of element's id content attribute. Can be set to change it.
Inherited from
LitElement.idinnerHTML
innerHTML: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8262
Inherited from
LitElement.innerHTMLlocalName
readonly localName: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8268
Returns the local name.
Inherited from
LitElement.localNamenamespaceURI
readonly namespaceURI: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8274
Returns the namespace.
Inherited from
LitElement.namespaceURIonfullscreenchange
onfullscreenchange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8276
Inherited from
LitElement.onfullscreenchangeonfullscreenerror
onfullscreenerror: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8278
Inherited from
LitElement.onfullscreenerrorouterHTML
outerHTML: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8280
Inherited from
LitElement.outerHTMLownerDocument
readonly ownerDocument: Document;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8281
Returns the node document. Returns null for documents.
Inherited from
LitElement.ownerDocumentprefix
readonly prefix: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8290
Returns the namespace prefix.
Inherited from
LitElement.prefixscrollHeight
readonly scrollHeight: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8292
Inherited from
LitElement.scrollHeightscrollLeft
scrollLeft: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8294
Inherited from
LitElement.scrollLeftscrollTop
scrollTop: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8296
Inherited from
LitElement.scrollTopscrollWidth
readonly scrollWidth: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8298
Inherited from
LitElement.scrollWidthshadowRoot
readonly shadowRoot: ShadowRoot | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8304
Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Inherited from
LitElement.shadowRootslot
slot: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8310
Returns the value of element's slot content attribute. Can be set to change it.
Inherited from
LitElement.slottagName
readonly tagName: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8316
Returns the HTML-uppercased qualified name.
Inherited from
LitElement.tagNameattributeStyleMap
readonly attributeStyleMap: StylePropertyMap;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8498
Inherited from
LitElement.attributeStyleMapcontentEditable
contentEditable: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8506
Inherited from
LitElement.contentEditableenterKeyHint
enterKeyHint: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8508
Inherited from
LitElement.enterKeyHintinputMode
inputMode: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8510
Inherited from
LitElement.inputModeisContentEditable
readonly isContentEditable: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8512
Inherited from
LitElement.isContentEditableonabort
onabort: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9625
Fires when the user aborts the download.
Param
ev
The event.
Inherited from
LitElement.onabortonanimationcancel
onanimationcancel: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9627
Inherited from
LitElement.onanimationcancelonanimationend
onanimationend: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9629
Inherited from
LitElement.onanimationendonanimationiteration
onanimationiteration: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9631
Inherited from
LitElement.onanimationiterationonanimationstart
onanimationstart: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9633
Inherited from
LitElement.onanimationstartonauxclick
onauxclick: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9635
Inherited from
LitElement.onauxclickonbeforeinput
onbeforeinput: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9637
Inherited from
LitElement.onbeforeinputonbeforetoggle
onbeforetoggle: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9639
Inherited from
LitElement.onbeforetoggleonblur
onblur: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9646
Fires when the object loses the input focus.
Param
ev
The focus event.
Inherited from
LitElement.onbluroncancel
oncancel: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9648
Inherited from
LitElement.oncanceloncanplay
oncanplay: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9655
Occurs when playback is possible, but would require further buffering.
Param
ev
The event.
Inherited from
LitElement.oncanplayoncanplaythrough
oncanplaythrough: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9657
Inherited from
LitElement.oncanplaythroughonchange
onchange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9664
Fires when the contents of the object or selection have changed.
Param
ev
The event.
Inherited from
LitElement.onchangeonclick
onclick: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9671
Fires when the user clicks the left mouse button on the object
Param
ev
The mouse event.
Inherited from
LitElement.onclickonclose
onclose: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9673
Inherited from
LitElement.oncloseoncontextlost
oncontextlost: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9675
Inherited from
LitElement.oncontextlostoncontextmenu
oncontextmenu: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9682
Fires when the user clicks the right mouse button in the client area, opening the context menu.
Param
ev
The mouse event.
Inherited from
LitElement.oncontextmenuoncontextrestored
oncontextrestored: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9684
Inherited from
LitElement.oncontextrestoredoncopy
oncopy: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9686
Inherited from
LitElement.oncopyoncuechange
oncuechange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9688
Inherited from
LitElement.oncuechangeoncut
oncut: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9690
Inherited from
LitElement.oncutondblclick
ondblclick: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9697
Fires when the user double-clicks the object.
Param
ev
The mouse event.
Inherited from
LitElement.ondblclickondrag
ondrag: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9704
Fires on the source object continuously during a drag operation.
Param
ev
The event.
Inherited from
LitElement.ondragondragend
ondragend: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9711
Fires on the source object when the user releases the mouse at the close of a drag operation.
Param
ev
The event.
Inherited from
LitElement.ondragendondragenter
ondragenter: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9718
Fires on the target element when the user drags the object to a valid drop target.
Param
ev
The drag event.
Inherited from
LitElement.ondragenterondragleave
ondragleave: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9725
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Param
ev
The drag event.
Inherited from
LitElement.ondragleaveondragover
ondragover: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9732
Fires on the target element continuously while the user drags the object over a valid drop target.
Param
ev
The event.
Inherited from
LitElement.ondragoverondragstart
ondragstart: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9739
Fires on the source object when the user starts to drag a text selection or selected object.
Param
ev
The event.
Inherited from
LitElement.ondragstartondrop
ondrop: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9741
Inherited from
LitElement.ondropondurationchange
ondurationchange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9748
Occurs when the duration attribute is updated.
Param
ev
The event.
Inherited from
LitElement.ondurationchangeonemptied
onemptied: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9755
Occurs when the media element is reset to its initial state.
Param
ev
The event.
Inherited from
LitElement.onemptiedonended
onended: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9762
Occurs when the end of playback is reached.
Param
ev
The event
Inherited from
LitElement.onendedonerror
onerror: OnErrorEventHandler;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9769
Fires when an error occurs during object loading.
Param
ev
The event.
Inherited from
LitElement.onerroronfocus
onfocus: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9776
Fires when the object receives focus.
Param
ev
The event.
Inherited from
LitElement.onfocusonformdata
onformdata: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9778
Inherited from
LitElement.onformdataongotpointercapture
ongotpointercapture: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9780
Inherited from
LitElement.ongotpointercaptureoninput
oninput: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9782
Inherited from
LitElement.oninputoninvalid
oninvalid: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9784
Inherited from
LitElement.oninvalidonkeydown
onkeydown: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9791
Fires when the user presses a key.
Param
ev
The keyboard event
Inherited from
LitElement.onkeydownonkeypress
onkeypress: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9799
Fires when the user presses an alphanumeric key.
Param
ev
The event.
Deprecated
Inherited from
LitElement.onkeypressonkeyup
onkeyup: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9806
Fires when the user releases a key.
Param
ev
The keyboard event
Inherited from
LitElement.onkeyuponload
onload: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9813
Fires immediately after the browser loads the object.
Param
ev
The event.
Inherited from
LitElement.onloadonloadeddata
onloadeddata: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9820
Occurs when media data is loaded at the current playback position.
Param
ev
The event.
Inherited from
LitElement.onloadeddataonloadedmetadata
onloadedmetadata: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9827
Occurs when the duration and dimensions of the media have been determined.
Param
ev
The event.
Inherited from
LitElement.onloadedmetadataonloadstart
onloadstart: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9834
Occurs when Internet Explorer begins looking for media data.
Param
ev
The event.
Inherited from
LitElement.onloadstartonlostpointercapture
onlostpointercapture: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9836
Inherited from
LitElement.onlostpointercaptureonmousedown
onmousedown: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9843
Fires when the user clicks the object with either mouse button.
Param
ev
The mouse event.
Inherited from
LitElement.onmousedownonmouseenter
onmouseenter: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9845
Inherited from
LitElement.onmouseenteronmouseleave
onmouseleave: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9847
Inherited from
LitElement.onmouseleaveonmousemove
onmousemove: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9854
Fires when the user moves the mouse over the object.
Param
ev
The mouse event.
Inherited from
LitElement.onmousemoveonmouseout
onmouseout: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9861
Fires when the user moves the mouse pointer outside the boundaries of the object.
Param
ev
The mouse event.
Inherited from
LitElement.onmouseoutonmouseover
onmouseover: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9868
Fires when the user moves the mouse pointer into the object.
Param
ev
The mouse event.
Inherited from
LitElement.onmouseoveronmouseup
onmouseup: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9875
Fires when the user releases a mouse button while the mouse is over the object.
Param
ev
The mouse event.
Inherited from
LitElement.onmouseuponpaste
onpaste: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9877
Inherited from
LitElement.onpasteonpause
onpause: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9884
Occurs when playback is paused.
Param
ev
The event.
Inherited from
LitElement.onpauseonplay
onplay: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9891
Occurs when the play method is requested.
Param
ev
The event.
Inherited from
LitElement.onplayonplaying
onplaying: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9898
Occurs when the audio or video has started playing.
Param
ev
The event.
Inherited from
LitElement.onplayingonpointercancel
onpointercancel: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9900
Inherited from
LitElement.onpointercancelonpointerdown
onpointerdown: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9902
Inherited from
LitElement.onpointerdownonpointerenter
onpointerenter: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9904
Inherited from
LitElement.onpointerenteronpointerleave
onpointerleave: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9906
Inherited from
LitElement.onpointerleaveonpointermove
onpointermove: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9908
Inherited from
LitElement.onpointermoveonpointerout
onpointerout: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9910
Inherited from
LitElement.onpointeroutonpointerover
onpointerover: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9912
Inherited from
LitElement.onpointeroveronpointerup
onpointerup: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9914
Inherited from
LitElement.onpointeruponprogress
onprogress: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9921
Occurs to indicate progress while downloading media data.
Param
ev
The event.
Inherited from
LitElement.onprogressonratechange
onratechange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9928
Occurs when the playback rate is increased or decreased.
Param
ev
The event.
Inherited from
LitElement.onratechangeonreset
onreset: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9935
Fires when the user resets a form.
Param
ev
The event.
Inherited from
LitElement.onresetonresize
onresize: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9937
Inherited from
LitElement.onresizeonscroll
onscroll: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9944
Fires when the user repositions the scroll box in the scroll bar on the object.
Param
ev
The event.
Inherited from
LitElement.onscrollonscrollend
onscrollend: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9946
Inherited from
LitElement.onscrollendonsecuritypolicyviolation
onsecuritypolicyviolation: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9948
Inherited from
LitElement.onsecuritypolicyviolationonseeked
onseeked: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9955
Occurs when the seek operation ends.
Param
ev
The event.
Inherited from
LitElement.onseekedonseeking
onseeking: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9962
Occurs when the current playback position is moved.
Param
ev
The event.
Inherited from
LitElement.onseekingonselect
onselect: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9969
Fires when the current selection changes.
Param
ev
The event.
Inherited from
LitElement.onselectonselectionchange
onselectionchange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9971
Inherited from
LitElement.onselectionchangeonselectstart
onselectstart: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9973
Inherited from
LitElement.onselectstartonslotchange
onslotchange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9975
Inherited from
LitElement.onslotchangeonstalled
onstalled: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9982
Occurs when the download has stopped.
Param
ev
The event.
Inherited from
LitElement.onstalledonsubmit
onsubmit: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9984
Inherited from
LitElement.onsubmitonsuspend
onsuspend: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9991
Occurs if the load operation has been intentionally halted.
Param
ev
The event.
Inherited from
LitElement.onsuspendontimeupdate
ontimeupdate: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:9998
Occurs to indicate the current playback position.
Param
ev
The event.
Inherited from
LitElement.ontimeupdateontoggle
ontoggle: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10000
Inherited from
LitElement.ontoggleontouchcancel?
optional ontouchcancel?: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10002
Inherited from
LitElement.ontouchcancelontouchend?
optional ontouchend?: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10004
Inherited from
LitElement.ontouchendontouchmove?
optional ontouchmove?: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10006
Inherited from
LitElement.ontouchmoveontouchstart?
optional ontouchstart?: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10008
Inherited from
LitElement.ontouchstartontransitioncancel
ontransitioncancel: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10010
Inherited from
LitElement.ontransitioncancelontransitionend
ontransitionend: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10012
Inherited from
LitElement.ontransitionendontransitionrun
ontransitionrun: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10014
Inherited from
LitElement.ontransitionrunontransitionstart
ontransitionstart: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10016
Inherited from
LitElement.ontransitionstartonvolumechange
onvolumechange: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10023
Occurs when the volume is changed, or playback is muted or unmuted.
Param
ev
The event.
Inherited from
LitElement.onvolumechangeonwaiting
onwaiting: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10030
Occurs when playback stops because the next frame of a video resource is not available.
Param
ev
The event.
Inherited from
LitElement.onwaitingonwebkitanimationend
onwebkitanimationend: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10036
Deprecated
This is a legacy alias of onanimationend.
Inherited from
LitElement.onwebkitanimationendonwebkitanimationiteration
onwebkitanimationiteration: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10042
Deprecated
This is a legacy alias of onanimationiteration.
Inherited from
LitElement.onwebkitanimationiterationonwebkitanimationstart
onwebkitanimationstart: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10048
Deprecated
This is a legacy alias of onanimationstart.
Inherited from
LitElement.onwebkitanimationstartonwebkittransitionend
onwebkittransitionend: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10054
Deprecated
This is a legacy alias of ontransitionend.
Inherited from
LitElement.onwebkittransitionendonwheel
onwheel: ((this, ev) => any) | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10056
Inherited from
LitElement.onwheelaccessKey
accessKey: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10704
Inherited from
LitElement.accessKeyaccessKeyLabel
readonly accessKeyLabel: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10706
Inherited from
LitElement.accessKeyLabelautocapitalize
autocapitalize: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10708
Inherited from
LitElement.autocapitalizedir
dir: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10710
Inherited from
LitElement.dirdraggable
draggable: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10712
Inherited from
LitElement.draggablehidden
hidden: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10714
Inherited from
LitElement.hiddeninert
inert: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10716
Inherited from
LitElement.inertinnerText
innerText: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10718
Inherited from
LitElement.innerTextlang
lang: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10720
Inherited from
LitElement.langoffsetHeight
readonly offsetHeight: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10722
Inherited from
LitElement.offsetHeightoffsetLeft
readonly offsetLeft: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10724
Inherited from
LitElement.offsetLeftoffsetParent
readonly offsetParent: Element | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10726
Inherited from
LitElement.offsetParentoffsetTop
readonly offsetTop: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10728
Inherited from
LitElement.offsetTopoffsetWidth
readonly offsetWidth: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10730
Inherited from
LitElement.offsetWidthouterText
outerText: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10732
Inherited from
LitElement.outerTextpopover
popover: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10734
Inherited from
LitElement.popoverspellcheck
spellcheck: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10736
Inherited from
LitElement.spellchecktitle
title: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10738
Inherited from
LitElement.titletranslate
translate: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10740
Inherited from
LitElement.translatewritingSuggestions
writingSuggestions: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10742
Inherited from
LitElement.writingSuggestionsautofocus
autofocus: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:12789
Inherited from
LitElement.autofocusdataset
readonly dataset: DOMStringMap;Defined in: node_modules/typescript/lib/lib.dom.d.ts:12791
Inherited from
LitElement.datasetnonce?
optional nonce?: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:12793
Inherited from
LitElement.noncetabIndex
tabIndex: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:12795
Inherited from
LitElement.tabIndexbaseURI
readonly baseURI: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17027
Returns node's node document's document base URL.
Inherited from
LitElement.baseURIchildNodes
readonly childNodes: NodeListOf<ChildNode>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17033
Returns the children.
Inherited from
LitElement.childNodesfirstChild
readonly firstChild: ChildNode | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17039
Returns the first child.
Inherited from
LitElement.firstChildisConnected
readonly isConnected: boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17045
Returns true if node is connected and false otherwise.
Inherited from
LitElement.isConnectedlastChild
readonly lastChild: ChildNode | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17051
Returns the last child.
Inherited from
LitElement.lastChildnextSibling
readonly nextSibling: ChildNode | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17057
Returns the next sibling.
Inherited from
LitElement.nextSiblingnodeName
readonly nodeName: string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17063
Returns a string appropriate for the type of node.
Inherited from
LitElement.nodeNamenodeType
readonly nodeType: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17069
Returns the type of node.
Inherited from
LitElement.nodeTypenodeValue
nodeValue: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17071
Inherited from
LitElement.nodeValueparentElement
readonly parentElement: HTMLElement | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17083
Returns the parent element.
Inherited from
LitElement.parentElementparentNode
readonly parentNode: ParentNode | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17089
Returns the parent.
Inherited from
LitElement.parentNodepreviousSibling
readonly previousSibling: ChildNode | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17095
Returns the previous sibling.
Inherited from
LitElement.previousSiblingtextContent
textContent: string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17097
Inherited from
LitElement.textContentELEMENT_NODE
readonly ELEMENT_NODE: 1;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17157
node is an element.
Inherited from
LitElement.ELEMENT_NODEATTRIBUTE_NODE
readonly ATTRIBUTE_NODE: 2;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17158
Inherited from
LitElement.ATTRIBUTE_NODETEXT_NODE
readonly TEXT_NODE: 3;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17160
node is a Text node.
Inherited from
LitElement.TEXT_NODECDATA_SECTION_NODE
readonly CDATA_SECTION_NODE: 4;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17162
node is a CDATASection node.
Inherited from
LitElement.CDATA_SECTION_NODEENTITY_REFERENCE_NODE
readonly ENTITY_REFERENCE_NODE: 5;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17163
Inherited from
LitElement.ENTITY_REFERENCE_NODEENTITY_NODE
readonly ENTITY_NODE: 6;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17164
Inherited from
LitElement.ENTITY_NODEPROCESSING_INSTRUCTION_NODE
readonly PROCESSING_INSTRUCTION_NODE: 7;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17166
node is a ProcessingInstruction node.
Inherited from
LitElement.PROCESSING_INSTRUCTION_NODECOMMENT_NODE
readonly COMMENT_NODE: 8;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17168
node is a Comment node.
Inherited from
LitElement.COMMENT_NODEDOCUMENT_NODE
readonly DOCUMENT_NODE: 9;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17170
node is a document.
Inherited from
LitElement.DOCUMENT_NODEDOCUMENT_TYPE_NODE
readonly DOCUMENT_TYPE_NODE: 10;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17172
node is a doctype.
Inherited from
LitElement.DOCUMENT_TYPE_NODEDOCUMENT_FRAGMENT_NODE
readonly DOCUMENT_FRAGMENT_NODE: 11;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17174
node is a DocumentFragment node.
Inherited from
LitElement.DOCUMENT_FRAGMENT_NODENOTATION_NODE
readonly NOTATION_NODE: 12;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17175
Inherited from
LitElement.NOTATION_NODEDOCUMENT_POSITION_DISCONNECTED
readonly DOCUMENT_POSITION_DISCONNECTED: 1;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17177
Set when node and other are not in the same tree.
Inherited from
LitElement.DOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_PRECEDING
readonly DOCUMENT_POSITION_PRECEDING: 2;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17179
Set when other is preceding node.
Inherited from
LitElement.DOCUMENT_POSITION_PRECEDINGDOCUMENT_POSITION_FOLLOWING
readonly DOCUMENT_POSITION_FOLLOWING: 4;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17181
Set when other is following node.
Inherited from
LitElement.DOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_CONTAINS
readonly DOCUMENT_POSITION_CONTAINS: 8;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17183
Set when other is an ancestor of node.
Inherited from
LitElement.DOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_CONTAINED_BY
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17185
Set when other is a descendant of node.
Inherited from
LitElement.DOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17186
Inherited from
LitElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFICnextElementSibling
readonly nextElementSibling: Element | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17307
Returns the first following sibling that is an element, and null otherwise.
Inherited from
LitElement.nextElementSiblingpreviousElementSibling
readonly previousElementSibling: Element | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17313
Returns the first preceding sibling that is an element, and null otherwise.
Inherited from
LitElement.previousElementSiblingchildElementCount
readonly childElementCount: number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17745
Inherited from
LitElement.childElementCountchildren
readonly children: HTMLCollection;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17751
Returns the child elements.
Inherited from
LitElement.childrenfirstElementChild
readonly firstElementChild: Element | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17757
Returns the first child that is an element, and null otherwise.
Inherited from
LitElement.firstElementChildlastElementChild
readonly lastElementChild: Element | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17763
Returns the last child that is an element, and null otherwise.
Inherited from
LitElement.lastElementChildassignedSlot
readonly assignedSlot: HTMLSlotElement | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:22553
Inherited from
LitElement.assignedSlotdev-mode
enabledWarnings?
static optional enabledWarnings?: WarningKind[];Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:205
Read or set all the enabled warning categories for this class.
This property is only used in development builds.
Nocollapse
Inherited from
LitElement.enabledWarningsenableWarning?
static optional enableWarning?: (warningKind) => void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:223
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.enableWarningdisableWarning?
static optional disableWarning?: (warningKind) => void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:241
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.disableWarningproperties
elementProperties
static elementProperties: PropertyDeclarationMap;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:298
Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
LitElement.elementPropertiesproperties
static properties: PropertyDeclarations;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:324
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.propertiesrendering
shadowRootOptions
static shadowRootOptions: ShadowRootInit;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:470
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.shadowRootOptionsrenderRoot
readonly renderRoot: HTMLElement | DocumentFragment;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:491
Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.
Inherited from
LitElement.renderRootrenderOptions
readonly renderOptions: RenderOptions;Defined in: node_modules/lit-element/lit-element.d.ts:88
Inherited from
LitElement.renderOptionsstyles
elementStyles
static elementStyles: CSSResultOrNative[];Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:331
Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
LitElement.elementStylesupdates
isUpdatePending
isUpdatePending: boolean;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:503
True if there is a pending update as a result of calling requestUpdate(). Should only be read.
Inherited from
LitElement.isUpdatePendinghasUpdated
hasUpdated: boolean;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:509
Is set to true after the first update. The element code cannot assume that renderRoot exists before the element hasUpdated.
Inherited from
LitElement.hasUpdatedAccessors
Other
classList
Get Signature
get classList(): DOMTokenList;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8237
Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Returns
DOMTokenList
Set Signature
set classList(value): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8238
Parameters
value
string
Returns
void
Inherited from
LitElement.classListpart
Get Signature
get part(): DOMTokenList;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8283
Returns
DOMTokenList
Set Signature
set part(value): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8284
Parameters
value
string
Returns
void
Inherited from
LitElement.partstyle
Get Signature
get style(): CSSStyleDeclaration;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8500
Returns
CSSStyleDeclaration
Set Signature
set style(cssText): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8501
Parameters
cssText
string
Returns
void
Inherited from
LitElement.styleattributes
observedAttributes
Get Signature
get static observedAttributes(): string[];Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:364
Returns a list of attributes corresponding to the registered properties.
Nocollapse
Returns
string[]
Inherited from
LitElement.observedAttributesupdates
updateComplete
Get Signature
get updateComplete(): Promise<boolean>;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:692
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.updateCompleteMethods
Other
addInitializer()
static addInitializer(initializer): void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:275
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.addInitializerconnectedCallback()
connectedCallback(): void;Defined in: src/controls/StatusBar.ts:78
Called when the component is added to the DOM. Sets up MobX reactions if a viewer is available.
Returns
void
Overrides
LitElement.connectedCallbackdisconnectedCallback()
disconnectedCallback(): void;Defined in: src/controls/StatusBar.ts:89
Called when the component is removed from the DOM. Cleans up MobX reactions to prevent memory leaks.
Returns
void
Overrides
LitElement.disconnectedCallbackupdated()
updated(changedProperties): void;Defined in: src/controls/StatusBar.ts:100
Called when the component's properties change. If the viewer property changes, sets up new reactions to track its state.
Parameters
changedProperties
Map<string, any>
Map of properties that have changed
Returns
void
Overrides
LitElement.updatedsetupReactions()
setupReactions(): void;Defined in: src/controls/StatusBar.ts:117
Sets up MobX reactions to update the UI when viewer state changes. These reactions track changes to:
- Current 3D coordinates (focus point/crosshair position)
- Mouse state information (2D image coordinates and 3D volume coordinates)
- Slice indices (which slices are currently shown)
Returns
void
cleanupReactions()
cleanupReactions(): void;Defined in: src/controls/StatusBar.ts:156
Cleans up all MobX reactions by disposing them. Called when the component is disconnected or when the viewer changes.
Returns
void
render()
render(): TemplateResult<1>;Defined in: src/controls/StatusBar.ts:184
Renders the StatusBar component with five main information sections:
Mouse Position: Shows x,y coordinates within the current slice view These are 2D pixel coordinates from viewer.mouseState.imageCoordinate
Volume Coordinate: Shows x,y,z coordinates in the 3D volume These are volume voxel coordinates from viewer.mouseState.volumeCoordinate Calculated using SliceTransform.sliceToVolumeCoord() to convert from 2D to 3D
World Coordinate: Shows x,y,z coordinates in the original world space These are millimeter coordinates from viewer.mouseState.worldCoordinate Calculated using SliceTransform.sliceToWorldCoord() to convert from 2D to world space
Current Coord: Shows the current position (crosshair location) This is the 3D focus point from viewer.currentCoord Used to synchronize positions across multiple views
Slice Indices: Shows current slice numbers
- For SliceViewer: Single slice index along the viewing axis
- For OrthogonalImageViewer: Slice indices for axial, coronal, and sagittal planes
The display adapts based on the viewer type (single slice vs. orthogonal).
Returns
TemplateResult<1>
Overrides
LitElement.renderanimate()
animate(keyframes, options?): Animation;Defined in: node_modules/typescript/lib/lib.dom.d.ts:2702
Parameters
keyframes
Keyframe[] | PropertyIndexedKeyframes | null
options?
number | KeyframeAnimationOptions
Returns
Animation
Inherited from
LitElement.animategetAnimations()
getAnimations(options?): Animation[];Defined in: node_modules/typescript/lib/lib.dom.d.ts:2704
Parameters
options?
GetAnimationsOptions
Returns
Animation[]
Inherited from
LitElement.getAnimationsafter()
after(...nodes): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:6167
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
LitElement.afterbefore()
before(...nodes): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:6175
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
LitElement.beforeremove()
remove(): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:6181
Removes node.
Returns
void
Inherited from
LitElement.removereplaceWith()
replaceWith(...nodes): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:6189
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
LitElement.replaceWithattachShadow()
attachShadow(init): ShadowRoot;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8322
Creates a shadow root for element and returns it.
Parameters
init
ShadowRootInit
Returns
ShadowRoot
Inherited from
LitElement.attachShadowcheckVisibility()
checkVisibility(options?): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8324
Parameters
options?
CheckVisibilityOptions
Returns
boolean
Inherited from
LitElement.checkVisibilityclosest()
Call Signature
closest<K>(selector): HTMLElementTagNameMap[K] | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8330
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
selector
K
Returns
HTMLElementTagNameMap[K] | null
Inherited from
LitElement.closestCall Signature
closest<K>(selector): SVGElementTagNameMap[K] | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8331
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
selector
K
Returns
SVGElementTagNameMap[K] | null
Inherited from
LitElement.closestCall Signature
closest<K>(selector): MathMLElementTagNameMap[K] | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8332
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
selector
K
Returns
MathMLElementTagNameMap[K] | null
Inherited from
LitElement.closestCall Signature
closest<E>(selectors): E | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8333
Type Parameters
E
E extends Element = Element
Parameters
selectors
string
Returns
E | null
Inherited from
LitElement.closestcomputedStyleMap()
computedStyleMap(): StylePropertyMapReadOnly;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8335
Returns
StylePropertyMapReadOnly
Inherited from
LitElement.computedStyleMapgetAttribute()
getAttribute(qualifiedName): string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8341
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.
Parameters
qualifiedName
string
Returns
string | null
Inherited from
LitElement.getAttributegetAttributeNS()
getAttributeNS(namespace, localName): string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8347
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.
Parameters
namespace
string | null
localName
string
Returns
string | null
Inherited from
LitElement.getAttributeNSgetAttributeNames()
getAttributeNames(): string[];Defined in: node_modules/typescript/lib/lib.dom.d.ts:8353
Returns the qualified names of all element's attributes. Can contain duplicates.
Returns
string[]
Inherited from
LitElement.getAttributeNamesgetAttributeNode()
getAttributeNode(qualifiedName): Attr | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8355
Parameters
qualifiedName
string
Returns
Attr | null
Inherited from
LitElement.getAttributeNodegetAttributeNodeNS()
getAttributeNodeNS(namespace, localName): Attr | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8357
Parameters
namespace
string | null
localName
string
Returns
Attr | null
Inherited from
LitElement.getAttributeNodeNSgetBoundingClientRect()
getBoundingClientRect(): DOMRect;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8359
Returns
DOMRect
Inherited from
LitElement.getBoundingClientRectgetClientRects()
getClientRects(): DOMRectList;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8361
Returns
DOMRectList
Inherited from
LitElement.getClientRectsgetElementsByClassName()
getElementsByClassName(classNames): HTMLCollectionOf<Element>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8367
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.
Parameters
classNames
string
Returns
HTMLCollectionOf<Element>
Inherited from
LitElement.getElementsByClassNamegetElementsByTagName()
Call Signature
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8369
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from
LitElement.getElementsByTagNameCall Signature
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8370
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from
LitElement.getElementsByTagNameCall Signature
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8371
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<MathMLElementTagNameMap[K]>
Inherited from
LitElement.getElementsByTagNameCall Signature
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8373
Type Parameters
K
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from
LitElement.getElementsByTagNameCall Signature
getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8374
Parameters
qualifiedName
string
Returns
HTMLCollectionOf<Element>
Inherited from
LitElement.getElementsByTagNamegetElementsByTagNameNS()
Call Signature
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8376
Parameters
namespaceURI
"http://www.w3.org/1999/xhtml"
localName
string
Returns
HTMLCollectionOf<HTMLElement>
Inherited from
LitElement.getElementsByTagNameNSCall Signature
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8377
Parameters
namespaceURI
"http://www.w3.org/2000/svg"
localName
string
Returns
HTMLCollectionOf<SVGElement>
Inherited from
LitElement.getElementsByTagNameNSCall Signature
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8378
Parameters
namespaceURI
"http://www.w3.org/1998/Math/MathML"
localName
string
Returns
HTMLCollectionOf<MathMLElement>
Inherited from
LitElement.getElementsByTagNameNSCall Signature
getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8379
Parameters
namespace
string | null
localName
string
Returns
HTMLCollectionOf<Element>
Inherited from
LitElement.getElementsByTagNameNSgetHTML()
getHTML(options?): string;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8381
Parameters
options?
GetHTMLOptions
Returns
string
Inherited from
LitElement.getHTMLhasAttribute()
hasAttribute(qualifiedName): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8387
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Parameters
qualifiedName
string
Returns
boolean
Inherited from
LitElement.hasAttributehasAttributeNS()
hasAttributeNS(namespace, localName): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8393
Returns true if element has an attribute whose namespace is namespace and local name is localName.
Parameters
namespace
string | null
localName
string
Returns
boolean
Inherited from
LitElement.hasAttributeNShasAttributes()
hasAttributes(): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8399
Returns true if element has attributes, and false otherwise.
Returns
boolean
Inherited from
LitElement.hasAttributeshasPointerCapture()
hasPointerCapture(pointerId): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8401
Parameters
pointerId
number
Returns
boolean
Inherited from
LitElement.hasPointerCaptureinsertAdjacentElement()
insertAdjacentElement(where, element): Element | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8403
Parameters
where
InsertPosition
element
Element
Returns
Element | null
Inherited from
LitElement.insertAdjacentElementinsertAdjacentHTML()
insertAdjacentHTML(position, string): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8405
Parameters
position
InsertPosition
string
string
Returns
void
Inherited from
LitElement.insertAdjacentHTMLinsertAdjacentText()
insertAdjacentText(where, data): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8407
Parameters
where
InsertPosition
data
string
Returns
void
Inherited from
LitElement.insertAdjacentTextmatches()
matches(selectors): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8413
Returns true if matching selectors against element's root yields element, and false otherwise.
Parameters
selectors
string
Returns
boolean
Inherited from
LitElement.matchesreleasePointerCapture()
releasePointerCapture(pointerId): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8415
Parameters
pointerId
number
Returns
void
Inherited from
LitElement.releasePointerCaptureremoveAttribute()
removeAttribute(qualifiedName): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8421
Removes element's first attribute whose qualified name is qualifiedName.
Parameters
qualifiedName
string
Returns
void
Inherited from
LitElement.removeAttributeremoveAttributeNS()
removeAttributeNS(namespace, localName): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8427
Removes element's attribute whose namespace is namespace and local name is localName.
Parameters
namespace
string | null
localName
string
Returns
void
Inherited from
LitElement.removeAttributeNSremoveAttributeNode()
removeAttributeNode(attr): Attr;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8429
Parameters
attr
Attr
Returns
Attr
Inherited from
LitElement.removeAttributeNoderequestFullscreen()
requestFullscreen(options?): Promise<void>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8437
Displays element fullscreen and resolves promise when done.
When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.
Parameters
options?
FullscreenOptions
Returns
Promise<void>
Inherited from
LitElement.requestFullscreenrequestPointerLock()
requestPointerLock(options?): Promise<void>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8439
Parameters
options?
PointerLockOptions
Returns
Promise<void>
Inherited from
LitElement.requestPointerLockscroll()
Call Signature
scroll(options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8441
Parameters
options?
ScrollToOptions
Returns
void
Inherited from
LitElement.scrollCall Signature
scroll(x, y): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8442
Parameters
x
number
y
number
Returns
void
Inherited from
LitElement.scrollscrollBy()
Call Signature
scrollBy(options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8444
Parameters
options?
ScrollToOptions
Returns
void
Inherited from
LitElement.scrollByCall Signature
scrollBy(x, y): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8445
Parameters
x
number
y
number
Returns
void
Inherited from
LitElement.scrollByscrollIntoView()
scrollIntoView(arg?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8447
Parameters
arg?
boolean | ScrollIntoViewOptions
Returns
void
Inherited from
LitElement.scrollIntoViewscrollTo()
Call Signature
scrollTo(options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8449
Parameters
options?
ScrollToOptions
Returns
void
Inherited from
LitElement.scrollToCall Signature
scrollTo(x, y): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8450
Parameters
x
number
y
number
Returns
void
Inherited from
LitElement.scrollTosetAttribute()
setAttribute(qualifiedName, value): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8456
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
Parameters
qualifiedName
string
value
string
Returns
void
Inherited from
LitElement.setAttributesetAttributeNS()
setAttributeNS(
namespace,
qualifiedName,
value): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8462
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.
Parameters
namespace
string | null
qualifiedName
string
value
string
Returns
void
Inherited from
LitElement.setAttributeNSsetAttributeNode()
setAttributeNode(attr): Attr | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8464
Parameters
attr
Attr
Returns
Attr | null
Inherited from
LitElement.setAttributeNodesetAttributeNodeNS()
setAttributeNodeNS(attr): Attr | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8466
Parameters
attr
Attr
Returns
Attr | null
Inherited from
LitElement.setAttributeNodeNSsetHTMLUnsafe()
setHTMLUnsafe(html): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8468
Parameters
html
string
Returns
void
Inherited from
LitElement.setHTMLUnsafesetPointerCapture()
setPointerCapture(pointerId): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8470
Parameters
pointerId
number
Returns
void
Inherited from
LitElement.setPointerCapturetoggleAttribute()
toggleAttribute(qualifiedName, force?): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8478
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.
Returns true if qualifiedName is now present, and false otherwise.
Parameters
qualifiedName
string
force?
boolean
Returns
boolean
Inherited from
LitElement.toggleAttributewebkitMatchesSelector()
webkitMatchesSelector(selectors): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8484
Parameters
selectors
string
Returns
boolean
Deprecated
This is a legacy alias of matches.
Inherited from
LitElement.webkitMatchesSelectordispatchEvent()
dispatchEvent(event): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:8882
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
event
Event
Returns
boolean
Inherited from
LitElement.dispatchEventattachInternals()
attachInternals(): ElementInternals;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10744
Returns
ElementInternals
Inherited from
LitElement.attachInternalsclick()
click(): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10746
Returns
void
Inherited from
LitElement.clickhidePopover()
hidePopover(): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10748
Returns
void
Inherited from
LitElement.hidePopovershowPopover()
showPopover(): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10750
Returns
void
Inherited from
LitElement.showPopovertogglePopover()
togglePopover(options?): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10752
Parameters
options?
boolean
Returns
boolean
Inherited from
LitElement.togglePopoveraddEventListener()
Call Signature
addEventListener<K>(
type,
listener,
options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10753
Type Parameters
K
K extends keyof HTMLElementEventMap
Parameters
type
K
listener
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
LitElement.addEventListenerCall Signature
addEventListener(
type,
listener,
options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10754
Parameters
type
string
listener
EventListenerOrEventListenerObject
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
LitElement.addEventListenerremoveEventListener()
Call Signature
removeEventListener<K>(
type,
listener,
options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10755
Type Parameters
K
K extends keyof HTMLElementEventMap
Parameters
type
K
listener
(this, ev) => any
options?
boolean | EventListenerOptions
Returns
void
Inherited from
LitElement.removeEventListenerCall Signature
removeEventListener(
type,
listener,
options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:10756
Parameters
type
string
listener
EventListenerOrEventListenerObject
options?
boolean | EventListenerOptions
Returns
void
Inherited from
LitElement.removeEventListenerblur()
blur(): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:12797
Returns
void
Inherited from
LitElement.blurfocus()
focus(options?): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:12799
Parameters
options?
FocusOptions
Returns
void
Inherited from
LitElement.focusappendChild()
appendChild<T>(node): T;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17099
Type Parameters
T
T extends Node
Parameters
node
T
Returns
T
Inherited from
LitElement.appendChildcloneNode()
cloneNode(subtree?): Node;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17105
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Parameters
subtree?
boolean
Returns
Node
Inherited from
LitElement.cloneNodecompareDocumentPosition()
compareDocumentPosition(other): number;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17111
Returns a bitmask indicating the position of other relative to node.
Parameters
other
Node
Returns
number
Inherited from
LitElement.compareDocumentPositioncontains()
contains(other): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17117
Returns true if other is an inclusive descendant of node, and false otherwise.
Parameters
other
Node | null
Returns
boolean
Inherited from
LitElement.containsgetRootNode()
getRootNode(options?): Node;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17123
Returns node's root.
Parameters
options?
GetRootNodeOptions
Returns
Node
Inherited from
LitElement.getRootNodehasChildNodes()
hasChildNodes(): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17129
Returns whether node has children.
Returns
boolean
Inherited from
LitElement.hasChildNodesinsertBefore()
insertBefore<T>(node, child): T;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17131
Type Parameters
T
T extends Node
Parameters
node
T
child
Node | null
Returns
T
Inherited from
LitElement.insertBeforeisDefaultNamespace()
isDefaultNamespace(namespace): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17133
Parameters
namespace
string | null
Returns
boolean
Inherited from
LitElement.isDefaultNamespaceisEqualNode()
isEqualNode(otherNode): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17139
Returns whether node and otherNode have the same properties.
Parameters
otherNode
Node | null
Returns
boolean
Inherited from
LitElement.isEqualNodeisSameNode()
isSameNode(otherNode): boolean;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17141
Parameters
otherNode
Node | null
Returns
boolean
Inherited from
LitElement.isSameNodelookupNamespaceURI()
lookupNamespaceURI(prefix): string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17143
Parameters
prefix
string | null
Returns
string | null
Inherited from
LitElement.lookupNamespaceURIlookupPrefix()
lookupPrefix(namespace): string | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17145
Parameters
namespace
string | null
Returns
string | null
Inherited from
LitElement.lookupPrefixnormalize()
normalize(): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17151
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Returns
void
Inherited from
LitElement.normalizeremoveChild()
removeChild<T>(child): T;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17153
Type Parameters
T
T extends Node
Parameters
child
T
Returns
T
Inherited from
LitElement.removeChildreplaceChild()
replaceChild<T>(node, child): T;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17155
Type Parameters
T
T extends Node
Parameters
node
Node
child
T
Returns
T
Inherited from
LitElement.replaceChildappend()
append(...nodes): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17771
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
LitElement.appendprepend()
prepend(...nodes): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17779
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
LitElement.prependquerySelector()
Call Signature
querySelector<K>(selectors): HTMLElementTagNameMap[K] | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17785
Returns the first element that is a descendant of node that matches selectors.
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
selectors
K
Returns
HTMLElementTagNameMap[K] | null
Inherited from
LitElement.querySelectorCall Signature
querySelector<K>(selectors): SVGElementTagNameMap[K] | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17786
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
selectors
K
Returns
SVGElementTagNameMap[K] | null
Inherited from
LitElement.querySelectorCall Signature
querySelector<K>(selectors): MathMLElementTagNameMap[K] | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17787
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
selectors
K
Returns
MathMLElementTagNameMap[K] | null
Inherited from
LitElement.querySelectorCall Signature
querySelector<K>(selectors): HTMLElementDeprecatedTagNameMap[K] | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17789
Type Parameters
K
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
selectors
K
Returns
HTMLElementDeprecatedTagNameMap[K] | null
Deprecated
Inherited from
LitElement.querySelectorCall Signature
querySelector<E>(selectors): E | null;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17790
Type Parameters
E
E extends Element = Element
Parameters
selectors
string
Returns
E | null
Inherited from
LitElement.querySelectorquerySelectorAll()
Call Signature
querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17796
Returns all element descendants of node that match selectors.
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
selectors
K
Returns
NodeListOf<HTMLElementTagNameMap[K]>
Inherited from
LitElement.querySelectorAllCall Signature
querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17797
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
selectors
K
Returns
NodeListOf<SVGElementTagNameMap[K]>
Inherited from
LitElement.querySelectorAllCall Signature
querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17798
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
selectors
K
Returns
NodeListOf<MathMLElementTagNameMap[K]>
Inherited from
LitElement.querySelectorAllCall Signature
querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17800
Type Parameters
K
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
selectors
K
Returns
NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from
LitElement.querySelectorAllCall Signature
querySelectorAll<E>(selectors): NodeListOf<E>;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17801
Type Parameters
E
E extends Element = Element
Parameters
selectors
string
Returns
NodeListOf<E>
Inherited from
LitElement.querySelectorAllreplaceChildren()
replaceChildren(...nodes): void;Defined in: node_modules/typescript/lib/lib.dom.d.ts:17809
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
LitElement.replaceChildrenattributes
attributeChangedCallback()
attributeChangedCallback(
name,
_old,
value): void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:597
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 responding to attribute changes on MDN for more information about the attributeChangedCallback.
Parameters
name
string
_old
string | null
value
string | null
Returns
void
Inherited from
LitElement.attributeChangedCallbackcontrollers
addController()
addController(controller): void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:542
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.addControllerremoveController()
removeController(controller): void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:547
Removes a ReactiveController from the element.
Parameters
controller
ReactiveController
Returns
void
Inherited from
LitElement.removeControllerproperties
createProperty()
static createProperty(name, options?): void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:391
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.createPropertygetPropertyOptions()
static getPropertyOptions(name): PropertyDeclaration<unknown, unknown>;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:434
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.getPropertyOptionsupdates
requestUpdate()
requestUpdate(
name?,
oldValue?,
options?,
useNewValue?,
newValue?): void;Defined in: node_modules/lit/node_modules/@lit/reactive-element/reactive-element.d.ts:619
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
useNewValue?
boolean
if true, the newValue argument is used instead of reading the property value. This is important to use if the reactive property is a standard private accessor, as opposed to a plain property, since private members can't be dynamically read by name.
newValue?
unknown
the new value of the property. This is only used if useNewValue is true.
Returns
void
Inherited from
LitElement.requestUpdate