Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapElement

Available only in the v=beta channel: https://goo.gle/3oAthT3.

MapElement is an HTMLElement subclass for rendering maps. After loading the maps library, a map can be created in HTML. For example: 

<gmp-map
center="37.4220656,-122.0840897" zoom="10"
map-id="DEMO_MAP_ID">
  <button
slot="control-block-start-inline-end">Custom
Control</button>
</gmp-map>

Internally, it uses google.maps.Map, which can be accessed with the innerMap property.

Access by calling const {MapElement} = await google.maps.importLibrary("maps"). See https://developers.google.com/maps/documentation/javascript/libraries.

Hierarchy

  • HTMLElement
    • MapElement

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Available only in the v=beta channel: https://goo.gle/3oAthT3.

    MapElement is an HTMLElement subclass for rendering maps. After loading the maps library, a map can be created in HTML. For example: 

    <gmp-map
center="37.4220656,-122.0840897" zoom="10"
map-id="DEMO_MAP_ID">
      <button
slot="control-block-start-inline-end">Custom
Control</button>
    </gmp-map>

    Internally, it uses google.maps.Map, which can be accessed with the innerMap property.

    Access by calling const {MapElement} = await google.maps.importLibrary("maps"). See https://developers.google.com/maps/documentation/javascript/libraries.

    Parameters

    Returns MapElement

Properties

Readonly ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: number

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

Readonly NOTATION_NODE

NOTATION_NODE: number

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

Readonly accessKeyLabel

accessKeyLabel: string

ariaAtomic

ariaAtomic: string

ariaAutoComplete

ariaAutoComplete: string

ariaBusy

ariaBusy: string

ariaChecked

ariaChecked: string

ariaColCount

ariaColCount: string

ariaColIndex

ariaColIndex: string

ariaColSpan

ariaColSpan: string

ariaCurrent

ariaCurrent: string

ariaDisabled

ariaDisabled: string

ariaExpanded

ariaExpanded: string

ariaHasPopup

ariaHasPopup: string

ariaHidden

ariaHidden: string

ariaKeyShortcuts

ariaKeyShortcuts: string

ariaLabel

ariaLabel: string

ariaLevel

ariaLevel: string

ariaLive

ariaLive: string

ariaModal

ariaModal: string

ariaMultiLine

ariaMultiLine: string

ariaMultiSelectable

ariaMultiSelectable: string

ariaOrientation

ariaOrientation: string

ariaPlaceholder

ariaPlaceholder: string

ariaPosInSet

ariaPosInSet: string

ariaPressed

ariaPressed: string

ariaReadOnly

ariaReadOnly: string

ariaRequired

ariaRequired: string

ariaRoleDescription

ariaRoleDescription: string

ariaRowCount

ariaRowCount: string

ariaRowIndex

ariaRowIndex: string

ariaRowSpan

ariaRowSpan: string

ariaSelected

ariaSelected: string

ariaSetSize

ariaSetSize: string

ariaSort

ariaSort: string

ariaValueMax

ariaValueMax: string

ariaValueMin

ariaValueMin: string

ariaValueNow

ariaValueNow: string

ariaValueText

ariaValueText: string

Readonly assignedSlot

assignedSlot: null | HTMLSlotElement

Readonly attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

Readonly baseURI

baseURI: string

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

center

center: null | LatLng | LatLngLiteral

The center latitude/longitude of the map.

Readonly childElementCount

childElementCount: number

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

Readonly children

children: HTMLCollection

Returns the child elements.

Readonly classList

classList: DOMTokenList

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

className

className: string

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

Readonly clientHeight

clientHeight: number

Readonly clientLeft

clientLeft: number

Readonly clientTop

clientTop: number

Readonly clientWidth

clientWidth: number

contentEditable

contentEditable: string

Readonly dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

enterKeyHint

enterKeyHint: string

Readonly firstChild

firstChild: null | ChildNode

Returns the first child.

Readonly firstElementChild

firstElementChild: null | Element

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

hidden

hidden: boolean

id

id: string

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

innerHTML

innerHTML: string

innerMap

innerMap: Map

A reference to the google.maps.Map that the MapElement uses internally.

innerText

innerText: string

inputMode

inputMode: string

Optional inputmask

inputmask?: Instance

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

Readonly isContentEditable

isContentEditable: boolean

lang

lang: string

Readonly lastChild

lastChild: null | ChildNode

Returns the last child.

Readonly lastElementChild

lastElementChild: null | Element

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

Readonly localName

localName: string

Returns the local name.

mapId

mapId: null | string

The Map ID of the map. See the Map ID documentation for more information.

Readonly namespaceURI

namespaceURI: null | string

Returns the namespace.

Readonly nextElementSibling

nextElementSibling: null | Element

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

Readonly nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

Readonly nodeName

nodeName: string

Returns a string appropriate for the type of node.

Readonly nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: null | string

Optional nonce

nonce?: string

Readonly offsetHeight

offsetHeight: number

Readonly offsetLeft

offsetLeft: number

Readonly offsetParent

offsetParent: null | Element

Readonly offsetTop

offsetTop: number

Readonly offsetWidth

offsetWidth: number

onabort

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

Fires when the user aborts the download.

param ev

The event.

onanimationcancel

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

onanimationend

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

onanimationiteration

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

onanimationstart

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

onauxclick

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

onblur

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

Fires when the object loses the input focus.

param ev

The focus event.

oncanplay

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

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

param ev

The event.

oncanplaythrough

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

onchange

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

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

param ev

The event.

onclick

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

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

param ev

The mouse event.

onclose

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

oncontextmenu

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

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

param ev

The mouse event.

oncopy

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

oncuechange

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

oncut

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

ondblclick

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

Fires when the user double-clicks the object.

param ev

The mouse event.

ondrag

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

Fires on the source object continuously during a drag operation.

param ev

The event.

ondragend

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

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

param ev

The event.

ondragenter

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

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

param ev

The drag event.

ondragleave

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

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

param ev

The drag event.

ondragover

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

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

param ev

The event.

ondragstart

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

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

param ev

The event.

ondrop

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

ondurationchange

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

Occurs when the duration attribute is updated.

param ev

The event.

onemptied

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

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

param ev

The event.

onended

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

Occurs when the end of playback is reached.

param ev

The event

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

param ev

The event.

onfocus

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

Fires when the object receives focus.

param ev

The event.

onformdata

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

onfullscreenchange

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

onfullscreenerror

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

ongotpointercapture

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

oninput

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

oninvalid

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

onkeydown

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

Fires when the user presses a key.

param ev

The keyboard event

onkeypress

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

Fires when the user presses an alphanumeric key.

param ev

The event.

deprecated

onkeyup

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

Fires when the user releases a key.

param ev

The keyboard event

onload

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

Fires immediately after the browser loads the object.

param ev

The event.

onloadeddata

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

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

param ev

The event.

onloadedmetadata

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

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

param ev

The event.

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

param ev

The event.

onlostpointercapture

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

onmousedown

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

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

param ev

The mouse event.

onmouseenter

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

onmouseleave

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

onmousemove

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

Fires when the user moves the mouse over the object.

param ev

The mouse event.

onmouseout

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

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

param ev

The mouse event.

onmouseover

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

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

param ev

The mouse event.

onmouseup

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

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

param ev

The mouse event.

onpaste

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

onpause

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

Occurs when playback is paused.

param ev

The event.

onplay

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

Occurs when the play method is requested.

param ev

The event.

onplaying

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

Occurs when the audio or video has started playing.

param ev

The event.

onpointercancel

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

onpointerdown

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

onpointerenter

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

onpointerleave

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

onpointermove

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

onpointerout

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

onpointerover

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

onpointerup

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

onprogress

onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any)

Occurs to indicate progress while downloading media data.

param ev

The event.

onratechange

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

