SdkMapElement

Extends

LitElement

Constructors

Constructor

new SdkMapElement(): SdkMapElement

Returns

SdkMapElement

Inherited from

LitElement.constructor

attributes

observedAttributes

Get Signature

get static observedAttributes(): string[]

Returns a list of attributes corresponding to the registered properties.

Nocollapse

Returns

string[]

Inherited from

LitElement.observedAttributes

attributeChangedCallback()

attributeChangedCallback(name, _old, value): void

Synchronizes property values when attributes change.

Specifically, when an attribute is set, the corresponding property is set. You should rarely need to implement this callback. If this method is overridden, super.attributeChangedCallback(name, _old, value) must be called.

See responding to attribute changes on MDN for more information about the attributeChangedCallback.

Parameters

Parameter	Type
`name`	`string`
`_old`	`string` \| `null`
`value`	`string` \| `null`

Returns

void

Inherited from

LitElement.attributeChangedCallback

controllers

addController()

addController(controller): void

Registers a ReactiveController to participate in the element's reactive update cycle. The element automatically calls into any registered controllers during its lifecycle callbacks.

If the element is connected when addController() is called, the controller's hostConnected() callback will be immediately called.

Parameters

Parameter	Type
`controller`	`ReactiveController`

Returns

void

Inherited from

LitElement.addController

removeController()

removeController(controller): void

Removes a ReactiveController from the element.

Parameters

Parameter	Type
`controller`	`ReactiveController`

Returns

void

Inherited from

LitElement.removeController

dev-mode

disableWarning?

static optional disableWarning?: (warningKind) => void

Disable the given warning category for this class.

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

// Disable for all ReactiveElement subclasses
ReactiveElement.disableWarning?.('migration');

// Disable for only MyElement and subclasses
MyElement.disableWarning?.('migration');

Parameters

Parameter	Type
`warningKind`	`WarningKind`

Returns

void

Nocollapse

Inherited from

LitElement.disableWarning

enabledWarnings?

static optional enabledWarnings?: WarningKind[]

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

This property is only used in development builds.

Nocollapse

Inherited from

LitElement.enabledWarnings

enableWarning?

static optional enableWarning?: (warningKind) => void

Enable the given warning category for this class.

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

// Enable for all ReactiveElement subclasses
ReactiveElement.enableWarning?.('migration');

// Enable for only MyElement and subclasses
MyElement.enableWarning?.('migration');

Parameters

Parameter	Type
`warningKind`	`WarningKind`

Returns

void

Nocollapse

Inherited from

LitElement.enableWarning

lifecycle

connectedCallback()

connectedCallback(): void

Invoked when the component is added to the document's DOM.

In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

connectedCallback() {
  super.connectedCallback();
  addEventListener('keydown', this._handleKeydown);
}

Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

Returns

void

Inherited from

LitElement.connectedCallback

disconnectedCallback()

disconnectedCallback(): void

Invoked when the component is removed from the document's DOM.

This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

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

An element may be re-connected after being disconnected.

Returns

void

Inherited from

LitElement.disconnectedCallback

Other

accessKey

accessKey: string

The HTMLElement.accessKey property sets the keystroke which a user can press to jump to a given element.

MDN Reference

Inherited from

LitElement.accessKey

accessKeyLabel

readonly accessKeyLabel: string

The HTMLElement.accessKeyLabel read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.

MDN Reference

Inherited from

LitElement.accessKeyLabel

ariaActiveDescendantElement

ariaActiveDescendantElement: Element | null

MDN Reference

Inherited from

LitElement.ariaActiveDescendantElement

ariaAtomic

ariaAtomic: string | null

MDN Reference

Inherited from

LitElement.ariaAtomic

ariaAutoComplete

ariaAutoComplete: string | null

MDN Reference

Inherited from

LitElement.ariaAutoComplete

ariaBrailleLabel

ariaBrailleLabel: string | null

MDN Reference

Inherited from

LitElement.ariaBrailleLabel

ariaBrailleRoleDescription

ariaBrailleRoleDescription: string | null

MDN Reference

Inherited from

LitElement.ariaBrailleRoleDescription

ariaBusy

ariaBusy: string | null

MDN Reference

Inherited from

LitElement.ariaBusy

ariaChecked

ariaChecked: string | null

MDN Reference

Inherited from

LitElement.ariaChecked

ariaColCount

ariaColCount: string | null

MDN Reference

Inherited from

LitElement.ariaColCount

ariaColIndex

ariaColIndex: string | null

MDN Reference

Inherited from

LitElement.ariaColIndex

ariaColIndexText

ariaColIndexText: string | null

MDN Reference

Inherited from

LitElement.ariaColIndexText

ariaColSpan

ariaColSpan: string | null

MDN Reference

Inherited from

LitElement.ariaColSpan

ariaControlsElements

ariaControlsElements: readonly Element[] | null

MDN Reference

Inherited from

LitElement.ariaControlsElements

ariaCurrent

ariaCurrent: string | null

MDN Reference

Inherited from

LitElement.ariaCurrent

ariaDescribedByElements

ariaDescribedByElements: readonly Element[] | null

MDN Reference

Inherited from

LitElement.ariaDescribedByElements

ariaDescription

ariaDescription: string | null

MDN Reference

Inherited from

LitElement.ariaDescription

ariaDetailsElements

ariaDetailsElements: readonly Element[] | null

MDN Reference

Inherited from

LitElement.ariaDetailsElements

ariaDisabled

ariaDisabled: string | null

MDN Reference

Inherited from

LitElement.ariaDisabled

ariaErrorMessageElements

ariaErrorMessageElements: readonly Element[] | null

MDN Reference

Inherited from

LitElement.ariaErrorMessageElements

ariaExpanded

ariaExpanded: string | null

MDN Reference

Inherited from

LitElement.ariaExpanded

ariaFlowToElements

ariaFlowToElements: readonly Element[] | null

MDN Reference

Inherited from

LitElement.ariaFlowToElements

ariaHasPopup

ariaHasPopup: string | null

MDN Reference

Inherited from

LitElement.ariaHasPopup

ariaHidden

ariaHidden: string | null

MDN Reference

Inherited from

LitElement.ariaHidden

ariaInvalid

ariaInvalid: string | null

MDN Reference

Inherited from

LitElement.ariaInvalid

ariaKeyShortcuts

ariaKeyShortcuts: string | null

MDN Reference

Inherited from

LitElement.ariaKeyShortcuts

ariaLabel

ariaLabel: string | null

MDN Reference

Inherited from

LitElement.ariaLabel

ariaLabelledByElements

ariaLabelledByElements: readonly Element[] | null

MDN Reference

Inherited from

LitElement.ariaLabelledByElements

ariaLevel

ariaLevel: string | null

MDN Reference

Inherited from

LitElement.ariaLevel

ariaLive

ariaLive: string | null

MDN Reference

Inherited from

LitElement.ariaLive

ariaModal

ariaModal: string | null

MDN Reference

Inherited from

LitElement.ariaModal

ariaMultiLine

ariaMultiLine: string | null

MDN Reference

Inherited from

LitElement.ariaMultiLine

ariaMultiSelectable

ariaMultiSelectable: string | null

MDN Reference

Inherited from

LitElement.ariaMultiSelectable

ariaOrientation

ariaOrientation: string | null

MDN Reference

Inherited from

LitElement.ariaOrientation

ariaOwnsElements

ariaOwnsElements: readonly Element[] | null

MDN Reference

Inherited from

LitElement.ariaOwnsElements

ariaPlaceholder

ariaPlaceholder: string | null

MDN Reference

Inherited from

LitElement.ariaPlaceholder

ariaPosInSet

ariaPosInSet: string | null

MDN Reference

Inherited from

LitElement.ariaPosInSet

ariaPressed

ariaPressed: string | null

MDN Reference

Inherited from

LitElement.ariaPressed

ariaReadOnly

ariaReadOnly: string | null

MDN Reference

Inherited from

LitElement.ariaReadOnly

ariaRelevant

ariaRelevant: string | null

MDN Reference

Inherited from

LitElement.ariaRelevant

ariaRequired

ariaRequired: string | null

MDN Reference

