From 8908e568156e4ea1b6a58d7a8c9d3365454c9164 Mon Sep 17 00:00:00 2001 From: jamesmisson Date: Wed, 27 May 2026 17:15:34 +0100 Subject: [PATCH 1/2] 4.4.0-rc3 --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index b96fb6f4b..f11f2caa5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "universalviewer", - "version": "4.4.0-rc2", + "version": "4.4.0-rc3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "universalviewer", - "version": "4.4.0-rc2", + "version": "4.4.0-rc3", "license": "MIT", "dependencies": { "@google/model-viewer": "^4.0.0", diff --git a/package.json b/package.json index c05143ff5..2fc5b10f6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "universalviewer", - "version": "4.4.0-rc2", + "version": "4.4.0-rc3", "description": "The Universal Viewer is a community-developed open source project on a mission to help you share your 📚📜📰📽️📻🗿 with the 🌎", "engines": { "node": ">=20", From d070df360d62b9ac1f582f31136e03422288d2f2 Mon Sep 17 00:00:00 2001 From: jamesmisson Date: Wed, 27 May 2026 17:15:53 +0100 Subject: [PATCH 2/2] run docs --- docs/assets/icons.js | 2 +- docs/assets/icons.svg | 2 +- docs/assets/main.js | 8 +-- docs/assets/style.css | 17 ++---- docs/index.html | 25 +++++--- docs/modules.html | 2 +- .../_internal_.AVCenterPanelOptions.html | 22 +++---- .../_internal_.AlephLeftPanelOptions.html | 10 ++-- .../_internal_.ContentLeftPanelOptions.html | 48 +++++++-------- docs/types/_internal_.ExpandPanelOptions.html | 10 ++-- docs/types/_internal_.FooterPanelOptions.html | 20 +++---- docs/types/_internal_.HeaderPanelOptions.html | 8 +-- ...ternal_.ModelViewerCenterPanelOptions.html | 10 ++-- docs/types/_internal_.ModuleContent.html | 2 +- docs/types/_internal_.ModuleOptions.html | 2 +- .../_internal_.MoreInfoRightPanelOptions.html | 22 +++---- ..._internal_.MultiSelectDialogueOptions.html | 12 ++-- ..._internal_.OSDDownloadDialogueOptions.html | 16 ++--- ...rnal_.OpenSeadragonCenterPanelOptions.html | 40 ++++++------- docs/types/_internal_.Options.html | 58 +++++++++---------- .../_internal_.PDFCenterPanelOptions.html | 8 +-- .../_internal_.PagingHeaderPanelOptions.html | 16 ++--- .../_internal_.SearchFooterPanelOptions.html | 14 ++--- .../_internal_.ShareDialogueOptions.html | 18 +++--- .../_internal_.ThumbsCacheInvalidation.html | 4 +- 25 files changed, 199 insertions(+), 197 deletions(-) diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 58882d76d..4fbadc5ad 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -3,7 +3,7 @@ function addIcons() { if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 50ad5799d..be7798fcd 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 19bbb7a74..8182ceec6 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,9 +1,9 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()}(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` - ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); +"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function Ee(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function xe(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function Le(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var we=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;Ee(i,{closeOnClick:!0});function a(){xe(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",we+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!Le(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` + ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${we}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/style.css b/docs/assets/style.css index 7c3fbdb90..44328e99a 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -504,15 +504,8 @@ body { background: var(--color-background); font-family: - -apple-system, - BlinkMacSystemFont, - "Segoe UI", - "Noto Sans", - Helvetica, - Arial, - sans-serif, - "Apple Color Emoji", - "Segoe UI Emoji"; + -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); margin: 0; @@ -1602,9 +1595,9 @@ .container-main { grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( - 0, - 20rem - ); + 0, + 20rem + ); grid-template-areas: "sidebar content toc"; } diff --git a/docs/index.html b/docs/index.html index 603f4d479..0cd52dea8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,7 +19,8 @@

Un

# Slack      @ Bluesky      @ X      @ Mastodon      History of the UV

-

The Universal Viewer (UV) is a community-developed open source project. Our mission is to help you share your content with the world

The UV software can display images, 3D files and PDFs, play audio and video files, and more.

+

The Universal Viewer (UV) is a community-developed open source project. Our mission is to help you share your content with the world

+

The UV software can display images, 3D files and PDFs, play audio and video files, and more.


npm install universalviewer --save
@@ -37,18 +38,21 @@

Accessibility Statement
  • License
    • -

      + + -

      See the examples for how to use the UV in various scenarios.

      + +

      See the examples for how to use the UV in various scenarios.

      Read the technical docs to learn more about the code and available configuration options.

      Read the manual for information on using, configuring, and developing for the UV.

      -

      An active, collaborative community of testers, developers and institutional users has grown around the Universal Viewer. Read this blog post about a recent 'community sprint' to find out more about how we're working together.

      + +

      An active, collaborative community of testers, developers and institutional users has grown around the Universal Viewer. Read this blog post about a recent 'community sprint' to find out more about how we're working together.

      Talking to active contributors and sponsors is a great way to find out what the community is currently focusing on, and where help is needed:

      • Join the discussion on Slack
        • @@ -69,9 +73,14 @@

      -

      Individual contributors

      -

      Become a sponsor and join our Steering Group to help guide how our sponsorship funds are allocated.

      + + +

      Individual contributors

      + +

      Become a sponsor and join our Steering Group to help guide how our sponsorship funds are allocated.

      Institutional contributors

      -

      Read our Accessibility Statement

      -

      The Universal Viewer is released under the MIT license.

      + +

      Read our Accessibility Statement

      + +

      The Universal Viewer is released under the MIT license.

      Settings

      Member Visibility

      On This Page

      The Universal Viewer (UV) is a community-developed open source project. Our mission is to help you share your content with the world
      diff --git a/docs/modules.html b/docs/modules.html index 5c3bfd5c2..225869564 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -universalviewer
      universalviewer
        Preparing search index...

          universalviewer

          Modules

          <internal>

          Type Aliases

          IIIFContentHandlerConfig

          Settings

          Member Visibility

          On This Page

          Modules
          Type Aliases
          +universalviewer
          universalviewer
            Preparing search index...

              universalviewer

              Modules

              <internal>

              Type Aliases

              IIIFContentHandlerConfig

              Settings

              Member Visibility

              On This Page

              Modules
              Type Aliases
              diff --git a/docs/types/_internal_.AVCenterPanelOptions.html b/docs/types/_internal_.AVCenterPanelOptions.html index 5cf0d2e06..352d18aab 100644 --- a/docs/types/_internal_.AVCenterPanelOptions.html +++ b/docs/types/_internal_.AVCenterPanelOptions.html @@ -1,11 +1,11 @@ -AVCenterPanelOptions | universalviewer
              universalviewer
                Preparing search index...

                Type Alias AVCenterPanelOptions

                AVCenterPanelOptions: CenterPanelOptions & {
                    autoAdvanceRanges: boolean;
                    autoPlay: boolean;
                    enableFastForward: boolean;
                    enableFastRewind: boolean;
                    hideMediaError: boolean;
                    includeParentInTitleEnabled: boolean;
                    limitToRange: boolean;
                    posterImageExpanded: boolean;
                    posterImageRatio: number;
                    subtitleMetadataField: string;
                }

                Type declaration

                • autoAdvanceRanges: boolean

                  Determines if ranges auto advance

                  -
                • autoPlay: boolean

                  Determines if auto play is enabled

                  -
                • enableFastForward: boolean

                  Determines if fast forward is enabled

                  -
                • enableFastRewind: boolean

                  Determines if fast rewind is enabled

                  -
                • hideMediaError: boolean

                  Determines if media errors are hidden

                  -
                • includeParentInTitleEnabled: boolean

                  Determines if parent is included in title

                  -
                • limitToRange: boolean

                  Determines if limit is set to range

                  -
                • posterImageExpanded: boolean

                  Determines if the poster image is expanded

                  -
                • posterImageRatio: number

                  Ratio of the poster image

                  -
                • subtitleMetadataField: string

                  Field for subtitle metadata

                  -

                Settings

                Member Visibility
                +AVCenterPanelOptions | universalviewer
                universalviewer
                  Preparing search index...

                  Type Alias AVCenterPanelOptions

                  AVCenterPanelOptions: CenterPanelOptions & {
                      autoAdvanceRanges: boolean;
                      autoPlay: boolean;
                      enableFastForward: boolean;
                      enableFastRewind: boolean;
                      hideMediaError: boolean;
                      includeParentInTitleEnabled: boolean;
                      limitToRange: boolean;
                      posterImageExpanded: boolean;
                      posterImageRatio: number;
                      subtitleMetadataField: string;
                  }

                  Type Declaration

                  • autoAdvanceRanges: boolean

                    Determines if ranges auto advance

                    +
                  • autoPlay: boolean

                    Determines if auto play is enabled

                    +
                  • enableFastForward: boolean

                    Determines if fast forward is enabled

                    +
                  • enableFastRewind: boolean

                    Determines if fast rewind is enabled

                    +
                  • hideMediaError: boolean

                    Determines if media errors are hidden

                    +
                  • includeParentInTitleEnabled: boolean

                    Determines if parent is included in title

                    +
                  • limitToRange: boolean

                    Determines if limit is set to range

                    +
                  • posterImageExpanded: boolean

                    Determines if the poster image is expanded

                    +
                  • posterImageRatio: number

                    Ratio of the poster image

                    +
                  • subtitleMetadataField: string

                    Field for subtitle metadata

                    +

                  Settings

                  Member Visibility
                  diff --git a/docs/types/_internal_.AlephLeftPanelOptions.html b/docs/types/_internal_.AlephLeftPanelOptions.html index 8e03813fb..992115b98 100644 --- a/docs/types/_internal_.AlephLeftPanelOptions.html +++ b/docs/types/_internal_.AlephLeftPanelOptions.html @@ -1,5 +1,5 @@ -AlephLeftPanelOptions | universalviewer
                  universalviewer
                    Preparing search index...

                    Type Alias AlephLeftPanelOptions

                    AlephLeftPanelOptions: ExpandPanelOptions & {
                        consoleTabEnabled: boolean;
                        graphTabEnabled: boolean;
                        settingsTabEnabled: boolean;
                        srcTabEnabled: boolean;
                    }

                    Type declaration

                    • consoleTabEnabled: boolean

                      Determines if the console tab is enabled

                      -
                    • graphTabEnabled: boolean

                      Determines if the graph tab is enabled

                      -
                    • settingsTabEnabled: boolean

                      Determines if the settings tab is enabled

                      -
                    • srcTabEnabled: boolean

                      Determines if the source tab is enabled

                      -

                    Settings

                    Member Visibility
                    +AlephLeftPanelOptions | universalviewer
                    universalviewer
                      Preparing search index...

                      Type Alias AlephLeftPanelOptions

                      AlephLeftPanelOptions: ExpandPanelOptions & {
                          consoleTabEnabled: boolean;
                          graphTabEnabled: boolean;
                          settingsTabEnabled: boolean;
                          srcTabEnabled: boolean;
                      }

                      Type Declaration

                      • consoleTabEnabled: boolean

                        Determines if the console tab is enabled

                        +
                      • graphTabEnabled: boolean

                        Determines if the graph tab is enabled

                        +
                      • settingsTabEnabled: boolean

                        Determines if the settings tab is enabled

                        +
                      • srcTabEnabled: boolean

                        Determines if the source tab is enabled

                        +

                      Settings

                      Member Visibility
                      diff --git a/docs/types/_internal_.ContentLeftPanelOptions.html b/docs/types/_internal_.ContentLeftPanelOptions.html index 066cbd1ff..8ac2af108 100644 --- a/docs/types/_internal_.ContentLeftPanelOptions.html +++ b/docs/types/_internal_.ContentLeftPanelOptions.html @@ -1,24 +1,24 @@ -ContentLeftPanelOptions | universalviewer
                      universalviewer
                        Preparing search index...

                        Type Alias ContentLeftPanelOptions

                        ContentLeftPanelOptions: ExpandPanelOptions & {
                            autoExpandTreeEnabled: boolean;
                            autoExpandTreeIfFewerThan: number;
                            branchNodesExpandOnClick: boolean;
                            branchNodesSelectable: boolean;
                            defaultToTreeEnabled: boolean;
                            defaultToTreeIfCollection: boolean;
                            defaultToTreeIfGreaterThan: number;
                            galleryThumbChunkedResizingThreshold: number;
                            galleryThumbHeight: number;
                            galleryThumbLoadPadding: number;
                            galleryThumbWidth: number;
                            oneColThumbHeight: number;
                            oneColThumbWidth: number;
                            pageModeEnabled: boolean;
                            tabOrder: string;
                            thumbsCacheInvalidation: ThumbsCacheInvalidation;
                            thumbsEnabled: boolean;
                            thumbsExtraHeight: number;
                            thumbsImageFadeInDuration: number;
                            thumbsLoadRange: number;
                            treeEnabled: boolean;
                            twoColThumbHeight: number;
                            twoColThumbWidth: number;
                        }

                        Type declaration

                        • autoExpandTreeEnabled: boolean

                          Determines if tree should expand automatically

                          -
                        • autoExpandTreeIfFewerThan: number

                          Number of items to auto expand tree

                          -
                        • branchNodesExpandOnClick: boolean

                          Determines if branch nodes expand on click

                          -
                        • branchNodesSelectable: boolean

                          Determines if branch nodes are selectable

                          -
                        • defaultToTreeEnabled: boolean

                          Determines if tree is the default view

                          -
                        • defaultToTreeIfCollection: boolean

                          Determines if collection should default to tree view (even if defaultToTreeEnabled = false)

                          -
                        • defaultToTreeIfGreaterThan: number

                          Number of items to default to tree view (when defaultToTreeEnabled = true; defaults to 0)

                          -
                        • galleryThumbChunkedResizingThreshold: number

                          Threshold for gallery thumb chunked resizing

                          -
                        • galleryThumbHeight: number

                          Height of the gallery thumbnail

                          -
                        • galleryThumbLoadPadding: number

                          Padding for gallery thumb load

                          -
                        • galleryThumbWidth: number

                          Width of the gallery thumbnail

                          -
                        • oneColThumbHeight: number

                          Height of the one column thumbnail

                          -
                        • oneColThumbWidth: number

                          Width of the one column thumbnail

                          -
                        • pageModeEnabled: boolean

                          Determines if page mode is enabled

                          -
                        • tabOrder: string

                          Order of the tabs

                          -
                        • thumbsCacheInvalidation: ThumbsCacheInvalidation

                          Configuration for thumbs cache invalidation

                          -
                        • thumbsEnabled: boolean

                          Determines if thumbnails are enabled

                          -
                        • thumbsExtraHeight: number

                          Extra height for thumbnails

                          -
                        • thumbsImageFadeInDuration: number

                          Duration for thumbnails image fade in

                          -
                        • thumbsLoadRange: number

                          Load range for thumbnails

                          -
                        • treeEnabled: boolean

                          Determines if tree is enabled

                          -
                        • twoColThumbHeight: number

                          Height of the two column thumbnail

                          -
                        • twoColThumbWidth: number

                          Width of the two column thumbnail

                          -

                        Settings

                        Member Visibility
                        +ContentLeftPanelOptions | universalviewer
                        universalviewer
                          Preparing search index...

                          Type Alias ContentLeftPanelOptions

                          ContentLeftPanelOptions: ExpandPanelOptions & {
                              autoExpandTreeEnabled: boolean;
                              autoExpandTreeIfFewerThan: number;
                              branchNodesExpandOnClick: boolean;
                              branchNodesSelectable: boolean;
                              defaultToTreeEnabled: boolean;
                              defaultToTreeIfCollection: boolean;
                              defaultToTreeIfGreaterThan: number;
                              galleryThumbChunkedResizingThreshold: number;
                              galleryThumbHeight: number;
                              galleryThumbLoadPadding: number;
                              galleryThumbWidth: number;
                              oneColThumbHeight: number;
                              oneColThumbWidth: number;
                              pageModeEnabled: boolean;
                              tabOrder: string;
                              thumbsCacheInvalidation: ThumbsCacheInvalidation;
                              thumbsEnabled: boolean;
                              thumbsExtraHeight: number;
                              thumbsImageFadeInDuration: number;
                              thumbsLoadRange: number;
                              treeEnabled: boolean;
                              twoColThumbHeight: number;
                              twoColThumbWidth: number;
                          }

                          Type Declaration

                          • autoExpandTreeEnabled: boolean

                            Determines if tree should expand automatically

                            +
                          • autoExpandTreeIfFewerThan: number

                            Number of items to auto expand tree

                            +
                          • branchNodesExpandOnClick: boolean

                            Determines if branch nodes expand on click

                            +
                          • branchNodesSelectable: boolean

                            Determines if branch nodes are selectable

                            +
                          • defaultToTreeEnabled: boolean

                            Determines if tree is the default view

                            +
                          • defaultToTreeIfCollection: boolean

                            Determines if collection should default to tree view (even if defaultToTreeEnabled = false)

                            +
                          • defaultToTreeIfGreaterThan: number

                            Number of items to default to tree view (when defaultToTreeEnabled = true; defaults to 0)

                            +
                          • galleryThumbChunkedResizingThreshold: number

                            Threshold for gallery thumb chunked resizing

                            +
                          • galleryThumbHeight: number

                            Height of the gallery thumbnail

                            +
                          • galleryThumbLoadPadding: number

                            Padding for gallery thumb load

                            +
                          • galleryThumbWidth: number

                            Width of the gallery thumbnail

                            +
                          • oneColThumbHeight: number

                            Height of the one column thumbnail

                            +
                          • oneColThumbWidth: number

                            Width of the one column thumbnail

                            +
                          • pageModeEnabled: boolean

                            Determines if page mode is enabled

                            +
                          • tabOrder: string

                            Order of the tabs

                            +
                          • thumbsCacheInvalidation: ThumbsCacheInvalidation

                            Configuration for thumbs cache invalidation

                            +
                          • thumbsEnabled: boolean

                            Determines if thumbnails are enabled

                            +
                          • thumbsExtraHeight: number

                            Extra height for thumbnails

                            +
                          • thumbsImageFadeInDuration: number

                            Duration for thumbnails image fade in

                            +
                          • thumbsLoadRange: number

                            Load range for thumbnails

                            +
                          • treeEnabled: boolean

                            Determines if tree is enabled

                            +
                          • twoColThumbHeight: number

                            Height of the two column thumbnail

                            +
                          • twoColThumbWidth: number

                            Width of the two column thumbnail

                            +

                          Settings

                          Member Visibility
                          diff --git a/docs/types/_internal_.ExpandPanelOptions.html b/docs/types/_internal_.ExpandPanelOptions.html index 503f8cad4..4b136ca19 100644 --- a/docs/types/_internal_.ExpandPanelOptions.html +++ b/docs/types/_internal_.ExpandPanelOptions.html @@ -4,8 +4,8 @@ panelExpandedWidth panelOpen

                          Properties

                          expandFullEnabled: boolean

                          Determines if expand full is enabled

                          -
                          panelAnimationDuration: number

                          Determines the duration of the panel expand/collapse animation

                          -
                          panelCollapsedWidth: number

                          Width of the collapsed panel

                          -
                          panelExpandedWidth: number

                          Width of the expanded panel

                          -
                          panelOpen: boolean

                          Determines if the panel is open

                          -

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          +
                          panelAnimationDuration: number

                          Determines the duration of the panel expand/collapse animation

                          +
                          panelCollapsedWidth: number

                          Width of the collapsed panel

                          +
                          panelExpandedWidth: number

                          Width of the expanded panel

                          +
                          panelOpen: boolean

                          Determines if the panel is open

                          +

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          diff --git a/docs/types/_internal_.FooterPanelOptions.html b/docs/types/_internal_.FooterPanelOptions.html index 765b447b6..7033ae5ac 100644 --- a/docs/types/_internal_.FooterPanelOptions.html +++ b/docs/types/_internal_.FooterPanelOptions.html @@ -9,13 +9,13 @@ printEnabled shareEnabled

                          Properties

                          bookmarkEnabled: boolean

                          Determines if bookmarking is enabled

                          -
                          downloadEnabled: boolean

                          Determines if downloading is enabled

                          -
                          embedEnabled: boolean

                          Determines if embedding is enabled

                          -
                          feedbackEnabled: boolean

                          Determines if feedback is enabled

                          -
                          fullscreenEnabled: boolean

                          Determines if fullscreen mode is enabled

                          -
                          minimiseButtons: boolean

                          Determines if buttons are minimised

                          -
                          moreInfoEnabled: boolean

                          Determines if more information is enabled

                          -
                          openEnabled: boolean

                          Determines if opening is enabled

                          -
                          printEnabled: boolean

                          Determines if printing is enabled

                          -
                          shareEnabled: boolean

                          Determines if sharing is enabled

                          -

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          +
                          downloadEnabled: boolean

                          Determines if downloading is enabled

                          +
                          embedEnabled: boolean

                          Determines if embedding is enabled

                          +
                          feedbackEnabled: boolean

                          Determines if feedback is enabled

                          +
                          fullscreenEnabled: boolean

                          Determines if fullscreen mode is enabled

                          +
                          minimiseButtons: boolean

                          Determines if buttons are minimised

                          +
                          moreInfoEnabled: boolean

                          Determines if more information is enabled

                          +
                          openEnabled: boolean

                          Determines if opening is enabled

                          +
                          printEnabled: boolean

                          Determines if printing is enabled

                          +
                          shareEnabled: boolean

                          Determines if sharing is enabled

                          +

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          diff --git a/docs/types/_internal_.HeaderPanelOptions.html b/docs/types/_internal_.HeaderPanelOptions.html index d1add3aca..529692f19 100644 --- a/docs/types/_internal_.HeaderPanelOptions.html +++ b/docs/types/_internal_.HeaderPanelOptions.html @@ -4,7 +4,7 @@ localeToggleEnabled settingsButtonEnabled

                          Properties

                          centerOptionsEnabled: boolean

                          Determines if center options are enabled

                          -
                          helpEnabled?: boolean

                          Determines if help is enabled

                          -
                          helpUrl?: string
                          localeToggleEnabled: boolean

                          Determines if locale toggle is enabled

                          -
                          settingsButtonEnabled: boolean

                          Determines if settings button is enabled

                          -

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          +
                          helpEnabled?: boolean

                          Determines if help is enabled

                          +
                          helpUrl?: string
                          localeToggleEnabled: boolean

                          Determines if locale toggle is enabled

                          +
                          settingsButtonEnabled: boolean

                          Determines if settings button is enabled

                          +

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          diff --git a/docs/types/_internal_.ModelViewerCenterPanelOptions.html b/docs/types/_internal_.ModelViewerCenterPanelOptions.html index 212f0a5e8..0976b001c 100644 --- a/docs/types/_internal_.ModelViewerCenterPanelOptions.html +++ b/docs/types/_internal_.ModelViewerCenterPanelOptions.html @@ -1,5 +1,5 @@ -ModelViewerCenterPanelOptions | universalviewer
                          universalviewer
                            Preparing search index...

                            Type Alias ModelViewerCenterPanelOptions

                            ModelViewerCenterPanelOptions: CenterPanelOptions & {
                                autoRotateEnabled: boolean;
                                cameraChangeDelay: number;
                                doubleClickAnnotationEnabled: boolean;
                                interactionPromptEnabled: boolean;
                            }

                            Type declaration

                            • autoRotateEnabled: boolean

                              Determines if auto rotation is enabled

                              -
                            • cameraChangeDelay: number

                              Delay in camera change

                              -
                            • doubleClickAnnotationEnabled: boolean

                              Determines if double click annotation is enabled

                              -
                            • interactionPromptEnabled: boolean

                              Determines if interaction prompt is enabled

                              -

                            Settings

                            Member Visibility
                            +ModelViewerCenterPanelOptions | universalviewer
                            universalviewer
                              Preparing search index...

                              Type Alias ModelViewerCenterPanelOptions

                              ModelViewerCenterPanelOptions: CenterPanelOptions & {
                                  autoRotateEnabled: boolean;
                                  cameraChangeDelay: number;
                                  doubleClickAnnotationEnabled: boolean;
                                  interactionPromptEnabled: boolean;
                              }

                              Type Declaration

                              • autoRotateEnabled: boolean

                                Determines if auto rotation is enabled

                                +
                              • cameraChangeDelay: number

                                Delay in camera change

                                +
                              • doubleClickAnnotationEnabled: boolean

                                Determines if double click annotation is enabled

                                +
                              • interactionPromptEnabled: boolean

                                Determines if interaction prompt is enabled

                                +

                              Settings

                              Member Visibility
                              diff --git a/docs/types/_internal_.ModuleContent.html b/docs/types/_internal_.ModuleContent.html index f9ba48c35..52eb1484e 100644 --- a/docs/types/_internal_.ModuleContent.html +++ b/docs/types/_internal_.ModuleContent.html @@ -1 +1 @@ -ModuleContent | universalviewer
                              universalviewer
                                Preparing search index...

                                Type Alias ModuleContent

                                ModuleContent: {}

                                Type declaration

                                  Settings

                                  Member Visibility
                                  +ModuleContent | universalviewer
                                  universalviewer
                                    Preparing search index...

                                    Type Alias ModuleContent

                                    ModuleContent: {}

                                    Type Declaration

                                      Settings

                                      Member Visibility
                                      diff --git a/docs/types/_internal_.ModuleOptions.html b/docs/types/_internal_.ModuleOptions.html index e1892acab..c83620fe8 100644 --- a/docs/types/_internal_.ModuleOptions.html +++ b/docs/types/_internal_.ModuleOptions.html @@ -1 +1 @@ -ModuleOptions | universalviewer
                                      universalviewer
                                        Preparing search index...

                                        Type Alias ModuleOptions

                                        ModuleOptions: {}

                                        Type declaration

                                          Settings

                                          Member Visibility
                                          +ModuleOptions | universalviewer
                                          universalviewer
                                            Preparing search index...

                                            Type Alias ModuleOptions

                                            ModuleOptions: {}

                                            Type Declaration

                                              Settings

                                              Member Visibility
                                              diff --git a/docs/types/_internal_.MoreInfoRightPanelOptions.html b/docs/types/_internal_.MoreInfoRightPanelOptions.html index 2520ac25c..645b39519 100644 --- a/docs/types/_internal_.MoreInfoRightPanelOptions.html +++ b/docs/types/_internal_.MoreInfoRightPanelOptions.html @@ -1,11 +1,11 @@ -MoreInfoRightPanelOptions | universalviewer
                                              universalviewer
                                                Preparing search index...

                                                Type Alias MoreInfoRightPanelOptions

                                                MoreInfoRightPanelOptions: DialogueOptions & ExpandPanelOptions & {
                                                    canvasDisplayOrder: string;
                                                    canvasExclude: string;
                                                    copyToClipboardEnabled: boolean;
                                                    limitToRange: boolean;
                                                    manifestDisplayOrder: string;
                                                    manifestExclude: string;
                                                    rtlLanguageCodes: string;
                                                    showAllLanguages: boolean;
                                                    textLimit: number;
                                                    textLimitType: string;
                                                }

                                                Type declaration

                                                • canvasDisplayOrder: string

                                                  Order in which canvases are displayed

                                                  -
                                                • canvasExclude: string

                                                  Canvases to exclude from display

                                                  -
                                                • copyToClipboardEnabled: boolean

                                                  Determines if copying to clipboard is enabled

                                                  -
                                                • limitToRange: boolean

                                                  Determines if download is enabled

                                                  -
                                                • manifestDisplayOrder: string

                                                  Order in which manifests are displayed

                                                  -
                                                • manifestExclude: string

                                                  Manifests to exclude from display

                                                  -
                                                • rtlLanguageCodes: string

                                                  Language codes for right-to-left languages

                                                  -
                                                • showAllLanguages: boolean

                                                  Determines if all languages should be shown

                                                  -
                                                • textLimit: number

                                                  Limit for the text

                                                  -
                                                • textLimitType: string

                                                  Type of the text limit

                                                  -

                                                Settings

                                                Member Visibility
                                                +MoreInfoRightPanelOptions | universalviewer
                                                universalviewer
                                                  Preparing search index...

                                                  Type Alias MoreInfoRightPanelOptions

                                                  MoreInfoRightPanelOptions: DialogueOptions & ExpandPanelOptions & {
                                                      canvasDisplayOrder: string;
                                                      canvasExclude: string;
                                                      copyToClipboardEnabled: boolean;
                                                      limitToRange: boolean;
                                                      manifestDisplayOrder: string;
                                                      manifestExclude: string;
                                                      rtlLanguageCodes: string;
                                                      showAllLanguages: boolean;
                                                      textLimit: number;
                                                      textLimitType: string;
                                                  }

                                                  Type Declaration

                                                  • canvasDisplayOrder: string

                                                    Order in which canvases are displayed

                                                    +
                                                  • canvasExclude: string

                                                    Canvases to exclude from display

                                                    +
                                                  • copyToClipboardEnabled: boolean

                                                    Determines if copying to clipboard is enabled

                                                    +
                                                  • limitToRange: boolean

                                                    Determines if download is enabled

                                                    +
                                                  • manifestDisplayOrder: string

                                                    Order in which manifests are displayed

                                                    +
                                                  • manifestExclude: string

                                                    Manifests to exclude from display

                                                    +
                                                  • rtlLanguageCodes: string

                                                    Language codes for right-to-left languages

                                                    +
                                                  • showAllLanguages: boolean

                                                    Determines if all languages should be shown

                                                    +
                                                  • textLimit: number

                                                    Limit for the text

                                                    +
                                                  • textLimitType: string

                                                    Type of the text limit

                                                    +

                                                  Settings

                                                  Member Visibility
                                                  diff --git a/docs/types/_internal_.MultiSelectDialogueOptions.html b/docs/types/_internal_.MultiSelectDialogueOptions.html index c7ad72d76..45eaf2b09 100644 --- a/docs/types/_internal_.MultiSelectDialogueOptions.html +++ b/docs/types/_internal_.MultiSelectDialogueOptions.html @@ -1,6 +1,6 @@ -MultiSelectDialogueOptions | universalviewer
                                                  universalviewer
                                                    Preparing search index...

                                                    Type Alias MultiSelectDialogueOptions

                                                    MultiSelectDialogueOptions: DialogueOptions & {
                                                        galleryThumbChunkedResizingThreshold: number;
                                                        galleryThumbHeight: number;
                                                        galleryThumbLoadPadding: number;
                                                        galleryThumbWidth: number;
                                                        pageModeEnabled: boolean;
                                                    }

                                                    Type declaration

                                                    • galleryThumbChunkedResizingThreshold: number

                                                      Threshold for chunked resizing of gallery thumbnails

                                                      -
                                                    • galleryThumbHeight: number

                                                      Height of the gallery thumbnail

                                                      -
                                                    • galleryThumbLoadPadding: number

                                                      Padding for loading gallery thumbnails

                                                      -
                                                    • galleryThumbWidth: number

                                                      Width of the gallery thumbnail

                                                      -
                                                    • pageModeEnabled: boolean

                                                      Determines if page mode is enabled

                                                      -

                                                    Settings

                                                    Member Visibility
                                                    +MultiSelectDialogueOptions | universalviewer
                                                    universalviewer
                                                      Preparing search index...

                                                      Type Alias MultiSelectDialogueOptions

                                                      MultiSelectDialogueOptions: DialogueOptions & {
                                                          galleryThumbChunkedResizingThreshold: number;
                                                          galleryThumbHeight: number;
                                                          galleryThumbLoadPadding: number;
                                                          galleryThumbWidth: number;
                                                          pageModeEnabled: boolean;
                                                      }

                                                      Type Declaration

                                                      • galleryThumbChunkedResizingThreshold: number

                                                        Threshold for chunked resizing of gallery thumbnails

                                                        +
                                                      • galleryThumbHeight: number

                                                        Height of the gallery thumbnail

                                                        +
                                                      • galleryThumbLoadPadding: number

                                                        Padding for loading gallery thumbnails

                                                        +
                                                      • galleryThumbWidth: number

                                                        Width of the gallery thumbnail

                                                        +
                                                      • pageModeEnabled: boolean

                                                        Determines if page mode is enabled

                                                        +

                                                      Settings

                                                      Member Visibility
                                                      diff --git a/docs/types/_internal_.OSDDownloadDialogueOptions.html b/docs/types/_internal_.OSDDownloadDialogueOptions.html index c37b68827..349cbbfb0 100644 --- a/docs/types/_internal_.OSDDownloadDialogueOptions.html +++ b/docs/types/_internal_.OSDDownloadDialogueOptions.html @@ -1,8 +1,8 @@ -OSDDownloadDialogueOptions | universalviewer
                                                      universalviewer
                                                        Preparing search index...

                                                        Type Alias OSDDownloadDialogueOptions

                                                        OSDDownloadDialogueOptions: DownloadDialogueOptions & {
                                                            confinedImageSize: number;
                                                            downloadCurrentViewEnabled: boolean;
                                                            downloadWholeImageHighResEnabled: boolean;
                                                            downloadWholeImageLowResEnabled: boolean;
                                                            maxImageWidth: number;
                                                            minImageWidth: number;
                                                            selectionEnabled: boolean;
                                                        }

                                                        Type declaration

                                                        • confinedImageSize: number

                                                          Size of the confined image

                                                          -
                                                        • downloadCurrentViewEnabled: boolean

                                                          Determines if download of current view is enabled

                                                          -
                                                        • downloadWholeImageHighResEnabled: boolean

                                                          Determines if download of whole image in high resolution is enabled

                                                          -
                                                        • downloadWholeImageLowResEnabled: boolean

                                                          Determines if download of whole image in low resolution is enabled

                                                          -
                                                        • maxImageWidth: number

                                                          Maximum width of the image

                                                          -
                                                        • minImageWidth: number

                                                          Minimum width of the downloadable image

                                                          -
                                                        • selectionEnabled: boolean

                                                          Determines if selection is enabled

                                                          -

                                                        Settings

                                                        Member Visibility
                                                        +OSDDownloadDialogueOptions | universalviewer
                                                        universalviewer
                                                          Preparing search index...

                                                          Type Alias OSDDownloadDialogueOptions

                                                          OSDDownloadDialogueOptions: DownloadDialogueOptions & {
                                                              confinedImageSize: number;
                                                              downloadCurrentViewEnabled: boolean;
                                                              downloadWholeImageHighResEnabled: boolean;
                                                              downloadWholeImageLowResEnabled: boolean;
                                                              maxImageWidth: number;
                                                              minImageWidth: number;
                                                              selectionEnabled: boolean;
                                                          }

                                                          Type Declaration

                                                          • confinedImageSize: number

                                                            Size of the confined image

                                                            +
                                                          • downloadCurrentViewEnabled: boolean

                                                            Determines if download of current view is enabled

                                                            +
                                                          • downloadWholeImageHighResEnabled: boolean

                                                            Determines if download of whole image in high resolution is enabled

                                                            +
                                                          • downloadWholeImageLowResEnabled: boolean

                                                            Determines if download of whole image in low resolution is enabled

                                                            +
                                                          • maxImageWidth: number

                                                            Maximum width of the image

                                                            +
                                                          • minImageWidth: number

                                                            Minimum width of the downloadable image

                                                            +
                                                          • selectionEnabled: boolean

                                                            Determines if selection is enabled

                                                            +

                                                          Settings

                                                          Member Visibility
                                                          diff --git a/docs/types/_internal_.OpenSeadragonCenterPanelOptions.html b/docs/types/_internal_.OpenSeadragonCenterPanelOptions.html index 73b958da5..6632ce7e5 100644 --- a/docs/types/_internal_.OpenSeadragonCenterPanelOptions.html +++ b/docs/types/_internal_.OpenSeadragonCenterPanelOptions.html @@ -1,20 +1,20 @@ -OpenSeadragonCenterPanelOptions | universalviewer
                                                          universalviewer
                                                            Preparing search index...

                                                            Type Alias OpenSeadragonCenterPanelOptions

                                                            OpenSeadragonCenterPanelOptions: CenterPanelOptions & {
                                                                animationTime: number;
                                                                autoHideControls: boolean;
                                                                blendTime: number;
                                                                constrainDuringPan: boolean;
                                                                controlsFadeAfterInactive: number;
                                                                controlsFadeDelay: number;
                                                                controlsFadeLength: number;
                                                                defaultZoomLevel: number;
                                                                doubleClickAnnotationEnabled: boolean;
                                                                immediateRender: boolean;
                                                                maxZoomPixelRatio: number;
                                                                navigatorPosition: string;
                                                                pageGap: number;
                                                                requiredStatementEnabled: boolean;
                                                                showAdjustImageControl: boolean;
                                                                showHomeControl: boolean;
                                                                tileTimeout: number;
                                                                visibilityRatio: number;
                                                                zoomToInitialAnnotation: boolean;
                                                            }

                                                            Type declaration

                                                            • animationTime: number

                                                              Duration of the animation

                                                              -
                                                            • autoHideControls: boolean

                                                              Determines if controls are hidden automatically

                                                              -
                                                            • blendTime: number

                                                              Time taken to blend images

                                                              -
                                                            • constrainDuringPan: boolean

                                                              Determines if panning is constrained

                                                              -
                                                            • controlsFadeAfterInactive: number

                                                              Time after which controls fade after inactivity

                                                              -
                                                            • controlsFadeDelay: number

                                                              Delay before controls start to fade

                                                              -
                                                            • controlsFadeLength: number

                                                              Duration of controls fade

                                                              -
                                                            • defaultZoomLevel: number

                                                              Default zoom level

                                                              -
                                                            • doubleClickAnnotationEnabled: boolean

                                                              Determines if annotation is enabled

                                                              -
                                                            • immediateRender: boolean

                                                              Determines if rendering is immediate

                                                              -
                                                            • maxZoomPixelRatio: number

                                                              Maximum pixel ratio for zoom

                                                              -
                                                            • navigatorPosition: string

                                                              Position of the navigator

                                                              -
                                                            • pageGap: number

                                                              Gap between pages

                                                              -
                                                            • requiredStatementEnabled: boolean

                                                              Determines if required statement is enabled

                                                              -
                                                            • showAdjustImageControl: boolean

                                                              Determines if adjust image control is shown

                                                              -
                                                            • showHomeControl: boolean

                                                              Determines if home control is shown

                                                              -
                                                            • tileTimeout: number

                                                              The maximum amount of time in milliseconds an image operation can take

                                                              -
                                                            • visibilityRatio: number

                                                              Ratio of visibility

                                                              -
                                                            • zoomToInitialAnnotation: boolean

                                                              Whether to zoom in to first annotation on load

                                                              -

                                                            Settings

                                                            Member Visibility
                                                            +OpenSeadragonCenterPanelOptions | universalviewer
                                                            universalviewer
                                                              Preparing search index...

                                                              Type Alias OpenSeadragonCenterPanelOptions

                                                              OpenSeadragonCenterPanelOptions: CenterPanelOptions & {
                                                                  animationTime: number;
                                                                  autoHideControls: boolean;
                                                                  blendTime: number;
                                                                  constrainDuringPan: boolean;
                                                                  controlsFadeAfterInactive: number;
                                                                  controlsFadeDelay: number;
                                                                  controlsFadeLength: number;
                                                                  defaultZoomLevel: number;
                                                                  doubleClickAnnotationEnabled: boolean;
                                                                  immediateRender: boolean;
                                                                  maxZoomPixelRatio: number;
                                                                  navigatorPosition: string;
                                                                  pageGap: number;
                                                                  requiredStatementEnabled: boolean;
                                                                  showAdjustImageControl: boolean;
                                                                  showHomeControl: boolean;
                                                                  tileTimeout: number;
                                                                  visibilityRatio: number;
                                                                  zoomToInitialAnnotation: boolean;
                                                              }

                                                              Type Declaration

                                                              • animationTime: number

                                                                Duration of the animation

                                                                +
                                                              • autoHideControls: boolean

                                                                Determines if controls are hidden automatically

                                                                +
                                                              • blendTime: number

                                                                Time taken to blend images

                                                                +
                                                              • constrainDuringPan: boolean

                                                                Determines if panning is constrained

                                                                +
                                                              • controlsFadeAfterInactive: number

                                                                Time after which controls fade after inactivity

                                                                +
                                                              • controlsFadeDelay: number

                                                                Delay before controls start to fade

                                                                +
                                                              • controlsFadeLength: number

                                                                Duration of controls fade

                                                                +
                                                              • defaultZoomLevel: number

                                                                Default zoom level

                                                                +
                                                              • doubleClickAnnotationEnabled: boolean

                                                                Determines if annotation is enabled

                                                                +
                                                              • immediateRender: boolean

                                                                Determines if rendering is immediate

                                                                +
                                                              • maxZoomPixelRatio: number

                                                                Maximum pixel ratio for zoom

                                                                +
                                                              • navigatorPosition: string

                                                                Position of the navigator

                                                                +
                                                              • pageGap: number

                                                                Gap between pages

                                                                +
                                                              • requiredStatementEnabled: boolean

                                                                Determines if required statement is enabled

                                                                +
                                                              • showAdjustImageControl: boolean

                                                                Determines if adjust image control is shown

                                                                +
                                                              • showHomeControl: boolean

                                                                Determines if home control is shown

                                                                +
                                                              • tileTimeout: number

                                                                The maximum amount of time in milliseconds an image operation can take

                                                                +
                                                              • visibilityRatio: number

                                                                Ratio of visibility

                                                                +
                                                              • zoomToInitialAnnotation: boolean

                                                                Whether to zoom in to first annotation on load

                                                                +

                                                              Settings

                                                              Member Visibility
                                                              diff --git a/docs/types/_internal_.Options.html b/docs/types/_internal_.Options.html index f038cc661..f7996f53b 100644 --- a/docs/types/_internal_.Options.html +++ b/docs/types/_internal_.Options.html @@ -28,32 +28,32 @@ zoomToBoundsEnabled? zoomToSearchResultEnabled?

                                                              Properties

                                                              allowStealFocus?: boolean

                                                              Determines if the focus can be stolen

                                                              -
                                                              animationDuration?: number

                                                              A default animation duration

                                                              -
                                                              authAPIVersion: number

                                                              Version of the authentication API

                                                              -
                                                              bookmarkThumbHeight?: number

                                                              Height of the bookmark thumbnail

                                                              -
                                                              bookmarkThumbWidth?: number

                                                              Width of the bookmark thumbnail

                                                              -
                                                              clickToZoomEnabled?: boolean

                                                              Determines if click to zoom is enabled

                                                              -
                                                              doubleClickAnnotationEnabled?: boolean

                                                              Determines if double click annotation is enabled

                                                              -
                                                              dropEnabled?: boolean

                                                              Determines if drop is enabled

                                                              -
                                                              footerPanelEnabled?: boolean

                                                              Determines if the footer panel is enabled

                                                              -
                                                              headerPanelEnabled?: boolean

                                                              Determines if the header panel is enabled

                                                              -
                                                              leftPanelEnabled?: boolean

                                                              Determines if the left panel is enabled

                                                              -
                                                              limitLocales?: boolean

                                                              Determines if locales are limited

                                                              -
                                                              metrics: Metric[]

                                                              Metrics array

                                                              -
                                                              multiSelectionMimeType: string

                                                              MIME type for multi selection

                                                              -
                                                              navigatorEnabled?: boolean

                                                              Determines if the navigator is enabled

                                                              -
                                                              openTemplate: string

                                                              Template for opening

                                                              -
                                                              overrideFullScreen: boolean

                                                              Determines if full screen is overridden

                                                              -
                                                              pagingEnabled?: boolean

                                                              Determines if paging is enabled

                                                              -
                                                              preferMediaElementExtension?: boolean

                                                              Determines if the mediaelement extension should be preferred

                                                              -
                                                              preserveViewport?: boolean

                                                              Determines if viewport is preserved

                                                              -
                                                              reducedAnimation?: boolean

                                                              Controls whether to have animations or not

                                                              -
                                                              rightPanelEnabled?: boolean

                                                              Determines if the right panel is enabled

                                                              -
                                                              saveUserSettings?: boolean

                                                              Determines if user settings are saved

                                                              -
                                                              searchWithinEnabled?: boolean

                                                              Determines if search within is enabled

                                                              -
                                                              termsOfUseEnabled: boolean

                                                              Determines if terms of use are enabled

                                                              -
                                                              tokenStorage: string | StorageType

                                                              Storage for tokens

                                                              -
                                                              useArrowKeysToNavigate?: boolean

                                                              Determines if arrow keys can be used to navigate

                                                              -
                                                              zoomToBoundsEnabled?: boolean

                                                              Determines if zoom to bounds is enabled

                                                              -
                                                              zoomToSearchResultEnabled?: boolean

                                                              Determines if zoom to search result is enabled

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Properties
                                                              +
                                                              animationDuration?: number

                                                              A default animation duration

                                                              +
                                                              authAPIVersion: number

                                                              Version of the authentication API

                                                              +
                                                              bookmarkThumbHeight?: number

                                                              Height of the bookmark thumbnail

                                                              +
                                                              bookmarkThumbWidth?: number

                                                              Width of the bookmark thumbnail

                                                              +
                                                              clickToZoomEnabled?: boolean

                                                              Determines if click to zoom is enabled

                                                              +
                                                              doubleClickAnnotationEnabled?: boolean

                                                              Determines if double click annotation is enabled

                                                              +
                                                              dropEnabled?: boolean

                                                              Determines if drop is enabled

                                                              +
                                                              footerPanelEnabled?: boolean

                                                              Determines if the footer panel is enabled

                                                              +
                                                              headerPanelEnabled?: boolean

                                                              Determines if the header panel is enabled

                                                              +
                                                              leftPanelEnabled?: boolean

                                                              Determines if the left panel is enabled

                                                              +
                                                              limitLocales?: boolean

                                                              Determines if locales are limited

                                                              +
                                                              metrics: Metric[]

                                                              Metrics array

                                                              +
                                                              multiSelectionMimeType: string

                                                              MIME type for multi selection

                                                              +
                                                              navigatorEnabled?: boolean

                                                              Determines if the navigator is enabled

                                                              +
                                                              openTemplate: string

                                                              Template for opening

                                                              +
                                                              overrideFullScreen: boolean

                                                              Determines if full screen is overridden

                                                              +
                                                              pagingEnabled?: boolean

                                                              Determines if paging is enabled

                                                              +
                                                              preferMediaElementExtension?: boolean

                                                              Determines if the mediaelement extension should be preferred

                                                              +
                                                              preserveViewport?: boolean

                                                              Determines if viewport is preserved

                                                              +
                                                              reducedAnimation?: boolean

                                                              Controls whether to have animations or not

                                                              +
                                                              rightPanelEnabled?: boolean

                                                              Determines if the right panel is enabled

                                                              +
                                                              saveUserSettings?: boolean

                                                              Determines if user settings are saved

                                                              +
                                                              searchWithinEnabled?: boolean

                                                              Determines if search within is enabled

                                                              +
                                                              termsOfUseEnabled: boolean

                                                              Determines if terms of use are enabled

                                                              +
                                                              tokenStorage: string | StorageType

                                                              Storage for tokens

                                                              +
                                                              useArrowKeysToNavigate?: boolean

                                                              Determines if arrow keys can be used to navigate

                                                              +
                                                              zoomToBoundsEnabled?: boolean

                                                              Determines if zoom to bounds is enabled

                                                              +
                                                              zoomToSearchResultEnabled?: boolean

                                                              Determines if zoom to search result is enabled

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Properties
                                                              diff --git a/docs/types/_internal_.PDFCenterPanelOptions.html b/docs/types/_internal_.PDFCenterPanelOptions.html index ed995953a..0f224dbc9 100644 --- a/docs/types/_internal_.PDFCenterPanelOptions.html +++ b/docs/types/_internal_.PDFCenterPanelOptions.html @@ -1,4 +1,4 @@ -PDFCenterPanelOptions | universalviewer
                                                              universalviewer
                                                                Preparing search index...

                                                                Type Alias PDFCenterPanelOptions

                                                                PDFCenterPanelOptions: CenterPanelOptions & {
                                                                    maxScale: number;
                                                                    minScale: number;
                                                                    usePdfJs: boolean;
                                                                }

                                                                Type declaration

                                                                • maxScale: number

                                                                  Maximum scale value when using PDF.js

                                                                  -
                                                                • minScale: number

                                                                  Minimum scale value when using PDF.js

                                                                  -
                                                                • usePdfJs: boolean

                                                                  Determines if PDF.js should be used for PDF rendering

                                                                  -

                                                                Settings

                                                                Member Visibility
                                                                +PDFCenterPanelOptions | universalviewer
                                                                universalviewer
                                                                  Preparing search index...

                                                                  Type Alias PDFCenterPanelOptions

                                                                  PDFCenterPanelOptions: CenterPanelOptions & {
                                                                      maxScale: number;
                                                                      minScale: number;
                                                                      usePdfJs: boolean;
                                                                  }

                                                                  Type Declaration

                                                                  • maxScale: number

                                                                    Maximum scale value when using PDF.js

                                                                    +
                                                                  • minScale: number

                                                                    Minimum scale value when using PDF.js

                                                                    +
                                                                  • usePdfJs: boolean

                                                                    Determines if PDF.js should be used for PDF rendering

                                                                    +

                                                                  Settings

                                                                  Member Visibility
                                                                  diff --git a/docs/types/_internal_.PagingHeaderPanelOptions.html b/docs/types/_internal_.PagingHeaderPanelOptions.html index ab6ca4e16..f951c8b3d 100644 --- a/docs/types/_internal_.PagingHeaderPanelOptions.html +++ b/docs/types/_internal_.PagingHeaderPanelOptions.html @@ -1,8 +1,8 @@ -PagingHeaderPanelOptions | universalviewer
                                                                  universalviewer
                                                                    Preparing search index...

                                                                    Type Alias PagingHeaderPanelOptions

                                                                    PagingHeaderPanelOptions: HeaderPanelOptions & {
                                                                        autocompleteAllowWords: boolean;
                                                                        autoCompleteBoxEnabled: boolean;
                                                                        galleryButtonEnabled: boolean;
                                                                        imageSelectionBoxEnabled: boolean;
                                                                        modeOptionsEnabled: boolean;
                                                                        pageModeEnabled: boolean;
                                                                        pagingToggleEnabled: boolean;
                                                                    }

                                                                    Type declaration

                                                                    • autocompleteAllowWords: boolean

                                                                      Determines if autocomplete for words is allowed

                                                                      -
                                                                    • autoCompleteBoxEnabled: boolean

                                                                      Determines if autocomplete box is enabled

                                                                      -
                                                                    • galleryButtonEnabled: boolean

                                                                      Determines if gallery button is enabled

                                                                      -
                                                                    • imageSelectionBoxEnabled: boolean

                                                                      Determines if image selection box is enabled

                                                                      -
                                                                    • modeOptionsEnabled: boolean

                                                                      Determines if mode options is enabled

                                                                      -
                                                                    • pageModeEnabled: boolean

                                                                      Determines if page mode is enabled

                                                                      -
                                                                    • pagingToggleEnabled: boolean

                                                                      Determines if paging toggle is enabled

                                                                      -

                                                                    Settings

                                                                    Member Visibility
                                                                    +PagingHeaderPanelOptions | universalviewer
                                                                    universalviewer
                                                                      Preparing search index...

                                                                      Type Alias PagingHeaderPanelOptions

                                                                      PagingHeaderPanelOptions: HeaderPanelOptions & {
                                                                          autocompleteAllowWords: boolean;
                                                                          autoCompleteBoxEnabled: boolean;
                                                                          galleryButtonEnabled: boolean;
                                                                          imageSelectionBoxEnabled: boolean;
                                                                          modeOptionsEnabled: boolean;
                                                                          pageModeEnabled: boolean;
                                                                          pagingToggleEnabled: boolean;
                                                                      }

                                                                      Type Declaration

                                                                      • autocompleteAllowWords: boolean

                                                                        Determines if autocomplete for words is allowed

                                                                        +
                                                                      • autoCompleteBoxEnabled: boolean

                                                                        Determines if autocomplete box is enabled

                                                                        +
                                                                      • galleryButtonEnabled: boolean

                                                                        Determines if gallery button is enabled

                                                                        +
                                                                      • imageSelectionBoxEnabled: boolean

                                                                        Determines if image selection box is enabled

                                                                        +
                                                                      • modeOptionsEnabled: boolean

                                                                        Determines if mode options is enabled

                                                                        +
                                                                      • pageModeEnabled: boolean

                                                                        Determines if page mode is enabled

                                                                        +
                                                                      • pagingToggleEnabled: boolean

                                                                        Determines if paging toggle is enabled

                                                                        +

                                                                      Settings

                                                                      Member Visibility
                                                                      diff --git a/docs/types/_internal_.SearchFooterPanelOptions.html b/docs/types/_internal_.SearchFooterPanelOptions.html index 37a825d1c..83308c130 100644 --- a/docs/types/_internal_.SearchFooterPanelOptions.html +++ b/docs/types/_internal_.SearchFooterPanelOptions.html @@ -1,7 +1,7 @@ -SearchFooterPanelOptions | universalviewer
                                                                      universalviewer
                                                                        Preparing search index...

                                                                        Type Alias SearchFooterPanelOptions

                                                                        SearchFooterPanelOptions: FooterPanelOptions & {
                                                                            autocompleteAllowWords: boolean;
                                                                            elideDetailsTermsCount: number;
                                                                            elideResultsTermsCount: number;
                                                                            forceImageMode: boolean;
                                                                            pageModeEnabled: boolean;
                                                                            positionMarkerEnabled: boolean;
                                                                        }

                                                                        Type declaration

                                                                        • autocompleteAllowWords: boolean

                                                                          Determines if autocomplete for words is allowed

                                                                          -
                                                                        • elideDetailsTermsCount: number

                                                                          Number of terms to elide in details

                                                                          -
                                                                        • elideResultsTermsCount: number

                                                                          Number of terms to elide in results

                                                                          -
                                                                        • forceImageMode: boolean

                                                                          Determines if image mode is forced

                                                                          -
                                                                        • pageModeEnabled: boolean

                                                                          Determines if page mode is enabled

                                                                          -
                                                                        • positionMarkerEnabled: boolean

                                                                          Determines if position marker is enabled

                                                                          -

                                                                        Settings

                                                                        Member Visibility
                                                                        +SearchFooterPanelOptions | universalviewer
                                                                        universalviewer
                                                                          Preparing search index...

                                                                          Type Alias SearchFooterPanelOptions

                                                                          SearchFooterPanelOptions: FooterPanelOptions & {
                                                                              autocompleteAllowWords: boolean;
                                                                              elideDetailsTermsCount: number;
                                                                              elideResultsTermsCount: number;
                                                                              forceImageMode: boolean;
                                                                              pageModeEnabled: boolean;
                                                                              positionMarkerEnabled: boolean;
                                                                          }

                                                                          Type Declaration

                                                                          • autocompleteAllowWords: boolean

                                                                            Determines if autocomplete for words is allowed

                                                                            +
                                                                          • elideDetailsTermsCount: number

                                                                            Number of terms to elide in details

                                                                            +
                                                                          • elideResultsTermsCount: number

                                                                            Number of terms to elide in results

                                                                            +
                                                                          • forceImageMode: boolean

                                                                            Determines if image mode is forced

                                                                            +
                                                                          • pageModeEnabled: boolean

                                                                            Determines if page mode is enabled

                                                                            +
                                                                          • positionMarkerEnabled: boolean

                                                                            Determines if position marker is enabled

                                                                            +

                                                                          Settings

                                                                          Member Visibility
                                                                          diff --git a/docs/types/_internal_.ShareDialogueOptions.html b/docs/types/_internal_.ShareDialogueOptions.html index 1869b3f94..609fde1f1 100644 --- a/docs/types/_internal_.ShareDialogueOptions.html +++ b/docs/types/_internal_.ShareDialogueOptions.html @@ -1,9 +1,9 @@ -ShareDialogueOptions | universalviewer
                                                                          universalviewer
                                                                            Preparing search index...

                                                                            Type Alias ShareDialogueOptions

                                                                            ShareDialogueOptions: DialogueOptions & {
                                                                                copyToClipboardEnabled: boolean;
                                                                                embedEnabled: boolean;
                                                                                embedHost?: string;
                                                                                embedPath: string;
                                                                                embedPort?: number;
                                                                                embedTemplate: string;
                                                                                shareEnabled: boolean;
                                                                                shareManifestsEnabled: boolean;
                                                                            }

                                                                            Type declaration

                                                                            • copyToClipboardEnabled: boolean

                                                                              Determines if copy buttons are enabled

                                                                              -
                                                                            • embedEnabled: boolean

                                                                              Determines if embed is enabled

                                                                              -
                                                                            • OptionalembedHost?: string

                                                                              Set host for embed code (default: window.location.hostname)

                                                                              -
                                                                            • embedPath: string

                                                                              Set path to uv.html on embed host (default: /uv.html)

                                                                              -
                                                                            • OptionalembedPort?: number

                                                                              Set port for embed code (default: window.location.protocol)

                                                                              -
                                                                            • embedTemplate: string

                                                                              Template for embedding

                                                                              -
                                                                            • shareEnabled: boolean

                                                                              Determines if sharing is enabled

                                                                              -
                                                                            • shareManifestsEnabled: boolean

                                                                              Determines if sharing manifests is enabled

                                                                              -

                                                                            Settings

                                                                            Member Visibility
                                                                            +ShareDialogueOptions | universalviewer
                                                                            universalviewer
                                                                              Preparing search index...

                                                                              Type Alias ShareDialogueOptions

                                                                              ShareDialogueOptions: DialogueOptions & {
                                                                                  copyToClipboardEnabled: boolean;
                                                                                  embedEnabled: boolean;
                                                                                  embedHost?: string;
                                                                                  embedPath: string;
                                                                                  embedPort?: number;
                                                                                  embedTemplate: string;
                                                                                  shareEnabled: boolean;
                                                                                  shareManifestsEnabled: boolean;
                                                                              }

                                                                              Type Declaration

                                                                              • copyToClipboardEnabled: boolean

                                                                                Determines if copy buttons are enabled

                                                                                +
                                                                              • embedEnabled: boolean

                                                                                Determines if embed is enabled

                                                                                +
                                                                              • OptionalembedHost?: string

                                                                                Set host for embed code (default: window.location.hostname)

                                                                                +
                                                                              • embedPath: string

                                                                                Set path to uv.html on embed host (default: /uv.html)

                                                                                +
                                                                              • OptionalembedPort?: number

                                                                                Set port for embed code (default: window.location.protocol)

                                                                                +
                                                                              • embedTemplate: string

                                                                                Template for embedding

                                                                                +
                                                                              • shareEnabled: boolean

                                                                                Determines if sharing is enabled

                                                                                +
                                                                              • shareManifestsEnabled: boolean

                                                                                Determines if sharing manifests is enabled

                                                                                +

                                                                              Settings

                                                                              Member Visibility
                                                                              diff --git a/docs/types/_internal_.ThumbsCacheInvalidation.html b/docs/types/_internal_.ThumbsCacheInvalidation.html index d8ee75dc9..10f2b043d 100644 --- a/docs/types/_internal_.ThumbsCacheInvalidation.html +++ b/docs/types/_internal_.ThumbsCacheInvalidation.html @@ -1,5 +1,5 @@ ThumbsCacheInvalidation | universalviewer
                                                                              universalviewer
                                                                                Preparing search index...

                                                                                Type Alias ThumbsCacheInvalidation

                                                                                type ThumbsCacheInvalidation = {
                                                                                    enabled: boolean;
                                                                                    paramType: string;
                                                                                }
                                                                                Index

                                                                                Properties

                                                                                enabled paramType

                                                                                Properties

                                                                                enabled: boolean

                                                                                Determines if cache invalidation is enabled

                                                                                -
                                                                                paramType: string

                                                                                Type of the parameter for cache invalidation

                                                                                -

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties
                                                                                +
                                                                                paramType: string

                                                                                Type of the parameter for cache invalidation

                                                                                +

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties