Micrio Client - v6.0.0
    Preparing search index...

    Class HTMLMicrioElement

    The main Micrio custom HTML element <micr-io>. This class acts as the central controller for the Micrio viewer, managing the WebGL canvas, compute engine, Svelte UI, state, events, and image loading.

    It orchestrates the interaction between different parts of the library and exposes methods and properties for controlling the viewer.

    <micr-io id="image123"></micr-io>
    <script>
      const viewer = document.querySelector('micr-io');
      viewer.open('image456');
      viewer.addEventListener('marker-click', (e) => console.log(e.detail));
    </script>

    You can customize the Micrio behavior by setting its HTML element attributes. These will be parsed to a Models.ImageInfo.ImageInfo JSON object, and overwrite any values received from the server.

    Attribute Description Default value
    id The image id, required
    width The image original width, optional when ID is specified auto
    height The image original height, optional when ID is specified auto
    data-title The image title
    data-thumb Thumbnail source URL
    data-version The image version auto
    data-tilesize The image tile size in pixels 1024
    data-format The image format auto
    data-extension The tile file extension auto
    data-tiles Alternate tiles ID for loading tile images
    data-png Force PNG tile format false
    data-webp Force WebP tile format false
    data-dz The image uses DeepZoom tiling false
    data-width-cm The physical width of the image in centimeters
    data-height-cm The physical height of the image in centimeters
    Attribute Description Default value
    lang The primary data language code en
    lazyload Initialize the image when the element scrolls into the view false
    data-path The image base path URI depends on image version
    data-force-path Force info.json calls to be from the data-path parameter false
    data-skipmeta Don't download image data (markers, tours, etc) false
    data-gtag Uses Google Analytics for sending user events, if available true
    data-static Disable all UI, metadata loading, and user events false
    data-keeprendering Force the WebGL render loop to run continuously false
    data-force-data-refresh Force refresh of cached image data false
    data-no-externals Don't load external resources false
    data-router Enable URL routing and deep linking false
    data-space Load 360° space data, also enables routing
    data-iiif IIIF manifest URL for loading image data
    Attribute Description Default value
    data-focus The image opening focal point coordinates x, y 0.5, 0.5
    data-view The image opening Models.Camera.View 0, 0, 1, 1
    data-zoomlimit The zoom limit (1=100% of original) 1
    data-coverlimit Limit the viewport to always fill the screen false
    data-inittype The starting viewport, cover filling the screen The full image
    data-is360 Render the image as 360° auto
    data-normalize-dpr Users with high DPI screens can zoom in as far as regular screens true
    data-limited Enable limited rendering mode false
    data-skip-base-levels Number of base zoom levels to skip loading
    data-watermark-opacity The watermark opacity 0.075
    Attribute Description Default value
    data-events Enable or disable user input events true
    data-keys Enable keyboard camera navigation controls false
    data-zooming Allow the user to zoom true
    data-scroll-zoom Allow the user to use the mousewheel to zoom true
    data-pinch-zoom Allow the user to use touch pinching to zoom true
    data-dragging Allow the user to pan the image by dragging it true
    data-two-finger-pan On touch, the users needs to use two fingers to pan the image false
    data-control-zoom Using a mouse, the user must press ctrl or cmd to zoom using the scroll wheel false
    data-camspeed Default camera animation speed 1
    data-freemove Can pan outside the image's limits false
    data-elasticity The kinetic dragging elasticity 1
    Attribute Description Default value
    data-ui Enables the HTML UI. Set to markers to only show markers, or none for zero HTML true
    data-controls Shows control buttons on the bottom right true
    data-social Put social sharing icons in the control buttons true
    data-fullscreen Place a fullscreen switch on the bottom right true
    data-logo Shows the Micrio logo on the top left true
    data-logo-org Shows the custom organisation logo on the top right true
    data-toolbar Prints the toolbar at the top true
    data-show-info Shows the image info panel if available at the bottom left true
    data-minimap Show the minimap true
    data-minimap-hide Autohide the minimap when zoomed out fully true
    data-minimap-height The maximum minimap height in pixels 200
    data-minimap-width The maximum minimap width in pixels 160
    Attribute Description Default value
    muted Mute all positional audio and music in the image false
    volume The default positional audio and music volume 1
    data-mutedvolume The volume to fade positional audio and music to when muted 0
    Attribute Description Default value
    data-gallery Gallery definition string or archive ID
    data-gallery-type The gallery type (swipe, swipe-full, switch, omni) swipe
    data-gallery-sort Gallery sort order (name, -name, created, -created) created
    data-gallery-spreads Display gallery pages as spreads false
    data-gallery-cover-pages Number of single cover pages in spreads mode 0
    data-start Starting image ID for the gallery
    Attribute Description Default value
    data-grid Grid definition string or archive ID
    data-grid-clickable Make grid items clickable false

    Marcel Duin marcel@micr.io

    Hierarchy

    • HTMLElement
      • HTMLMicrioElement
    Index

    Properties

    accessKey accessKeyLabel ariaAtomic ariaAutoComplete ariaBrailleLabel ariaBrailleRoleDescription ariaBusy ariaChecked ariaColCount ariaColIndex ariaColSpan ariaCurrent ariaDescription ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText assignedSlot ATTRIBUTE_NODE attributes attributeStyleMap autocapitalize autofocus barebone baseURI canvas canvases CDATA_SECTION_NODE childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth COMMENT_NODE contentEditable current dataset defaultSettings? dir DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE draggable ELEMENT_NODE enterKeyHint ENTITY_NODE ENTITY_REFERENCE_NODE events firstChild firstElementChild gridInfoData hidden id inert innerHTML innerText inputMode isConnected isContentEditable lastChild lastElementChild localName namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue nonce? NOTATION_NODE offsetHeight offsetLeft offsetParent offsetTop offsetWidth onabort onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onbeforetoggle onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextlost oncontextmenu oncontextrestored oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata onfullscreenchange onfullscreenerror ongotpointercapture oninput oninvalid onkeydown onkeypress onkeyup onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onprogress onratechange onreset onresize onscroll onscrollend onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel outerHTML outerText ownerDocument parentElement parentNode part popover prefix previousElementSibling previousSibling PROCESSING_INSTRUCTION_NODE role scrollHeight scrollLeft scrollTop scrollWidth shadowRoot slot spaceData spellcheck state style tabIndex tagName TEXT_NODE textContent title translate visible jsonCache VERSION

    Accessors

    $current camera lang observedAttributes

    Methods

    addEventListener after animate append appendChild attachInternals attachShadow before blur checkVisibility click cloneNode close closest compareDocumentPosition computedStyleMap contains destroy dispatchEvent focus getAnimations getAttribute getAttributeNames getAttributeNode getAttributeNodeNS getAttributeNS getBoundingClientRect getClientRects getElementsByClassName getElementsByTagName getElementsByTagNameNS getHTML getRootNode hasAttribute hasAttributeNS hasAttributes hasChildNodes hasPointerCapture hidePopover insertAdjacentElement insertAdjacentHTML insertAdjacentText insertBefore isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix matches normalize open prepend querySelector querySelectorAll releasePointerCapture remove removeAttribute removeAttributeNode removeAttributeNS removeChild removeEventListener replaceChild replaceChildren replaceWith requestFullscreen requestPointerLock scroll scrollBy scrollIntoView scrollTo setAttribute setAttributeNode setAttributeNodeNS setAttributeNS setHTMLUnsafe setPointerCapture showPopover toggleAttribute togglePopover webkitMatchesSelector

    Properties

    accessKey: string

    MDN Reference

    accessKeyLabel: string

    MDN Reference

    ariaAtomic: string

    MDN Reference

    ariaAutoComplete: string

    MDN Reference

    ariaBrailleLabel: string

    MDN Reference

    ariaBrailleRoleDescription: string

    MDN Reference

    ariaBusy: string

    MDN Reference

    ariaChecked: string

    MDN Reference

    ariaColCount: string

    MDN Reference

    ariaColIndex: string

    MDN Reference

    ariaColSpan: string

    MDN Reference

    ariaCurrent: string

    MDN Reference

    ariaDescription: string

    MDN Reference

    ariaDisabled: string

    MDN Reference

    ariaExpanded: string

    MDN Reference

    ariaHasPopup: string

    MDN Reference

    ariaHidden: string

    MDN Reference

    ariaInvalid: string
    ariaKeyShortcuts: string

    MDN Reference

    ariaLabel: string

    MDN Reference

    ariaLevel: string

    MDN Reference

    ariaLive: string

    MDN Reference

    ariaModal: string

    MDN Reference

    ariaMultiLine: string

    MDN Reference

    ariaMultiSelectable: string

    MDN Reference

    ariaOrientation: string

    MDN Reference

    ariaPlaceholder: string

    MDN Reference

    ariaPosInSet: string

    MDN Reference

    ariaPressed: string

    MDN Reference

    ariaReadOnly: string

    MDN Reference

    ariaRequired: string

    MDN Reference

    ariaRoleDescription: string

    MDN Reference

    ariaRowCount: string

    MDN Reference

    ariaRowIndex: string

    MDN Reference

    ariaRowSpan: string

    MDN Reference

    ariaSelected: string

    MDN Reference

    ariaSetSize: string

    MDN Reference

    ariaSort: string

    MDN Reference

    ariaValueMax: string

    MDN Reference

    ariaValueMin: string

    MDN Reference

    ariaValueNow: string

    MDN Reference

    ariaValueText: string

    MDN Reference

    assignedSlot: HTMLSlotElement

    MDN Reference

    ATTRIBUTE_NODE: 2
    attributes: NamedNodeMap

    MDN Reference

    attributeStyleMap: StylePropertyMap

    MDN Reference

    autocapitalize: string

    MDN Reference

    autofocus: boolean

    MDN Reference

    barebone: Writable<boolean> = ...

    Writable Svelte store indicating if barebone texture downloading is enabled (lower quality, less bandwidth).

    baseURI: string

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

    MDN Reference

    canvas: Canvas = ...

    The controller managing the HTML <canvas> element, resizing, and viewport.

    canvases: MicrioImage[] = []

    Array holding all instantiated MicrioImage objects managed by this element.

    CDATA_SECTION_NODE: 4

    node is a CDATASection node.

    childElementCount: number

    MDN Reference

    childNodes: NodeListOf<ChildNode>

    Returns the children.

    MDN Reference

    children: HTMLCollection

    Returns the child elements.

    MDN Reference

    classList: DOMTokenList

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

    MDN Reference

    className: string

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

    MDN Reference

    clientHeight: number

    MDN Reference

    clientLeft: number

    MDN Reference

    clientTop: number

    MDN Reference

    clientWidth: number

    MDN Reference

    COMMENT_NODE: 8

    node is a Comment node.

    contentEditable: string

    MDN Reference

    current: Writable<MicrioImage> = ...

    Writable Svelte store holding the currently active main MicrioImage. Use <micr-io>.open() to change the active image. Subscribe to this store to react to image changes. Access the current value directly using the $current getter.

    dataset: DOMStringMap

    MDN Reference

    defaultSettings?: Partial<Settings> = ...

    Custom settings object provided programmatically, overriding server-fetched settings.

    dir: string

    MDN Reference

    DOCUMENT_FRAGMENT_NODE: 11

    node is a DocumentFragment node.

    DOCUMENT_NODE: 9

    node is a document.

    DOCUMENT_POSITION_CONTAINED_BY: 16

    Set when other is a descendant of node.

    DOCUMENT_POSITION_CONTAINS: 8

    Set when other is an ancestor of node.

    DOCUMENT_POSITION_DISCONNECTED: 1

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

    DOCUMENT_POSITION_FOLLOWING: 4

    Set when other is following node.

    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
    DOCUMENT_POSITION_PRECEDING: 2

    Set when other is preceding node.

    DOCUMENT_TYPE_NODE: 10

    node is a doctype.

    draggable: boolean

    MDN Reference

    ELEMENT_NODE: 1

    node is an element.

    enterKeyHint: string

    MDN Reference

    ENTITY_NODE: 6
    ENTITY_REFERENCE_NODE: 5
    events: Events = ...

    The controller managing user input events (mouse, touch, keyboard) and dispatching custom events.

    firstChild: ChildNode

    Returns the first child.

    MDN Reference

    firstElementChild: Element

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

    MDN Reference

    gridInfoData: { images: Models.ImageInfo.ImageInfo[] }

    Holds loaded grid info data if applicable.

    hidden: boolean

    MDN Reference

    id: string

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

    MDN Reference

    inert: boolean

    MDN Reference

    innerHTML: string

    MDN Reference

    innerText: string

    MDN Reference

    inputMode: string

    MDN Reference

    isConnected: boolean

    Returns true if node is connected and false otherwise.

    MDN Reference

    isContentEditable: boolean

    MDN Reference

    lastChild: ChildNode

    Returns the last child.

    MDN Reference

    lastElementChild: Element

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

    MDN Reference

    localName: string

    Returns the local name.

    MDN Reference

    namespaceURI: string

    Returns the namespace.

    MDN Reference

    nextElementSibling: Element

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

    MDN Reference

    nextSibling: ChildNode

    Returns the next sibling.

    MDN Reference

    nodeName: string

    Returns a string appropriate for the type of node.

    MDN Reference

    nodeType: number

    Returns the type of node.

    MDN Reference

    nodeValue: string

    MDN Reference

    nonce?: string

    MDN Reference

    NOTATION_NODE: 12
    offsetHeight: number

    MDN Reference

    offsetLeft: number

    MDN Reference

    offsetParent: Element

    MDN Reference

    offsetTop: number

    MDN Reference

    offsetWidth: number

    MDN Reference

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

    Fires when the user aborts the download.

    Type Declaration

      • (this: GlobalEventHandlers, ev: UIEvent): any

      • Parameters

        Returns any

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

    onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any

    MDN Reference

    onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any

    MDN Reference

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

    Fires when the object loses the input focus.

    Type Declaration

      • (this: GlobalEventHandlers, ev: FocusEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: FocusEvent

          The focus event.

          MDN Reference

        Returns any

    oncancel: (this: GlobalEventHandlers, ev: Event) => any

    MDN Reference

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    MDN Reference

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

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

    MDN Reference

    oncontextlost: (this: GlobalEventHandlers, ev: Event) => any

    MDN Reference

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

    oncontextrestored: (this: GlobalEventHandlers, ev: Event) => any

    MDN Reference

    oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any

    MDN Reference

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

    MDN Reference

    oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any

    MDN Reference

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

    Fires when the user double-clicks the object.

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

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

    Fires on the source object continuously during a drag operation.

    Type Declaration

      • (this: GlobalEventHandlers, ev: DragEvent): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: DragEvent): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: DragEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: DragEvent

          The drag event.

          MDN Reference

        Returns any

    ondragleave: (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.

    Type Declaration

      • (this: GlobalEventHandlers, ev: DragEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: DragEvent

          The drag event.

          MDN Reference

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: DragEvent): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: DragEvent): any

      • Parameters

        Returns any

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

    MDN Reference

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

    Occurs when the duration attribute is updated.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Occurs when the end of playback is reached.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

    onerror: OnErrorEventHandlerNonNull

    Fires when an error occurs during object loading.

    The event.

    MDN Reference

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

    Fires when the object receives focus.

    Type Declaration

      • (this: GlobalEventHandlers, ev: FocusEvent): any

      • Parameters

        Returns any

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    Fires when the user presses a key.

    Type Declaration

      • (this: GlobalEventHandlers, ev: KeyboardEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: KeyboardEvent

          The keyboard event

          MDN Reference

        Returns any

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

    Fires when the user presses an alphanumeric key.

    Type Declaration

      • (this: GlobalEventHandlers, ev: KeyboardEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: KeyboardEvent

          The event.

        Returns any

    MDN Reference

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

    Fires when the user releases a key.

    Type Declaration

      • (this: GlobalEventHandlers, ev: KeyboardEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: KeyboardEvent

          The keyboard event

          MDN Reference

        Returns any

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

    Fires immediately after the browser loads the object.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Occurs when Internet Explorer begins looking for media data.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    MDN Reference

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

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

    MDN Reference

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

    MDN Reference

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

    Fires when the user moves the mouse over the object.

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: MouseEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: MouseEvent

          The mouse event.

          MDN Reference

        Returns any

    onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any

    MDN Reference

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

    Occurs when playback is paused.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Occurs when the play method is requested.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Occurs when the audio or video has started playing.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

    onprogress: (this: GlobalEventHandlers, ev: ProgressEvent) => any

    Occurs to indicate progress while downloading media data.

    Type Declaration

      • (this: GlobalEventHandlers, ev: ProgressEvent): any

      • Parameters

        • this: GlobalEventHandlers
        • ev: ProgressEvent

          The event.

          MDN Reference

        Returns any

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

    Occurs when the playback rate is increased or decreased.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Fires when the user resets a form.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    MDN Reference

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

    onscrollend: (this: GlobalEventHandlers, ev: Event) => any

    MDN Reference

    onsecuritypolicyviolation: (
        this: GlobalEventHandlers,
        ev: SecurityPolicyViolationEvent,
    ) => any

    MDN Reference

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

    Occurs when the seek operation ends.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Occurs when the current playback position is moved.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Fires when the current selection changes.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    MDN Reference

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

    MDN Reference

    onslotchange: (this: GlobalEventHandlers, ev: Event) => any

    MDN Reference

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

    Occurs when the download has stopped.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

    onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any

    MDN Reference

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

    Occurs if the load operation has been intentionally halted.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    Occurs to indicate the current playback position.

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

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

    Type Declaration

      • (this: GlobalEventHandlers, ev: Event): any

      • Parameters

        Returns any

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

    This is a legacy alias of onanimationend.

    MDN Reference

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

    This is a legacy alias of onanimationiteration.

    MDN Reference

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

    This is a legacy alias of onanimationstart.

    MDN Reference

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

    This is a legacy alias of ontransitionend.

    MDN Reference

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

    MDN Reference

    outerHTML: string

    MDN Reference

    outerText: string

    MDN Reference

    ownerDocument: Document

    Returns the node document. Returns null for documents.

    MDN Reference

    parentElement: HTMLElement

    Returns the parent element.

    MDN Reference

    parentNode: ParentNode

    Returns the parent.

    MDN Reference

    part: DOMTokenList

    MDN Reference

    popover: string

    MDN Reference

    prefix: string

    Returns the namespace prefix.

    MDN Reference

    previousElementSibling: Element

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

    MDN Reference

    previousSibling: ChildNode

    Returns the previous sibling.

    MDN Reference

    PROCESSING_INSTRUCTION_NODE: 7

    node is a ProcessingInstruction node.

    role: string
    scrollHeight: number

    MDN Reference

    scrollLeft: number

    MDN Reference

    scrollTop: number

    MDN Reference

    scrollWidth: number

    MDN Reference

    shadowRoot: ShadowRoot

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

    MDN Reference

    slot: string

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

    MDN Reference

    spaceData: Space

    Holds data for the current 360 space, if applicable (loaded via data-space attribute or API).

    spellcheck: boolean

    MDN Reference

    state: Main = ...

    The main state manager, providing access to various application states (UI visibility, active marker, tour, etc.). See State.Main.

    style: CSSStyleDeclaration

    MDN Reference

    tabIndex: number

    MDN Reference

    tagName: string

    Returns the HTML-uppercased qualified name.

    MDN Reference

    ReadonlyTEXT_NODE

    TEXT_NODE: 3

    node is a Text node.

    textContent: string

    MDN Reference

    title: string

    MDN Reference

    translate: boolean

    MDN Reference

    visible: Writable<MicrioImage[]> = ...

    Writable Svelte store holding an array of currently visible MicrioImage instances (relevant for split-screen or grid).

    jsonCache: Map<string, Object> = jsonCache

    Static cache store for downloaded JSON files (like image info).

    VERSION: string

    The Micrio library version number.

    Accessors

    • get camera(): Camera

      Getter for the virtual Camera instance of the currently active image.

      Returns Camera

    • get lang(): string

      Getter for the current language code.

      Returns string

    • set lang(l: string): void

      Setter for the current language code. Triggers language change logic.

      Parameters

      • l: string

      Returns void

    • get observedAttributes(): string[]

      Observed attributes trigger attributeChangedCallback when changed.

      Returns string[]

    Methods

    • Type Parameters

      Parameters

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • type: K
      • listener: (this: HTMLMicrioElement, ev: HTMLElementEventMap[K]) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: (this: HTMLMicrioElement, ev: Event) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns 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

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

      Returns void

    • MDN Reference

      Parameters

      • keyframes: PropertyIndexedKeyframes | Keyframe[]
      • Optionaloptions: number | KeyframeAnimationOptions

      Returns Animation

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

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

      MDN Reference

      Parameters

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

      Returns void

    • MDN Reference

      Type Parameters

      • T extends Node

      Parameters

      • node: T

      Returns T

    • MDN Reference

      Returns ElementInternals

    • Creates a shadow root for element and returns it.

      MDN Reference

      Parameters

      • init: ShadowRootInit

      Returns ShadowRoot

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

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

      MDN Reference

      Parameters

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

      Returns void

    • MDN Reference

      Returns void

    • MDN Reference

      Parameters

      • Optionaloptions: CheckVisibilityOptions

      Returns boolean

    • MDN Reference

      Returns void

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

      MDN Reference

      Parameters

      • Optionaldeep: boolean

      Returns Node

    • Closes an opened MicrioImage. For split-screen images, it triggers the split-end transition. For main images, it removes the canvas from the engine.

      Parameters

      Returns void

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

      MDN Reference

      Type Parameters

      • K extends keyof HTMLElementTagNameMap

      Parameters

      • selector: K

      Returns HTMLElementTagNameMap[K]

    • Type Parameters

      • K extends keyof SVGElementTagNameMap

      Parameters

      • selector: K

      Returns SVGElementTagNameMap[K]

    • Type Parameters

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • selector: K

      Returns MathMLElementTagNameMap[K]

    • Type Parameters

      • E extends Element = Element

      Parameters

      • selectors: string

      Returns E

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

      MDN Reference

      Parameters

      • other: Node

      Returns number

    • MDN Reference

      Returns StylePropertyMapReadOnly

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

      MDN Reference

      Parameters

      • other: Node

      Returns boolean

    • Destroys the Micrio instance, cleans up resources, and removes event listeners.

      Returns void

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

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • MDN Reference

      Parameters

      • Optionaloptions: FocusOptions

      Returns void

    • MDN Reference

      Parameters

      • Optionaloptions: GetAnimationsOptions

      Returns Animation[]

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

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns string

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

      MDN Reference

      Returns string[]

    • MDN Reference

      Parameters

      • qualifiedName: string

      Returns Attr

    • MDN Reference

      Parameters

      • namespace: string
      • localName: string

      Returns Attr

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

      MDN Reference

      Parameters

      • namespace: string
      • localName: string

      Returns string

    • MDN Reference

      Returns DOMRect

    • MDN Reference

      Returns DOMRectList

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

      MDN Reference

      Parameters

      • classNames: string

      Returns HTMLCollectionOf<Element>

    • MDN Reference

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

    • Type Parameters

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • qualifiedName: K

      Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof HTMLElementDeprecatedTagNameMap

      Parameters

      • qualifiedName: K

      Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    • Parameters

      • qualifiedName: string

      Returns HTMLCollectionOf<Element>

    • MDN Reference

      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

      • namespaceURI: "http://www.w3.org/1998/Math/MathML"
      • localName: string

      Returns HTMLCollectionOf<MathMLElement>

    • Parameters

      • namespace: string
      • localName: string

      Returns HTMLCollectionOf<Element>

    • MDN Reference

      Parameters

      • Optionaloptions: GetHTMLOptions

      Returns string

    • Returns node's root.

      MDN Reference

      Parameters

      • Optionaloptions: GetRootNodeOptions

      Returns Node

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

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns boolean

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

      MDN Reference

      Parameters

      • namespace: string
      • localName: string

      Returns boolean

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

      MDN Reference

      Returns boolean

    • Returns whether node has children.

      MDN Reference

      Returns boolean

    • MDN Reference

      Parameters

      • pointerId: number

      Returns boolean

    • MDN Reference

      Returns void

    • MDN Reference

      Parameters

      • where: InsertPosition
      • element: Element

      Returns Element

    • MDN Reference

      Parameters

      • position: InsertPosition
      • string: string

      Returns void

    • MDN Reference

      Parameters

      • where: InsertPosition
      • data: string

      Returns void

    • MDN Reference

      Type Parameters

      • T extends Node

      Parameters

      • node: T
      • child: Node

      Returns T

    • MDN Reference

      Parameters

      • namespace: string

      Returns boolean

    • Returns whether node and otherNode have the same properties.

      MDN Reference

      Parameters

      • otherNode: Node

      Returns boolean

    • MDN Reference

      Parameters

      • otherNode: Node

      Returns boolean

    • MDN Reference

      Parameters

      • prefix: string

      Returns string

    • MDN Reference

      Parameters

      • namespace: string

      Returns string

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

      MDN Reference

      Parameters

      • selectors: string

      Returns boolean

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

      MDN Reference

      Returns void

    • Opens a Micrio image by its ID or by providing partial image info data. This is the primary method for loading and displaying images.

      Parameters

      • idOrInfo: string | Partial<Models.ImageInfo.ImageInfo>

        An image ID string (e.g., 'abcdef123') or a partial Models.ImageInfo.ImageInfo object.

      • opts: {
            gridView?: boolean;
            isPassive?: boolean;
            splitScreen?: boolean;
            splitTo?: MicrioImage;
            startView?: CameraArray;
            vector?: Vector;
        } = {}

        Options for opening the image.

        • OptionalgridView?: boolean

          If true, keeps the grid view active instead of focusing on the opened image.

        • OptionalisPassive?: boolean

          If true, opens the split-screen view passively (doesn't take focus).

        • OptionalsplitScreen?: boolean

          If true, opens the image as a secondary split-screen view.

        • OptionalsplitTo?: MicrioImage

          The primary image when opening in split-screen mode. Defaults to the current main image.

        • OptionalstartView?: CameraArray

          An optional starting view to apply immediately.

        • Optionalvector?: Vector

          For 360 transitions, provides the direction vector from the previous image.

      Returns MicrioImage

      The MicrioImage instance being opened.

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

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

      MDN Reference

      Parameters

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

      Returns void

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

      MDN Reference

      Type Parameters

      • K extends keyof HTMLElementTagNameMap

      Parameters

      • selectors: K

      Returns HTMLElementTagNameMap[K]

    • Type Parameters

      • K extends keyof SVGElementTagNameMap

      Parameters

      • selectors: K

      Returns SVGElementTagNameMap[K]

    • Type Parameters

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • selectors: K

      Returns MathMLElementTagNameMap[K]

    • Type Parameters

      • K extends keyof HTMLElementDeprecatedTagNameMap

      Parameters

      • selectors: K

      Returns HTMLElementDeprecatedTagNameMap[K]

    • Type Parameters

      • E extends Element = Element

      Parameters

      • selectors: string

      Returns E

    • Returns all element descendants of node that match selectors.

      MDN Reference

      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

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • selectors: K

      Returns NodeListOf<MathMLElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof HTMLElementDeprecatedTagNameMap

      Parameters

      • selectors: K

      Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    • Type Parameters

      • E extends Element = Element

      Parameters

      • selectors: string

      Returns NodeListOf<E>

    • MDN Reference

      Parameters

      • pointerId: number

      Returns void

    • Removes node.

      MDN Reference

      Returns void

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

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns void

    • MDN Reference

      Parameters

      • attr: Attr

      Returns Attr

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

      MDN Reference

      Parameters

      • namespace: string
      • localName: string

      Returns void

    • MDN Reference

      Type Parameters

      • T extends Node

      Parameters

      • child: T

      Returns T

    • Type Parameters

      Parameters

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • type: K
      • listener: (this: HTMLMicrioElement, ev: HTMLElementEventMap[K]) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: (this: HTMLMicrioElement, ev: Event) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • MDN Reference

      Type Parameters

      • T extends Node

      Parameters

      • node: Node
      • child: T

      Returns T

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

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

      MDN Reference

      Parameters

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

      Returns void

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

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

      MDN Reference

      Parameters

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

      Returns void

    • Displays element fullscreen and resolves promise when done.

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

      MDN Reference

      Parameters

      • Optionaloptions: FullscreenOptions

      Returns Promise<void>

    • MDN Reference

      Parameters

      • Optionaloptions: PointerLockOptions

      Returns Promise<void>

    • MDN Reference

      Parameters

      • Optionaloptions: ScrollToOptions

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • MDN Reference

      Parameters

      • Optionaloptions: ScrollToOptions

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • MDN Reference

      Parameters

      • Optionalarg: boolean | ScrollIntoViewOptions

      Returns void

    • MDN Reference

      Parameters

      • Optionaloptions: ScrollToOptions

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

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

      MDN Reference

      Parameters

      • qualifiedName: string
      • value: string

      Returns void

    • MDN Reference

      Parameters

      • attr: Attr

      Returns Attr

    • MDN Reference

      Parameters

      • attr: Attr

      Returns Attr

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

      MDN Reference

      Parameters

      • namespace: string
      • qualifiedName: string
      • value: string

      Returns void

    • MDN Reference

      Parameters

      • html: string

      Returns void

    • MDN Reference

      Parameters

      • pointerId: number

      Returns void

    • MDN Reference

      Returns void

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

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

      MDN Reference

      Parameters

      • qualifiedName: string
      • Optionalforce: boolean

      Returns boolean

    • MDN Reference

      Parameters

      • Optionalforce: boolean

      Returns boolean

    • Parameters

      • selectors: string

      Returns boolean

      This is a legacy alias of matches.

      MDN Reference

    Settings

    Member Visibility

    On This Page

    Attribute settings
    Properties
    accessKeyaccessKeyLabelariaAtomicariaAutoCompleteariaBrailleLabelariaBrailleRoleDescriptionariaBusyariaCheckedariaColCountariaColIndexariaColSpanariaCurrentariaDescriptionariaDisabledariaExpandedariaHasPopupariaHiddenariaInvalidariaKeyShortcutsariaLabelariaLevelariaLiveariaModalariaMultiLineariaMultiSelectableariaOrientationariaPlaceholderariaPosInSetariaPressedariaReadOnlyariaRequiredariaRoleDescriptionariaRowCountariaRowIndexariaRowSpanariaSelectedariaSetSizeariaSortariaValueMaxariaValueMinariaValueNowariaValueTextassignedSlotATTRIBUTE_NODEattributesattributeStyleMapautocapitalizeautofocusbarebonebaseURIcanvascanvasesCDATA_SECTION_NODEchildElementCountchildNodeschildrenclassListclassNameclientHeightclientLeftclientTopclientWidthCOMMENT_NODEcontentEditablecurrentdatasetdefaultSettingsdirDOCUMENT_FRAGMENT_NODEDOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODEdraggableELEMENT_NODEenterKeyHintENTITY_NODEENTITY_REFERENCE_NODEeventsfirstChildfirstElementChildgridInfoDatahiddenidinertinnerHTMLinnerTextinputModeisConnectedisContentEditablelastChildlastElementChildlocalNamenamespaceURInextElementSiblingnextSiblingnodeNamenodeTypenodeValuenonceNOTATION_NODEoffsetHeightoffsetLeftoffsetParentoffsetTopoffsetWidthonabortonanimationcancelonanimationendonanimationiterationonanimationstartonauxclickonbeforeinputonbeforetoggleonbluroncanceloncanplayoncanplaythroughonchangeonclickoncloseoncontextlostoncontextmenuoncontextrestoredoncopyoncuechangeoncutondblclickondragondragendondragenterondragleaveondragoverondragstartondropondurationchangeonemptiedonendedonerroronfocusonformdataonfullscreenchangeonfullscreenerrorongotpointercaptureoninputoninvalidonkeydownonkeypressonkeyuponloadonloadeddataonloadedmetadataonloadstartonlostpointercaptureonmousedownonmouseenteronmouseleaveonmousemoveonmouseoutonmouseoveronmouseuponpasteonpauseonplayonplayingonpointercancelonpointerdownonpointerenteronpointerleaveonpointermoveonpointeroutonpointeroveronpointeruponprogressonratechangeonresetonresizeonscrollonscrollendonsecuritypolicyviolationonseekedonseekingonselectonselectionchangeonselectstartonslotchangeonstalledonsubmitonsuspendontimeupdateontoggleontouchcancelontouchendontouchmoveontouchstartontransitioncancelontransitionendontransitionrunontransitionstartonvolumechangeonwaitingonwebkitanimationendonwebkitanimationiterationonwebkitanimationstartonwebkittransitionendonwheelouterHTMLouterTextownerDocumentparentElementparentNodepartpopoverprefixpreviousElementSiblingpreviousSiblingPROCESSING_INSTRUCTION_NODErolescrollHeightscrollLeftscrollTopscrollWidthshadowRootslotspaceDataspellcheckstatestyletabIndextagNameTEXT_NODEtextContenttitletranslatevisiblejsonCacheVERSION
    Accessors
    Methods
    addEventListenerafteranimateappendappendChildattachInternalsattachShadowbeforeblurcheckVisibilityclickcloneNodecloseclosestcompareDocumentPositioncomputedStyleMapcontainsdestroydispatchEventfocusgetAnimationsgetAttributegetAttributeNamesgetAttributeNodegetAttributeNodeNSgetAttributeNSgetBoundingClientRectgetClientRectsgetElementsByClassNamegetElementsByTagNamegetElementsByTagNameNSgetHTMLgetRootNodehasAttributehasAttributeNShasAttributeshasChildNodeshasPointerCapturehidePopoverinsertAdjacentElementinsertAdjacentHTMLinsertAdjacentTextinsertBeforeisDefaultNamespaceisEqualNodeisSameNodelookupNamespaceURIlookupPrefixmatchesnormalizeopenprependquerySelectorquerySelectorAllreleasePointerCaptureremoveremoveAttributeremoveAttributeNoderemoveAttributeNSremoveChildremoveEventListenerreplaceChildreplaceChildrenreplaceWithrequestFullscreenrequestPointerLockscrollscrollByscrollIntoViewscrollTosetAttributesetAttributeNodesetAttributeNodeNSsetAttributeNSsetHTMLUnsafesetPointerCaptureshowPopovertoggleAttributetogglePopoverwebkitMatchesSelector