Inherited from

LitElement.ariaRequired

ariaRoleDescription

ariaRoleDescription: string | null

MDN Reference

Inherited from

LitElement.ariaRoleDescription

ariaRowCount

ariaRowCount: string | null

MDN Reference

Inherited from

LitElement.ariaRowCount

ariaRowIndex

ariaRowIndex: string | null

MDN Reference

Inherited from

LitElement.ariaRowIndex

ariaRowIndexText

ariaRowIndexText: string | null

MDN Reference

Inherited from

LitElement.ariaRowIndexText

ariaRowSpan

ariaRowSpan: string | null

MDN Reference

Inherited from

LitElement.ariaRowSpan

ariaSelected

ariaSelected: string | null

MDN Reference

Inherited from

LitElement.ariaSelected

ariaSetSize

ariaSetSize: string | null

MDN Reference

Inherited from

LitElement.ariaSetSize

ariaSort

ariaSort: string | null

MDN Reference

Inherited from

LitElement.ariaSort

ariaValueMax

ariaValueMax: string | null

MDN Reference

Inherited from

LitElement.ariaValueMax

ariaValueMin

ariaValueMin: string | null

MDN Reference

Inherited from

LitElement.ariaValueMin

ariaValueNow

ariaValueNow: string | null

MDN Reference

Inherited from

LitElement.ariaValueNow

ariaValueText

ariaValueText: string | null

MDN Reference

Inherited from

LitElement.ariaValueText

assignedSlot

readonly assignedSlot: HTMLSlotElement | null

MDN Reference

Inherited from

LitElement.assignedSlot

ATTRIBUTE_NODE

readonly ATTRIBUTE_NODE: 2

Inherited from

LitElement.ATTRIBUTE_NODE

attributes

readonly attributes: NamedNodeMap

The Element.attributes property returns a live collection of all attribute nodes registered to the specified node. It is a NamedNodeMap, not an Array, so it has no Array methods and the Attr nodes' indexes may differ among browsers. To be more specific, attributes is a key/value pair of strings that represents any information regarding that attribute.

MDN Reference

Inherited from

LitElement.attributes

attributeStyleMap

readonly attributeStyleMap: StylePropertyMap

MDN Reference

Inherited from

LitElement.attributeStyleMap

autocapitalize

autocapitalize: string

The autocapitalize property of the HTMLElement interface represents the element's capitalization behavior for user input. It is available on all HTML elements, though it doesn't affect all of them, including:

MDN Reference

Inherited from

LitElement.autocapitalize

autocorrect

autocorrect: boolean

The autocorrect property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.

MDN Reference

Inherited from

LitElement.autocorrect

autofocus

autofocus: boolean

MDN Reference

Inherited from

LitElement.autofocus

baseURI

readonly baseURI: string

The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.

MDN Reference

Inherited from

LitElement.baseURI

CDATA_SECTION_NODE

readonly CDATA_SECTION_NODE: 4

node is a CDATASection node.

Inherited from

LitElement.CDATA_SECTION_NODE

childElementCount

readonly childElementCount: number

MDN Reference

Inherited from

LitElement.childElementCount

childNodes

readonly childNodes: NodeListOf<ChildNode>

The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments.

MDN Reference

Inherited from

LitElement.childNodes

children

readonly children: HTMLCollection

Returns the child elements.

MDN Reference

Inherited from

LitElement.children

className

className: string

The className property of the Element interface gets and sets the value of the class attribute of the specified element.

MDN Reference

Inherited from

LitElement.className

clientHeight

readonly clientHeight: number

The clientHeight read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels. It includes padding but excludes borders, margins, and horizontal scrollbars (if present).

MDN Reference

Inherited from

LitElement.clientHeight

clientLeft

readonly clientLeft: number

The clientLeft read-only property of the Element interface returns the width of the left border of an element in pixels. It includes the width of the vertical scrollbar if the text direction of the element is right-to-left and if there is an overflow causing a left vertical scrollbar to be rendered. clientLeft does not include the left margin or the left padding.

MDN Reference

Inherited from

LitElement.clientLeft

clientTop

readonly clientTop: number

The clientTop read-only property of the Element interface returns the width of the top border of an element in pixels.

MDN Reference

Inherited from

LitElement.clientTop

clientWidth

readonly clientWidth: number

The clientWidth read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels. It includes padding but excludes borders, margins, and vertical scrollbars (if present).

MDN Reference

Inherited from

LitElement.clientWidth

COMMENT_NODE

readonly COMMENT_NODE: 8

node is a Comment node.

Inherited from

LitElement.COMMENT_NODE

contentEditable

contentEditable: string

MDN Reference

Inherited from

LitElement.contentEditable

currentCSSZoom

readonly currentCSSZoom: number

The currentCSSZoom read-only property of the Element interface provides the "effective" CSS zoom of an element, taking into account the zoom applied to the element and all its parent elements.

MDN Reference

Inherited from

LitElement.currentCSSZoom

customElementRegistry

readonly customElementRegistry: CustomElementRegistry | null

Inherited from

LitElement.customElementRegistry

dataset

readonly dataset: DOMStringMap

MDN Reference

Inherited from

LitElement.dataset

dir

dir: string

The HTMLElement.dir property indicates the text writing directionality of the content of the current element. It reflects the element's dir attribute.

MDN Reference

Inherited from

LitElement.dir

DOCUMENT_FRAGMENT_NODE

readonly DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

Inherited from

LitElement.DOCUMENT_FRAGMENT_NODE

DOCUMENT_NODE

readonly DOCUMENT_NODE: 9

node is a document.

Inherited from

LitElement.DOCUMENT_NODE

DOCUMENT_POSITION_CONTAINED_BY

readonly DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

Inherited from

LitElement.DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINS

readonly DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

Inherited from

LitElement.DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_DISCONNECTED

readonly DOCUMENT_POSITION_DISCONNECTED: 1

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

Inherited from

LitElement.DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_FOLLOWING

readonly DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

Inherited from

LitElement.DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

Inherited from

LitElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_PRECEDING

readonly DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

Inherited from

LitElement.DOCUMENT_POSITION_PRECEDING

DOCUMENT_TYPE_NODE

readonly DOCUMENT_TYPE_NODE: 10

node is a doctype.

Inherited from

LitElement.DOCUMENT_TYPE_NODE

draggable

draggable: boolean

The draggable property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.

MDN Reference

Inherited from

LitElement.draggable

ELEMENT_NODE

readonly ELEMENT_NODE: 1

node is an element.

Inherited from

LitElement.ELEMENT_NODE

enterKeyHint

enterKeyHint: string

MDN Reference

Inherited from

LitElement.enterKeyHint

ENTITY_NODE

readonly ENTITY_NODE: 6

Inherited from

LitElement.ENTITY_NODE

ENTITY_REFERENCE_NODE

readonly ENTITY_REFERENCE_NODE: 5

Inherited from

LitElement.ENTITY_REFERENCE_NODE

firstChild

readonly firstChild: ChildNode | null

The read-only firstChild property of the Node interface returns the node's first child in the tree, or null if the node has no children.

MDN Reference

Inherited from

LitElement.firstChild

firstElementChild

readonly firstElementChild: Element | null

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

MDN Reference

Inherited from

LitElement.firstElementChild

hidden

hidden: boolean | "until-found"

The HTMLElement property hidden reflects the value of the element's hidden attribute.

MDN Reference

Inherited from

LitElement.hidden

id

id: string

The id property of the Element interface represents the element's identifier, reflecting the id global attribute.

MDN Reference

Inherited from

LitElement.id

inert

inert: boolean

The HTMLElement property inert reflects the value of the element's inert attribute. It is a boolean value that, when present, makes the browser "ignore" user input events for the element, including focus events and events from assistive technologies. The browser may also ignore page search and text selection in the element. This can be useful when building UIs such as modals where you would want to "trap" the focus inside the modal when it's visible.

MDN Reference

Inherited from

LitElement.inert

innerHTML

innerHTML: string

The innerHTML property of the Element interface gets or sets the HTML or XML markup contained within the element, omitting any shadow roots in both cases.

MDN Reference

Inherited from

LitElement.innerHTML

