<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>IWebXRDomOverlayOptions | Babylon.js API documentation</title><meta name="description" content="Documentation for Babylon.js API documentation"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Babylon.js API documentation</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">Babylon.js API documentation</a></li><li><a href="../modules/BABYLON.html">BABYLON</a></li><li><a href="BABYLON.IWebXRDomOverlayOptions.html">IWebXRDomOverlayOptions</a></li></ul><h1>Interface IWebXRDomOverlayOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Options for DOM Overlay feature</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IWebXRDomOverlayOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BABYLON.IWebXRDomOverlayOptions.html#element" class="tsd-kind-icon">element</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BABYLON.IWebXRDomOverlayOptions.html#supressXRSelectEvents" class="tsd-kind-icon">supressXRSelect<wbr>Events</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="element" class="tsd-anchor"></a><h3 class="tsd-anchor-link">element<a href="#element" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">element<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:107708</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>DOM Element or document query selector string for overlay.</p>
</div><div><p>NOTE: UA may make this element background transparent in XR.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="supressXRSelectEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> supressXRSelect<wbr>Events<a href="#supressXRSelectEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">supressXRSelect<wbr>Events<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:107712</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Supress XR Select events on container element (DOM blocks interaction to scene).</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/BABYLON.html">BABYLON</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.Debug.html">Debug</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.GLTF1.html">GLTF1</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.GLTF2.html">GLTF2</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.GUI.html">GUI</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.nativeOverride.html">native<wbr>Override</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="BABYLON.IWebXRDomOverlayOptions.html" class="tsd-kind-icon">IWebXRDom<wbr>Overlay<wbr>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BABYLON.IWebXRDomOverlayOptions.html#element" class="tsd-kind-icon">element</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BABYLON.IWebXRDomOverlayOptions.html#supressXRSelectEvents" class="tsd-kind-icon">supressXRSelect<wbr>Events</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div></body></html>

Interface IWebXRDomOverlayOptions

Hierarchy

Index

Properties

Properties

element Search playground for element

Optional supressXRSelectEvents Search playground for supressXRSelectEvents

Hierarchy

Index

Properties

Properties

elementSearch playground for element

Optional supressXRSelectEventsSearch playground for supressXRSelectEvents

element Search playground for element

Optional supressXRSelectEvents Search playground for supressXRSelectEvents