Occurs when the playback rate is increased or decreased.

param ev

The event.

onreset

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

Fires when the user resets a form.

param ev

The event.

onresize

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

onscroll

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

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

param ev

The event.

onseeked

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

Occurs when the seek operation ends.

param ev

The event.

onseeking

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

Occurs when the current playback position is moved.

param ev

The event.

onselect

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

Fires when the current selection changes.

param ev

The event.

onselectionchange

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

onselectstart

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

onstalled

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

Occurs when the download has stopped.

param ev

The event.

onsubmit

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

onsuspend

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

Occurs if the load operation has been intentionally halted.

param ev

The event.

ontimeupdate

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

Occurs to indicate the current playback position.

param ev

The event.

ontoggle

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

Optional ontouchcancel

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

Optional ontouchend

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

Optional ontouchmove

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

Optional ontouchstart

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

ontransitioncancel

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

ontransitionend

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

ontransitionrun

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

ontransitionstart

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

onvolumechange

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

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

param ev

The event.

onwaiting

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

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

param ev

The event.

onwebkitanimationend

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

onwebkitanimationiteration

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

onwebkitanimationstart

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

onwebkittransitionend

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

onwheel

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

outerHTML

outerHTML: string

outerText

outerText: string

Readonly ownerDocument

ownerDocument: Document

Readonly parentElement

parentElement: null | HTMLElement

Returns the parent element.

Readonly parentNode

parentNode: null | ParentNode

Returns the parent.

Readonly part

part: DOMTokenList

Readonly prefix

prefix: null | string

Returns the namespace prefix.

Readonly previousElementSibling

previousElementSibling: null | Element

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

Readonly previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

Readonly scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonly scrollWidth

scrollWidth: number

Readonly shadowRoot

shadowRoot: null | ShadowRoot

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

slot

slot: string

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

spellcheck

spellcheck: boolean

Readonly style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

Readonly tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: null | string

title

title: string

translate

translate: boolean

zoom

zoom: null | number

The zoom level of the map.

Methods

addEventListener

  • addEventListener<K>(type: K, listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

after

  • after(...nodes: (string | Node)[]): void

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

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

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

animate

  • animate(keyframes: null | Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation

  • Parameters

    • keyframes: null | Keyframe[] | PropertyIndexedKeyframes
    • Optional options: number | KeyframeAnimationOptions

    Returns Animation

append

  • append(...nodes: (string | Node)[]): void

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

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

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

appendChild

  • appendChild<T>(node: T): T

  • Type Parameters

    • T extends Node

    Parameters

    • node: T

    Returns T

attachShadow

  • attachShadow(init: ShadowRootInit): ShadowRoot

  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

before

  • before(...nodes: (string | Node)[]): void

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

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

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

blur

  • blur(): void

  • Returns void

click

  • click(): void

  • Returns void

cloneNode

  • cloneNode(deep?: boolean): Node

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

    Parameters

    • Optional deep: boolean

    Returns Node

closest

  • closest<K>(selector: K): null | HTMLElementTagNameMap[K]
  • closest<K>(selector: K): null | SVGElementTagNameMap[K]
  • closest<E>(selectors: string): null | E

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

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns null | E

compareDocumentPosition

  • compareDocumentPosition(other: Node): number

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

    Parameters

    • other: Node

    Returns number

contains

  • contains(other: null | Node): boolean

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

    Parameters

    • other: null | Node

    Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

focus

  • focus(options?: FocusOptions): void

  • Parameters

    • Optional options: FocusOptions

    Returns void

getAnimations

  • getAnimations(options?: GetAnimationsOptions): Animation[]

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • getAttribute(qualifiedName: string): null | string

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

    Parameters

    • qualifiedName: string

    Returns null | string

getAttributeNS

  • getAttributeNS(namespace: null | string, localName: string): null | string

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

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

getAttributeNames

  • getAttributeNames(): string[]

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

    Returns string[]

getAttributeNode

  • getAttributeNode(qualifiedName: string): null | Attr

  • Parameters

    • qualifiedName: string

    Returns null | Attr

getAttributeNodeNS

  • getAttributeNodeNS(namespace: null | string, localName: string): null | Attr

  • Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

getBoundingClientRect

  • getBoundingClientRect(): DOMRect

  • Returns DOMRect

getClientRects

  • getClientRects(): DOMRectList

  • Returns DOMRectList

getElementsByClassName

  • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>

  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
  • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>

  • Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
  • getElementsByTagNameNS(namespace: null | string, localName: string): HTMLCollectionOf<Element>

  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

getRootNode

  • getRootNode(options?: GetRootNodeOptions): Node

  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

hasAttribute

  • hasAttribute(qualifiedName: string): boolean

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

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace: null | string, localName: string): boolean

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

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean

  • Returns true if element has attributes, and false otherwise.

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean

  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

  • insertAdjacentElement(where: InsertPosition, element: Element): null | Element

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns null | Element

insertAdjacentHTML

  • insertAdjacentHTML(position: InsertPosition, text: string): void

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where: InsertPosition, data: string): void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