innerText

innerText: string

The innerText property of the HTMLElement interface represents the rendered text content of a node and its descendants.

MDN Reference

Inherited from

LitElement.innerText

inputMode

inputMode: string

MDN Reference

Inherited from

LitElement.inputMode

isConnected

readonly isConnected: boolean

The read-only isConnected property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.

MDN Reference

Inherited from

LitElement.isConnected

isContentEditable

readonly isContentEditable: boolean

MDN Reference

Inherited from

LitElement.isContentEditable

lang

lang: string

The lang property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a BCP 47 language tag. It reflects the element's lang attribute; the xml:lang attribute does not affect this property.

MDN Reference

Inherited from

LitElement.lang

lastChild

readonly lastChild: ChildNode | null

The read-only lastChild property of the Node interface returns the last child of the node, or null if there are no child nodes.

MDN Reference

Inherited from

LitElement.lastChild

lastElementChild

readonly lastElementChild: Element | null

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

MDN Reference

Inherited from

LitElement.lastElementChild

localName

readonly localName: string

The Element.localName read-only property returns the local part of the qualified name of an element.

MDN Reference

Inherited from

LitElement.localName

namespaceURI

readonly namespaceURI: string | null

The Element.namespaceURI read-only property returns the namespace URI of the element, or null if the element is not in a namespace.

MDN Reference

Inherited from

LitElement.namespaceURI

nextElementSibling

readonly nextElementSibling: Element | null

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

MDN Reference

Inherited from

LitElement.nextElementSibling

nextSibling

readonly nextSibling: ChildNode | null

The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent's childNodes, or returns null if the specified node is the last child in the parent element.

MDN Reference

Inherited from

LitElement.nextSibling

nodeName

readonly nodeName: string

The read-only nodeName property of Node returns the name of the current node as a string.

MDN Reference

Inherited from

LitElement.nodeName

nodeType

readonly nodeType: number

The read-only nodeType property of a Node interface is an integer that identifies what the node is. It distinguishes different kinds of nodes from each other, such as elements, text, and comments.

MDN Reference

Inherited from

LitElement.nodeType

nodeValue

nodeValue: string | null

The nodeValue property of the Node interface returns or sets the value of the current node.

MDN Reference

Inherited from

LitElement.nodeValue

nonce

nonce: string

MDN Reference

Inherited from

LitElement.nonce

NOTATION_NODE

readonly NOTATION_NODE: 12

Inherited from

LitElement.NOTATION_NODE

offsetHeight

readonly offsetHeight: number

The offsetHeight read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.

MDN Reference

Inherited from

LitElement.offsetHeight

offsetLeft

readonly offsetLeft: number

The offsetLeft read-only property of the HTMLElement interface returns the number of pixels that the upper left corner of the current element is offset to the left within the HTMLElement.offsetParent node.

MDN Reference

Inherited from

LitElement.offsetLeft

offsetParent

readonly offsetParent: Element | null

The HTMLElement.offsetParent read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.

MDN Reference

Inherited from

LitElement.offsetParent

offsetTop

readonly offsetTop: number

The offsetTop read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the offsetParent, the closest positioned ancestor element.

MDN Reference

Inherited from

LitElement.offsetTop

offsetWidth

readonly offsetWidth: number

The offsetWidth read-only property of the HTMLElement interface returns the layout width of an element as an integer.

MDN Reference

Inherited from

LitElement.offsetWidth

onabort

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

MDN Reference

Inherited from

LitElement.onabort

onanimationcancel

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

MDN Reference

Inherited from

LitElement.onanimationcancel

onanimationend

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

MDN Reference

Inherited from

LitElement.onanimationend

onanimationiteration

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

MDN Reference

Inherited from

LitElement.onanimationiteration

onanimationstart

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

MDN Reference

Inherited from

LitElement.onanimationstart

onauxclick

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

MDN Reference

Inherited from

LitElement.onauxclick

onbeforeinput

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

MDN Reference

Inherited from

LitElement.onbeforeinput

onbeforematch

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

MDN Reference

Inherited from

LitElement.onbeforematch

onbeforetoggle

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

MDN Reference

Inherited from

LitElement.onbeforetoggle

onblur

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

MDN Reference

Inherited from

LitElement.onblur

oncancel

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

MDN Reference

Inherited from

LitElement.oncancel

oncanplay

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

MDN Reference

Inherited from

LitElement.oncanplay

oncanplaythrough

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

MDN Reference

Inherited from

LitElement.oncanplaythrough

onchange

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

MDN Reference

Inherited from

LitElement.onchange

onclick

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

MDN Reference

Inherited from

LitElement.onclick

onclose

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

MDN Reference

Inherited from

LitElement.onclose

oncommand

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

MDN Reference

Inherited from

LitElement.oncommand

oncontextlost

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

MDN Reference

Inherited from

LitElement.oncontextlost

oncontextmenu

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

MDN Reference

Inherited from

LitElement.oncontextmenu

oncontextrestored

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

MDN Reference

Inherited from

LitElement.oncontextrestored

oncopy

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

MDN Reference

Inherited from

LitElement.oncopy

oncuechange

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

MDN Reference

Inherited from

LitElement.oncuechange

oncut

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

MDN Reference

Inherited from

LitElement.oncut

ondblclick

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

MDN Reference

Inherited from

LitElement.ondblclick

ondrag

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

MDN Reference

Inherited from

LitElement.ondrag

ondragend

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

MDN Reference

Inherited from

LitElement.ondragend

ondragenter

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

MDN Reference

Inherited from

LitElement.ondragenter

ondragleave

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

MDN Reference

Inherited from

LitElement.ondragleave

ondragover

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

MDN Reference

Inherited from

LitElement.ondragover

ondragstart

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

MDN Reference

Inherited from

LitElement.ondragstart

ondrop

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

MDN Reference

Inherited from

LitElement.ondrop

ondurationchange

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

MDN Reference

Inherited from

LitElement.ondurationchange

onemptied

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

MDN Reference

Inherited from

LitElement.onemptied

onended

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

MDN Reference

Inherited from

LitElement.onended

onerror

onerror: OnErrorEventHandler

MDN Reference

Inherited from

LitElement.onerror

onfocus

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

MDN Reference

Inherited from

LitElement.onfocus

onformdata

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

MDN Reference

Inherited from

LitElement.onformdata

onfullscreenchange

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

MDN Reference

Inherited from

LitElement.onfullscreenchange

onfullscreenerror

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

MDN Reference

Inherited from

LitElement.onfullscreenerror

ongotpointercapture

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

MDN Reference

Inherited from

LitElement.ongotpointercapture

oninput

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

MDN Reference

Inherited from

LitElement.oninput

oninvalid

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

MDN Reference

Inherited from

LitElement.oninvalid

onkeydown

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

MDN Reference

Inherited from

LitElement.onkeydown

onkeypress

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

Deprecated

MDN Reference

Inherited from

LitElement.onkeypress

onkeyup

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

MDN Reference

Inherited from

LitElement.onkeyup

onload

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

MDN Reference

Inherited from

LitElement.onload

onloadeddata

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

MDN Reference

Inherited from

LitElement.onloadeddata

onloadedmetadata

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

MDN Reference

Inherited from

LitElement.onloadedmetadata

onloadstart

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

MDN Reference

Inherited from

LitElement.onloadstart

onlostpointercapture

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

MDN Reference

Inherited from

LitElement.onlostpointercapture

onmousedown

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

MDN Reference

Inherited from

LitElement.onmousedown

onmouseenter

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

MDN Reference

Inherited from

LitElement.onmouseenter

onmouseleave

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

MDN Reference

Inherited from

LitElement.onmouseleave

onmousemove

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

MDN Reference

Inherited from

LitElement.onmousemove

onmouseout

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

MDN Reference

Inherited from

LitElement.onmouseout

onmouseover

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

MDN Reference

Inherited from

LitElement.onmouseover

onmouseup

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

MDN Reference

Inherited from

LitElement.onmouseup

onpaste

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

MDN Reference

Inherited from

LitElement.onpaste

onpause

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

MDN Reference

Inherited from

LitElement.onpause

onplay

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

MDN Reference

Inherited from

LitElement.onplay

onplaying

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

MDN Reference

Inherited from

LitElement.onplaying

onpointercancel

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

MDN Reference

Inherited from

LitElement.onpointercancel

onpointerdown

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

MDN Reference

Inherited from

LitElement.onpointerdown

onpointerenter

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

MDN Reference

Inherited from

LitElement.onpointerenter

onpointerleave

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

MDN Reference

Inherited from

LitElement.onpointerleave

onpointermove

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

MDN Reference

Inherited from

LitElement.onpointermove

onpointerout

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

MDN Reference

Inherited from

LitElement.onpointerout

onpointerover

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

MDN Reference

Inherited from

LitElement.onpointerover

onpointerrawupdate

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

Available only in secure contexts.

MDN Reference

Inherited from

LitElement.onpointerrawupdate

onpointerup

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

MDN Reference

Inherited from

LitElement.onpointerup

onprogress

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

MDN Reference

Inherited from

LitElement.onprogress

onratechange

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

MDN Reference

Inherited from

LitElement.onratechange

onreset

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

MDN Reference

Inherited from

LitElement.onreset

onresize

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

MDN Reference

Inherited from

LitElement.onresize

onscroll

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

MDN Reference

Inherited from

LitElement.onscroll

onscrollend

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

MDN Reference

Inherited from

LitElement.onscrollend

onsecuritypolicyviolation

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

MDN Reference

Inherited from

LitElement.onsecuritypolicyviolation

onseeked

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

MDN Reference

Inherited from

LitElement.onseeked

onseeking

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

MDN Reference

Inherited from

LitElement.onseeking

onselect

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

MDN Reference

Inherited from

LitElement.onselect

onselectionchange

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

MDN Reference

Inherited from

LitElement.onselectionchange

onselectstart

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

MDN Reference

Inherited from

LitElement.onselectstart

onslotchange

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

MDN Reference

Inherited from

LitElement.onslotchange

onstalled

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

MDN Reference

Inherited from

LitElement.onstalled

onsubmit

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

MDN Reference

Inherited from

LitElement.onsubmit

onsuspend

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

MDN Reference

Inherited from

LitElement.onsuspend

ontimeupdate

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

MDN Reference

Inherited from

LitElement.ontimeupdate

ontoggle

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

MDN Reference

Inherited from

LitElement.ontoggle

ontouchcancel?

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

MDN Reference

Inherited from

LitElement.ontouchcancel

ontouchend?

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

MDN Reference

Inherited from

LitElement.ontouchend

ontouchmove?

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

MDN Reference

Inherited from

LitElement.ontouchmove

ontouchstart?

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

MDN Reference

Inherited from

LitElement.ontouchstart

ontransitioncancel

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

MDN Reference

Inherited from

LitElement.ontransitioncancel

ontransitionend

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

MDN Reference

Inherited from

LitElement.ontransitionend

ontransitionrun

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

MDN Reference

Inherited from

LitElement.ontransitionrun

ontransitionstart

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

MDN Reference

Inherited from

LitElement.ontransitionstart

onvolumechange

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

MDN Reference

Inherited from

LitElement.onvolumechange

onwaiting

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

MDN Reference

Inherited from

LitElement.onwaiting

onwebkitanimationend

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

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

Inherited from

LitElement.onwebkitanimationend

onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

Inherited from

LitElement.onwebkitanimationiteration

onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

Inherited from

LitElement.onwebkitanimationstart

onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

Inherited from

LitElement.onwebkittransitionend

onwheel

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

MDN Reference

Inherited from

LitElement.onwheel

outerHTML

outerHTML: string

The outerHTML attribute of the Element interface gets or sets the HTML or XML markup of the element and its descendants, omitting any shadow roots in both cases.

MDN Reference

Inherited from

LitElement.outerHTML

outerText

outerText: string

The outerText property of the HTMLElement interface returns the same value as HTMLElement.innerText. When used as a setter it replaces the whole current node with the given text (this differs from innerText, which replaces the content inside the current node).

MDN Reference

Inherited from

LitElement.outerText

ownerDocument

readonly ownerDocument: Document

The read-only ownerDocument property of the Node interface returns the top-level document object of the node.

MDN Reference

Inherited from

LitElement.ownerDocument

parentElement

readonly parentElement: HTMLElement | null

The read-only parentElement property of Node interface returns the DOM node's parent Element, or null if the node either has no parent, or its parent isn't a DOM Element. Node.parentNode on the other hand returns any kind of parent, regardless of its type.

MDN Reference

Inherited from

LitElement.parentElement

parentNode

readonly parentNode: ParentNode | null

The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.

MDN Reference

Inherited from

LitElement.parentNode

popover: string | null

The popover property of the HTMLElement interface gets and sets an element's popover state via JavaScript ("auto", "hint", or "manual"), and can be used for feature detection.

MDN Reference

Inherited from

LitElement.popover

prefix

readonly prefix: string | null

The Element.prefix read-only property returns the namespace prefix of the specified element, or null if no prefix is specified.

MDN Reference

Inherited from

LitElement.prefix

previousElementSibling

readonly previousElementSibling: Element | null

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

MDN Reference

Inherited from

LitElement.previousElementSibling

previousSibling

readonly previousSibling: ChildNode | null

The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's childNodes list, or null if the specified node is the first in that list.

MDN Reference

Inherited from

LitElement.previousSibling

PROCESSING_INSTRUCTION_NODE

readonly PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

Inherited from

LitElement.PROCESSING_INSTRUCTION_NODE

role

role: string | null

MDN Reference

Inherited from

LitElement.role

scrollHeight

readonly scrollHeight: number

The scrollHeight read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.

MDN Reference

Inherited from

LitElement.scrollHeight

scrollLeft

scrollLeft: number

The scrollLeft property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge. This value is subpixel precise in modern browsers, meaning that it isn't necessarily a whole number.

MDN Reference

Inherited from

LitElement.scrollLeft

scrollTop

scrollTop: number

The scrollTop property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge. This value is subpixel precise in modern browsers, meaning that it isn't necessarily a whole number.

MDN Reference

Inherited from

LitElement.scrollTop

scrollWidth

readonly scrollWidth: number

The scrollWidth read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.

MDN Reference

Inherited from

LitElement.scrollWidth

shadowRoot

readonly shadowRoot: ShadowRoot | null

The Element.shadowRoot read-only property represents the shadow root hosted by the element.

MDN Reference

Inherited from

LitElement.shadowRoot

slot

slot: string

The slot property of the Element interface returns the name of the shadow DOM slot the element is inserted in.

MDN Reference

Inherited from

LitElement.slot

spellcheck

spellcheck: boolean

The spellcheck property of the HTMLElement interface represents a boolean value that controls the spell-checking hint. It is available on all HTML elements, though it doesn't affect all of them.

MDN Reference

Inherited from

LitElement.spellcheck

tabIndex

tabIndex: number

MDN Reference

Inherited from

LitElement.tabIndex

tagName

readonly tagName: string

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

Inherited from

LitElement.tagName

TEXT_NODE

readonly TEXT_NODE: 3

node is a Text node.

Inherited from

LitElement.TEXT_NODE

title

title: string

The HTMLElement.title property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.

MDN Reference

Inherited from

LitElement.title

translate

translate: boolean

The translate property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.

MDN Reference

Inherited from

LitElement.translate

writingSuggestions

writingSuggestions: string

The writingSuggestions property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.

MDN Reference

Inherited from

LitElement.writingSuggestions

_$litElement$

static _$litElement$: boolean

Inherited from

LitElement._$litElement$

_initializers?

static optional _initializers?: Initializer[]

Inherited from

LitElement._initializers

[metadata]

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

Inherited from

LitElement.[metadata]

finalized

protected static finalized: true | undefined

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

classList

Get Signature

get classList(): DOMTokenList

The read-only classList property of the Element interface contains a live DOMTokenList collection representing the class attribute of the element. This can then be used to manipulate the class list.

MDN Reference

Returns

DOMTokenList

Set Signature

set classList(value): void

Parameters

Parameter	Type
`value`	`string`

Returns

void

Inherited from

LitElement.classList

context

mapElement

olMap

Get Signature

get olMap(): Map | null

Returns

Map | null

part

Get Signature

get part(): DOMTokenList

The read-only part property of the Element interface contains a DOMTokenList object representing the part identifier(s) of the element. It reflects the element's part content attribute. These can be used to style parts of a shadow DOM, via the ::part pseudo-element.

MDN Reference

Returns

DOMTokenList

Set Signature

set part(value): void

Parameters

Parameter	Type
`value`	`string`

Returns

void

Inherited from

LitElement.part

style

Get Signature

get style(): CSSStyleDeclaration

MDN Reference

Returns

CSSStyleDeclaration

Set Signature

set style(cssText): void

Parameters

Parameter	Type
`cssText`	`string`

Returns

void

Inherited from

LitElement.style

textContent

Get Signature

get textContent(): string

MDN Reference

Returns

string

Set Signature

set textContent(value): void

The textContent property of the Node interface represents the text content of the node and its descendants.

MDN Reference

Parameters

Parameter	Type
`value`	`string` \| `null`

Returns

void

Inherited from

LitElement.textContent

addEventListener()

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementEventMap`

Parameters

Parameter	Type
`type`	`K`
`listener`	(`this`, `ev`) => `any`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

LitElement.addEventListener

Call Signature

addEventListener(type, listener, options?): void

Parameters

Parameter	Type
`type`	`string`
`listener`	`EventListenerOrEventListenerObject`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

LitElement.addEventListener

after()

after(...nodes): void

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

LitElement.after

animate()

animate(keyframes, options?): Animation

MDN Reference

Parameters

Parameter	Type
`keyframes`	`Keyframe`[] \| `PropertyIndexedKeyframes` \| `null`
`options?`	`number` \| `KeyframeAnimationOptions`

Returns

Animation

Inherited from

LitElement.animate

append()

append(...nodes): void

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

LitElement.append

appendChild()

appendChild<T>(node): T

The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`T`

Returns

T

Inherited from

LitElement.appendChild

attachInternals()

attachInternals(): ElementInternals

The HTMLElement.attachInternals() method returns an ElementInternals object. This method allows a custom element to participate in HTML forms. The ElementInternals interface provides utilities for working with these elements in the same way you would work with any standard HTML form element, and also exposes the Accessibility Object Model to the element.

MDN Reference

Returns

ElementInternals

Inherited from

LitElement.attachInternals

attachShadow()

attachShadow(init): ShadowRoot

The Element.attachShadow() method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.

MDN Reference

Parameters

Parameter	Type
`init`	`ShadowRootInit`

Returns

ShadowRoot

Inherited from

LitElement.attachShadow

before()

before(...nodes): void

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

LitElement.before

blur()

blur(): void

MDN Reference

Returns

void

Inherited from

LitElement.blur

checkVisibility()

checkVisibility(options?): boolean

The checkVisibility() method of the Element interface checks whether the element is visible.

MDN Reference

Parameters

Parameter	Type
`options?`	`CheckVisibilityOptions`

Returns

boolean

Inherited from

LitElement.checkVisibility

click()

click(): void

The HTMLElement.click() method simulates a mouse click on an element. When called on an element, the element's click event is fired (unless its disabled attribute is set).

MDN Reference

Returns

void

Inherited from

LitElement.click

cloneNode()

cloneNode(subtree?): Node

The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in the node is also cloned or not.

MDN Reference

Parameters

Parameter	Type
`subtree?`	`boolean`

Returns

Node

Inherited from

LitElement.cloneNode

closest()

Call Signature

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

The closest() method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.

MDN Reference

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`selector`	`K`

Returns

HTMLElementTagNameMap[K] | null

Inherited from

LitElement.closest

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`selector`	`K`

Returns

SVGElementTagNameMap[K] | null

Inherited from

LitElement.closest

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`selector`	`K`

Returns

MathMLElementTagNameMap[K] | null

Inherited from

LitElement.closest

Call Signature

closest<E>(selectors): E | null

Type Parameters

Type Parameter	Default type
`E` extends `Element`	`Element`

Parameters

Parameter	Type
`selectors`	`string`

Returns

E | null

Inherited from

LitElement.closest

compareDocumentPosition()

compareDocumentPosition(other): number

The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.

MDN Reference

Parameters

Parameter	Type
`other`	`Node`

Returns

number

Inherited from

LitElement.compareDocumentPosition

computedStyleMap()

computedStyleMap(): StylePropertyMapReadOnly

The computedStyleMap() method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.

MDN Reference

Returns

StylePropertyMapReadOnly

Inherited from

LitElement.computedStyleMap

contains()

contains(other): boolean

The contains() method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (childNodes), one of the children's direct children, and so on.

MDN Reference

Parameters

Parameter	Type
`other`	`Node` \| `null`

Returns

boolean

Inherited from

LitElement.contains

contextHasChanged()

contextHasChanged(value, oldValue): void

Parameters

Parameter	Type
`value`	`MapContext` \| `undefined`
`oldValue`	`MapContext`

Returns

void

dispatchEvent()

dispatchEvent(event): boolean

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference

Parameters

Parameter	Type
`event`	`Event`

Returns

boolean

Inherited from

LitElement.dispatchEvent

focus()

focus(options?): void

MDN Reference

Parameters

Parameter	Type
`options?`	`FocusOptions`

Returns

void

Inherited from

LitElement.focus

getAnimations()

getAnimations(options?): Animation[]

MDN Reference

Parameters

Parameter	Type
`options?`	`GetAnimationsOptions`

Returns

Animation[]

Inherited from

LitElement.getAnimations

getAttribute()

getAttribute(qualifiedName): string | null

The getAttribute() method of the Element interface returns the value of a specified attribute on the element.

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

string | null

Inherited from

LitElement.getAttribute

getAttributeNames()

getAttributeNames(): string[]

The getAttributeNames() method of the Element interface returns the attribute names of the element as an Array of strings. If the element has no attributes it returns an empty array.

MDN Reference

Returns

string[]

Inherited from

LitElement.getAttributeNames

getAttributeNode()

getAttributeNode(qualifiedName): Attr | null

Returns the specified attribute of the specified element, as an Attr node.

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

Attr | null

Inherited from

LitElement.getAttributeNode

getAttributeNodeNS()

getAttributeNodeNS(namespace, localName): Attr | null

The getAttributeNodeNS() method of the Element interface returns the namespaced Attr node of an element.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`
`localName`	`string`

Returns

Attr | null

Inherited from

LitElement.getAttributeNodeNS

getAttributeNS()

getAttributeNS(namespace, localName): string | null