insertBefore

  • insertBefore<T>(node: T, child: null | Node): T

  • Type Parameters

    • T extends Node

    Parameters

    • node: T
    • child: null | Node

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace: null | string): boolean

  • Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: null | Node): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

  • isSameNode(otherNode: null | Node): boolean

  • Parameters

    • otherNode: null | Node

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix: null | string): null | string

  • Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

  • lookupPrefix(namespace: null | string): null | string

  • Parameters

    • namespace: null | string

    Returns null | string

matches

  • matches(selectors: string): boolean

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

    Parameters

    • selectors: string

    Returns boolean

normalize

  • normalize(): void

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

    Returns void

prepend

  • prepend(...nodes: (string | Node)[]): void

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

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

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

querySelector

  • querySelector<K>(selectors: K): null | HTMLElementTagNameMap[K]
  • querySelector<K>(selectors: K): null | SVGElementTagNameMap[K]
  • querySelector<E>(selectors: string): null | E

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

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns null | E

querySelectorAll

  • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
  • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
  • querySelectorAll<E>(selectors: string): NodeListOf<E>

  • Returns all element descendants of node that match selectors.

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId: number): void

  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

  • Removes node.

    Returns void

removeAttribute

  • removeAttribute(qualifiedName: string): void

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

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace: null | string, localName: string): void

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

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr: Attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

removeChild

  • removeChild<T>(child: T): T

  • Type Parameters

    • T extends Node

    Parameters

    • child: T

    Returns T

removeEventListener

  • removeEventListener<K>(type: K, listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

replaceChild

  • replaceChild<T>(node: Node, child: T): T

  • Type Parameters

    • T extends Node

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

  • replaceChildren(...nodes: (string | Node)[]): void

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

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

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

replaceWith

  • replaceWith(...nodes: (string | Node)[]): void

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

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

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

requestFullscreen

  • requestFullscreen(options?: FullscreenOptions): Promise<void>

  • Displays element fullscreen and resolves promise when done.

    When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

requestPointerLock

  • requestPointerLock(): void

  • Returns void

scroll

  • scroll(options?: ScrollToOptions): void
  • scroll(x: number, y: number): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?: ScrollToOptions): void
  • scrollBy(x: number, y: number): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • scrollTo(options?: ScrollToOptions): void
  • scrollTo(x: number, y: number): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName: string, value: string): void

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

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void

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

    Parameters

    • namespace: null | string
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): null | Attr

  • Parameters

    • attr: Attr

    Returns null | Attr

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): null | Attr

  • Parameters

    • attr: Attr

    Returns null | Attr

setPointerCapture

  • setPointerCapture(pointerId: number): void

  • Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean

  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

    Returns true if qualifiedName is now present, and false otherwise.

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean
  • deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean

Generated using TypeDoc