The getAttributeNS() method of the Element interface returns the string value of the attribute with the specified namespace and name. If the named attribute does not exist, the value returned will either be null or "" (the empty string); see Notes for details.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`
`localName`	`string`

Returns

string | null

Inherited from

LitElement.getAttributeNS

getBoundingClientRect()

getBoundingClientRect(): DOMRect

The Element.getBoundingClientRect() method returns a DOMRect object providing information about the size of an element and its position relative to the viewport.

MDN Reference

Returns

DOMRect

Inherited from

LitElement.getBoundingClientRect

getClientRects()

getClientRects(): DOMRectList

The getClientRects() method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.

MDN Reference

Returns

DOMRectList

Inherited from

LitElement.getClientRects

getElementsByClassName()

getElementsByClassName(classNames): HTMLCollectionOf<Element>

The Element method getElementsByClassName() returns a live HTMLCollection which contains every descendant element which has the specified class name or names.

MDN Reference

Parameters

Parameter	Type
`classNames`	`string`

Returns

HTMLCollectionOf<Element>

Inherited from

LitElement.getElementsByClassName

getElementsByTagName()

Call Signature

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

The Element.getElementsByTagName() method returns a live HTMLCollection of elements with the given tag name.

MDN Reference

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf<HTMLElementTagNameMap[K]>

Inherited from

LitElement.getElementsByTagName

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf<SVGElementTagNameMap[K]>

Inherited from

LitElement.getElementsByTagName

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf<MathMLElementTagNameMap[K]>

Inherited from

LitElement.getElementsByTagName

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementDeprecatedTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated

Inherited from

LitElement.getElementsByTagName

Call Signature

getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

HTMLCollectionOf<Element>

Inherited from

LitElement.getElementsByTagName

getElementsByTagNameNS()

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

The Element.getElementsByTagNameNS() method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace. It is similar to Document.getElementsByTagNameNS, except that its search is restricted to descendants of the specified element.

MDN Reference

Parameters

Parameter	Type
`namespaceURI`	`"http://www.w3.org/1999/xhtml"`
`localName`	`string`

Returns

HTMLCollectionOf<HTMLElement>

Inherited from

LitElement.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

Parameters

Parameter	Type
`namespaceURI`	`"http://www.w3.org/2000/svg"`
`localName`	`string`

Returns

HTMLCollectionOf<SVGElement>

Inherited from

LitElement.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>

Parameters

Parameter	Type
`namespaceURI`	`"http://www.w3.org/1998/Math/MathML"`
`localName`	`string`

Returns

HTMLCollectionOf<MathMLElement>

Inherited from

LitElement.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

Parameters

Parameter	Type
`namespace`	`string` \| `null`
`localName`	`string`

Returns

HTMLCollectionOf<Element>

Inherited from

LitElement.getElementsByTagNameNS

getHTML()

getHTML(options?): string

The getHTML() method of the Element interface is used to serialize an element's DOM to an HTML string.

MDN Reference

Parameters

Parameter	Type
`options?`	`GetHTMLOptions`

Returns

string

Inherited from

LitElement.getHTML

getRootNode()

getRootNode(options?): Node

The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.

MDN Reference

Parameters

Parameter	Type
`options?`	`GetRootNodeOptions`

Returns

Node

Inherited from

LitElement.getRootNode

hasAttribute()

hasAttribute(qualifiedName): boolean

The Element.hasAttribute() method returns a Boolean value indicating whether the specified element has the specified attribute or not.

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

boolean

Inherited from

LitElement.hasAttribute

hasAttributeNS()

hasAttributeNS(namespace, localName): boolean

The hasAttributeNS() method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`
`localName`	`string`

Returns

boolean

Inherited from

LitElement.hasAttributeNS

hasAttributes()

hasAttributes(): boolean

The hasAttributes() method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.

MDN Reference

Returns

boolean

Inherited from

LitElement.hasAttributes

hasChildNodes()

hasChildNodes(): boolean

The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.

MDN Reference

Returns

boolean

Inherited from

LitElement.hasChildNodes

hasPointerCapture()

hasPointerCapture(pointerId): boolean

The hasPointerCapture() method of the Element interface checks whether the element on which it is invoked has pointer capture for the pointer identified by the given pointer ID.

MDN Reference

Parameters

Parameter	Type
`pointerId`	`number`

Returns

boolean

Inherited from

LitElement.hasPointerCapture

hidePopover()

hidePopover(): void

The hidePopover() method of the HTMLElement interface hides a popover element (i.e., one that has a valid popover attribute) by removing it from the top layer and styling it with display: none.

MDN Reference

Returns

void

Inherited from

LitElement.hidePopover

insertAdjacentElement()

insertAdjacentElement(where, element): Element | null

The insertAdjacentElement() method of the Element interface inserts a given element node at a given position relative to the element it is invoked upon.

MDN Reference

Parameters

Parameter	Type
`where`	`InsertPosition`
`element`	`Element`

Returns

Element | null

Inherited from

LitElement.insertAdjacentElement

insertAdjacentHTML()

insertAdjacentHTML(position, string): void

The insertAdjacentHTML() method of the Element interface parses the specified input as HTML or XML and inserts the resulting nodes into the DOM tree at a specified position.

MDN Reference

Parameters

Parameter	Type
`position`	`InsertPosition`
`string`	`string`

Returns

void

Inherited from

LitElement.insertAdjacentHTML

insertAdjacentText()

insertAdjacentText(where, data): void

The insertAdjacentText() method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.

MDN Reference

Parameters

Parameter	Type
`where`	`InsertPosition`
`data`	`string`

Returns

void

Inherited from

LitElement.insertAdjacentText

insertBefore()

insertBefore<T>(node, child): T

The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`T`
`child`	`Node` \| `null`

Returns

T

Inherited from

LitElement.insertBefore

isDefaultNamespace()

isDefaultNamespace(namespace): boolean

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument. It returns a boolean value that is true if the namespace is the default namespace on the given node and false if not. The default namespace can be retrieved with Node.lookupNamespaceURI() by passing null as the argument.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`

Returns

boolean

Inherited from

LitElement.isDefaultNamespace

isEqualNode()

isEqualNode(otherNode): boolean

The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes.

MDN Reference

Parameters

Parameter	Type
`otherNode`	`Node` \| `null`

Returns

boolean

Inherited from

LitElement.isEqualNode

isSameNode()

isSameNode(otherNode): boolean

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).

MDN Reference

Parameters

Parameter	Type
`otherNode`	`Node` \| `null`

Returns

boolean

Inherited from

LitElement.isSameNode

lookupNamespaceURI()

lookupNamespaceURI(prefix): string | null

The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and null if not). This method's existence allows Node objects to be passed as a namespace resolver to XPathEvaluator.createExpression() and XPathEvaluator.evaluate().

MDN Reference

Parameters

Parameter	Type
`prefix`	`string` \| `null`

Returns

string | null

Inherited from

LitElement.lookupNamespaceURI

lookupPrefix()

lookupPrefix(namespace): string | null

The lookupPrefix() method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`

Returns

string | null

Inherited from

LitElement.lookupPrefix

matches()

Call Signature

matches<K>(selectors): this is HTMLElementTagNameMap[K]

The matches() method of the Element interface tests whether the element would be selected by the specified CSS selector.

MDN Reference

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

this is HTMLElementTagNameMap[K]

Inherited from

LitElement.matches

Call Signature

matches<K>(selectors): this is SVGElementTagNameMap[K]

Type Parameters

Type Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

this is SVGElementTagNameMap[K]

Inherited from

LitElement.matches

Call Signature

matches<K>(selectors): this is MathMLElementTagNameMap[K]

Type Parameters

Type Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

this is MathMLElementTagNameMap[K]

Inherited from

LitElement.matches

Call Signature

matches(selectors): boolean

Parameters

Parameter	Type
`selectors`	`string`

Returns

boolean

Inherited from

LitElement.matches

moveBefore()

moveBefore(node, child): void

MDN Reference

Parameters

Parameter	Type
`node`	`Node`
`child`	`Node` \| `null`

Returns

void

Inherited from

LitElement.moveBefore

normalize()

normalize(): void

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.

MDN Reference

Returns

void

Inherited from

LitElement.normalize

prepend()

prepend(...nodes): void

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

LitElement.prepend

querySelector()

Call Signature

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

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

MDN Reference

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

HTMLElementTagNameMap[K] | null

Inherited from

LitElement.querySelector

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

SVGElementTagNameMap[K] | null

Inherited from

LitElement.querySelector

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

MathMLElementTagNameMap[K] | null

Inherited from

LitElement.querySelector

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementDeprecatedTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

HTMLElementDeprecatedTagNameMap[K] | null

Deprecated

Inherited from

LitElement.querySelector

Call Signature

querySelector<E>(selectors): E | null

Type Parameters

Type Parameter	Default type
`E` extends `Element`	`Element`

Parameters

Parameter	Type
`selectors`	`string`

Returns

E | null

Inherited from

LitElement.querySelector

querySelectorAll()

Call Signature

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

Returns all element descendants of node that match selectors.

MDN Reference

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf<HTMLElementTagNameMap[K]>

Inherited from

LitElement.querySelectorAll

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf<SVGElementTagNameMap[K]>

Inherited from

LitElement.querySelectorAll

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf<MathMLElementTagNameMap[K]>

Inherited from

LitElement.querySelectorAll

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementDeprecatedTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated

Inherited from

LitElement.querySelectorAll

Call Signature

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

Type Parameters

Type Parameter	Default type
`E` extends `Element`	`Element`

Parameters

Parameter	Type
`selectors`	`string`

Returns

NodeListOf<E>

Inherited from

LitElement.querySelectorAll

releasePointerCapture()

releasePointerCapture(pointerId): void

The releasePointerCapture() method of the Element interface releases (stops) pointer capture that was previously set for a specific (PointerEvent) pointer.

MDN Reference

Parameters

Parameter	Type
`pointerId`	`number`

Returns

void

Inherited from

LitElement.releasePointerCapture

remove()

remove(): void

Removes node.

MDN Reference

Returns

void

Inherited from

LitElement.remove

removeAttribute()

removeAttribute(qualifiedName): void

The Element method removeAttribute() removes the attribute with the specified name from the element.

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

void

Inherited from

LitElement.removeAttribute

removeAttributeNode()

removeAttributeNode(attr): Attr

The removeAttributeNode() method of the Element interface removes the specified Attr node from the element.

MDN Reference

Parameters

Parameter	Type
`attr`	`Attr`

Returns

Attr

Inherited from

LitElement.removeAttributeNode

removeAttributeNS()

removeAttributeNS(namespace, localName): void

The removeAttributeNS() method of the Element interface removes the specified attribute with the specified namespace from an element.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`
`localName`	`string`

Returns

void

Inherited from

LitElement.removeAttributeNS

removeChild()

removeChild<T>(child): T

The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`child`	`T`

Returns

T

Inherited from

LitElement.removeChild

removeEventListener()

Call Signature

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

Type Parameters

Type Parameter
`K` extends keyof `HTMLElementEventMap`

Parameters

Parameter	Type
`type`	`K`
`listener`	(`this`, `ev`) => `any`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

LitElement.removeEventListener

Call Signature

removeEventListener(type, listener, options?): void

Parameters

Parameter	Type
`type`	`string`
`listener`	`EventListenerOrEventListenerObject`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

LitElement.removeEventListener

replaceChild()

replaceChild<T>(node, child): T

The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`Node`
`child`	`T`

Returns

T

Inherited from

LitElement.replaceChild

replaceChildren()

replaceChildren(...nodes): void

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

LitElement.replaceChildren

replaceWith()

replaceWith(...nodes): void

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

LitElement.replaceWith

requestFullscreen()

requestFullscreen(options?): Promise<void>

The Element.requestFullscreen() method issues an asynchronous request to make the element be displayed in fullscreen mode.

MDN Reference

Parameters

Parameter	Type
`options?`	`FullscreenOptions`

Returns

Promise<void>

Inherited from

LitElement.requestFullscreen

requestPointerLock()

requestPointerLock(options?): Promise<void>

The requestPointerLock() method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.

MDN Reference

Parameters

Parameter	Type
`options?`	`PointerLockOptions`

Returns

Promise<void>

Inherited from

LitElement.requestPointerLock

scroll()

Call Signature

scroll(options?): void

The scroll() method of the Element interface scrolls the element to a particular set of coordinates inside a given element.

MDN Reference

Parameters

Parameter	Type
`options?`	`ScrollToOptions`

Returns

void

Inherited from

LitElement.scroll

Call Signature

scroll(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

LitElement.scroll

scrollBy()

Call Signature

scrollBy(options?): void

The scrollBy() method of the Element interface scrolls an element by the given amount.

MDN Reference

Parameters

Parameter	Type
`options?`	`ScrollToOptions`

Returns

void

Inherited from

LitElement.scrollBy

Call Signature

scrollBy(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

LitElement.scrollBy

scrollIntoView()

scrollIntoView(arg?): void

The Element interface's scrollIntoView() method scrolls the element's ancestor containers such that the element on which scrollIntoView() is called is visible to the user.

MDN Reference

Parameters

Parameter	Type
`arg?`	`boolean` \| `ScrollIntoViewOptions`

Returns

void

Inherited from

LitElement.scrollIntoView

scrollTo()

Call Signature

scrollTo(options?): void

The scrollTo() method of the Element interface scrolls to a particular set of coordinates inside a given element.

MDN Reference

Parameters

Parameter	Type
`options?`	`ScrollToOptions`

Returns

void

Inherited from

LitElement.scrollTo

Call Signature

scrollTo(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

LitElement.scrollTo

setAttribute()

setAttribute(qualifiedName, value): void

The setAttribute() method of the Element interface sets the value of an attribute on the specified element. If the attribute already exists, the value is updated; otherwise a new attribute is added with the specified name and value.

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`
`value`	`string`

Returns

void

Inherited from

LitElement.setAttribute

setAttributeNode()

setAttributeNode(attr): Attr | null

The setAttributeNode() method of the Element interface adds a new Attr node to the specified element.

MDN Reference

Parameters

Parameter	Type
`attr`	`Attr`

Returns

Attr | null

Inherited from

LitElement.setAttributeNode

setAttributeNodeNS()

setAttributeNodeNS(attr): Attr | null

The setAttributeNodeNS() method of the Element interface adds a new namespaced Attr node to an element.

MDN Reference

Parameters

Parameter	Type
`attr`	`Attr`

Returns

Attr | null

Inherited from

LitElement.setAttributeNodeNS

setAttributeNS()

setAttributeNS(namespace, qualifiedName, value): void

The setAttributeNS() method of the Element interface adds a new attribute or changes the value of an attribute with the given namespace and name.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`
`qualifiedName`	`string`
`value`	`string`

Returns

void

Inherited from

LitElement.setAttributeNS

setHTMLUnsafe()

setHTMLUnsafe(html): void

The setHTMLUnsafe() method of the Element interface is used to parse HTML input into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.

MDN Reference

Parameters

Parameter	Type
`html`	`string`

Returns

void

Inherited from

LitElement.setHTMLUnsafe

setPointerCapture()

setPointerCapture(pointerId): void

The setPointerCapture() method of the Element interface is used to designate a specific element as the capture target of future pointer events. Subsequent events for the pointer will be targeted at the capture element until capture is released (via Element.releasePointerCapture() or the pointerup event is fired).

MDN Reference

Parameters

Parameter	Type
`pointerId`	`number`

Returns

void

Inherited from

LitElement.setPointerCapture

showPopover()

showPopover(options?): void

The showPopover() method of the HTMLElement interface shows a popover element (i.e., one that has a valid popover attribute) by adding it to the top layer.

MDN Reference

Parameters

Parameter	Type
`options?`	`ShowPopoverOptions`

Returns

void

Inherited from

LitElement.showPopover

toggleAttribute()

toggleAttribute(qualifiedName, force?): boolean

The toggleAttribute() method of the Element interface toggles a Boolean attribute (removing it if it is present and adding it if it is not present) on the given element.

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`
`force?`	`boolean`

Returns

boolean

Inherited from

LitElement.toggleAttribute

togglePopover()

togglePopover(options?): boolean

The togglePopover() method of the HTMLElement interface toggles a popover element (i.e., one that has a valid popover attribute) between the hidden and showing states.

MDN Reference

Parameters

Parameter	Type
`options?`	`boolean` \| `TogglePopoverOptions`

Returns

boolean

Inherited from

LitElement.togglePopover

webkitMatchesSelector()

webkitMatchesSelector(selectors): boolean

Parameters

Parameter	Type
`selectors`	`string`

Returns

boolean

Deprecated

This is a legacy alias of matches.

MDN Reference

Inherited from

LitElement.webkitMatchesSelector

addInitializer()

static addInitializer(initializer): void

Adds an initializer function to the class that is called during instance construction.

This is useful for code that runs against a ReactiveElement subclass, such as a decorator, that needs to do work for each instance, such as setting up a ReactiveController.

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

Parameter	Type
`initializer`	`Initializer`

Returns

void

Nocollapse

Inherited from

LitElement.addInitializer

finalize()

protected static finalize(): void

Finishes setting up the class so that it's ready to be registered as a custom element and instantiated.

This method is called by the ReactiveElement.observedAttributes getter. If you override the observedAttributes getter, you must either call super.observedAttributes to trigger finalization, or call finalize() yourself.

Returns

void

Nocollapse

Inherited from

LitElement.finalize

properties

elementProperties

static elementProperties: PropertyDeclarationMap

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

Nocollapse

Inherited from

LitElement.elementProperties

properties

static properties: PropertyDeclarations

User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.

By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.

Generally, properties that are changed by the element should be private or protected fields and should use the state: true option. Properties marked as state do not reflect from the corresponding attribute

However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked property when clicked and fires a changed event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.

Nocollapse

Inherited from

LitElement.properties

createProperty()

static createProperty(name, options?): void

Creates a property accessor on the element prototype if one does not exist and stores a PropertyDeclaration for the property with the given options. The property setter calls the property's hasChanged property option or uses a strict identity check to determine whether or not to request an update.

This method may be overridden to customize properties; however, when doing so, it's important to call super.createProperty to ensure the property is setup correctly. This method calls getPropertyDescriptor internally to get a descriptor to install. To customize what properties do when they are get or set, override getPropertyDescriptor. To customize the options for a property, implement createProperty like this:

static createProperty(name, options) {
  options = Object.assign(options, {myOption: true});
  super.createProperty(name, options);
}

Parameters

Parameter	Type
`name`	`PropertyKey`
`options?`	`PropertyDeclaration`<`unknown`, `unknown`>

Returns

void

Nocollapse

Inherited from

LitElement.createProperty

getPropertyDescriptor()

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

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

Parameter	Type
`name`	`PropertyKey`
`key`	`string` \| `symbol`
`options`	`PropertyDeclaration`

Returns

PropertyDescriptor | undefined

Nocollapse

Inherited from

LitElement.getPropertyDescriptor

getPropertyOptions()

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

Returns the property options associated with the given property. These options are defined with a PropertyDeclaration via the properties object or the @property decorator and are registered in createProperty(...).

Note, this method should be considered "final" and not overridden. To customize the options for a given property, override createProperty.

Parameters

Parameter	Type
`name`	`PropertyKey`

Returns

PropertyDeclaration<unknown, unknown>

Nocollapse

Final

Inherited from

LitElement.getPropertyOptions

rendering

renderOptions

readonly renderOptions: RenderOptions

Inherited from

LitElement.renderOptions

renderRoot

readonly renderRoot: HTMLElement | DocumentFragment

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

Inherited from

LitElement.renderRoot

shadowRootOptions

static shadowRootOptions: ShadowRootInit

Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.

Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.

Nocollapse

Inherited from

LitElement.shadowRootOptions

createRenderRoot()

protected createRenderRoot(): SdkMapElement

Returns

SdkMapElement

Overrides

LitElement.createRenderRoot

render()

render(): TemplateResult<1>

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult<1>

Overrides

LitElement.render

styles

elementStyles

static elementStyles: CSSResultOrNative[]

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

Nocollapse

Inherited from

LitElement.elementStyles

styles

static styles: CSSResult

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

html

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

Nocollapse

Overrides

LitElement.styles

finalizeStyles()

protected static finalizeStyles(styles?): CSSResultOrNative[]

Takes the styles the user supplied via the static styles property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.

Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.

Parameters

Parameter	Type
`styles?`	`CSSResultGroup`

Returns

CSSResultOrNative[]

Nocollapse

Inherited from

LitElement.finalizeStyles

updates

hasUpdated

hasUpdated: boolean

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

Inherited from

LitElement.hasUpdated

isUpdatePending

isUpdatePending: boolean

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>

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

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

Parameter	Type
`_requestedUpdate`	`boolean`

Returns

void

Inherited from

LitElement.enableUpdating

firstUpdated()

firstUpdated(): Promise<void>

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

Promise<void>

Overrides

LitElement.firstUpdated

getUpdateComplete()

protected getUpdateComplete(): Promise<boolean>

Override point for the updateComplete promise.

It is not safe to override the updateComplete getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:

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

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?, useNewValue?, newValue?): void

Requests an update which is processed asynchronously. This should be called when an element should update based on some state not triggered by setting a reactive property. In this case, pass no arguments. It should also be called when manually implementing a property setter. In this case, pass the property name and oldValue to ensure that any configured property options are honored.

Parameters

Parameter	Type	Description
`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

scheduleUpdate()

protected scheduleUpdate(): void | Promise<unknown>

Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate() must be called.

For instance, to schedule updates to occur just before the next frame:

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

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

Parameter	Type	Description
`_changedProperties`	`PropertyValueMap`<`any`> \| `Map`<`PropertyKey`, `unknown`>	Map of changed properties with old values

Returns

boolean

Inherited from

LitElement.shouldUpdate

update()

protected update(changedProperties): void

Updates the element. This method reflects property values to attributes and calls render to render DOM via lit-html. Setting properties inside this method will not trigger another update.

Parameters

Parameter	Type	Description
`changedProperties`	`PropertyValueMap`<`any`> \| `Map`<`PropertyKey`, `unknown`>	Map of changed properties with old values

Returns

void

Inherited from

LitElement.update

updated()

updated(changedProperties): Promise<void>

Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters

Parameter	Type
`changedProperties`	`PropertyValueMap`<`SdkMapElement`>

Returns

Promise<void>

Overrides

LitElement.updated

willUpdate()

protected willUpdate(_changedProperties): void

Invoked before update() to compute values needed during the update.

Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.

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

Parameter	Type
`_changedProperties`	`PropertyValueMap`<`any`> \| `Map`<`PropertyKey`, `unknown`>

Returns

void

Inherited from

LitElement.willUpdate

SdkMapElement ​

Extends ​

Constructors ​

Constructor ​

Returns ​

Inherited from ​

attributes ​

observedAttributes ​

Get Signature ​

Nocollapse ​

Returns ​

Inherited from ​

attributeChangedCallback() ​

Parameters ​

Returns ​

Inherited from ​

controllers ​

addController() ​

Parameters ​

Returns ​

Inherited from ​

removeController() ​

Parameters ​

Returns ​

Inherited from ​

dev-mode ​

disableWarning? ​

Parameters ​

Returns ​

Nocollapse ​

Inherited from ​

enabledWarnings? ​

Nocollapse ​

Inherited from ​

enableWarning? ​

Parameters ​

Returns ​

Nocollapse ​

Inherited from ​

lifecycle ​

connectedCallback() ​

Returns ​

Inherited from ​

disconnectedCallback() ​

Returns ​

Inherited from ​

Other ​

accessKey ​

Inherited from ​

accessKeyLabel ​

Inherited from ​

ariaActiveDescendantElement ​

Inherited from ​

ariaAtomic ​

Inherited from ​

ariaAutoComplete ​

Inherited from ​

ariaBrailleLabel ​

Inherited from ​

ariaBrailleRoleDescription ​

Inherited from ​

ariaBusy ​

Inherited from ​

ariaChecked ​

Inherited from ​

ariaColCount ​

Inherited from ​

ariaColIndex ​

Inherited from ​

ariaColIndexText ​

Inherited from ​

ariaColSpan ​

Inherited from ​

ariaControlsElements ​

Inherited from ​

ariaCurrent ​

Inherited from ​

ariaDescribedByElements ​

Inherited from ​

ariaDescription ​

SdkMapElement

Extends

Constructors

Constructor

Returns

Inherited from

attributes

observedAttributes

Get Signature

Nocollapse

Returns

Inherited from

attributeChangedCallback()

Parameters

Returns

Inherited from

controllers

addController()

Parameters

Returns

Inherited from

removeController()

Parameters

Returns

Inherited from

dev-mode

disableWarning?

Parameters

Returns

Nocollapse

Inherited from

enabledWarnings?

Nocollapse

Inherited from

enableWarning?

Parameters

Returns

Nocollapse

Inherited from

lifecycle

connectedCallback()

Returns

Inherited from

disconnectedCallback()

Returns

Inherited from

Other

accessKey

Inherited from

accessKeyLabel

Inherited from

ariaActiveDescendantElement

Inherited from

ariaAtomic

Inherited from

ariaAutoComplete

Inherited from

ariaBrailleLabel

Inherited from

ariaBrailleRoleDescription

Inherited from

ariaBusy

Inherited from

ariaChecked

Inherited from

ariaColCount

Inherited from

ariaColIndex

Inherited from

ariaColIndexText

Inherited from

ariaColSpan

Inherited from

ariaControlsElements

Inherited from

ariaCurrent

Inherited from

ariaDescribedByElements

Inherited from

ariaDescription