diff --git a/docs/assets/icons.js b/docs/assets/icons.js new file mode 100644 index 0000000..b79c9e8 --- /dev/null +++ b/docs/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg new file mode 100644 index 0000000..7dead61 --- /dev/null +++ b/docs/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 3092fea..d6f1388 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,8 +1,8 @@ "use strict"; -"use strict";(()=>{var Ie=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ie(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(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,u],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(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,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),l=0;l1?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 se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.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()}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){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}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&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}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="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}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(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",H="mouseup",J={x:0,y:0},fe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",pe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,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){D||(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(!D&&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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){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)}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(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-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(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,u],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(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=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),l=0;l1?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 se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;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){re.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&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");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&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").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&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}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="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}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(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,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){D||(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(!D&&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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{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()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(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-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index d60104e..36c5523 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43UW0/CMBQH8O9SX/HCRaK8GcCEBxMNxAcNMXXrxoldS7ozbobvblHXtbt0vAH9n18PbXPevwmyHZIRgYTGjHTImuJKf01kmHGWXv/+fLXChOu1LxAhGfU6JFgBDxUTZPRugHlAOVvs1xbCRJbkhFl2sbtjxwjTDRM4oUgLIeA0TU0bJuAa3Z6tPFLgmWKtWDnnNUFQ3i46KZ83O+VnIpJNlAm0Ks+wZhwE80p5yK/FzUbsrRTIVMJCoNh+7LVhn/4gdCGycOY+UDg5EQ0M7ORKL/Z2WD62qVJSebQi1ErlhzuWIoJ4zhBBxG10bZFvq5eMcsC9+2gqtpVq7fsV2HahdPFYH1ss1b5wN1QB/eRuy5W8u0O/Z20QM2x4nVEmAgQpcrqcdNHhwEJBAIL+fwcPV2Q8ULrKcCK3opnJExVkafdzil4GkksVAdc30TA+P6zIWaMURIqU8yfY6U+NTTqsU+Lt+iBl0jDszdKZXVavo166cKJ/6KB7P+jf2Lfypmtqh1CB/Ueq42J5XP4AtLWicssGAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42VyU7DMBBA/yVcy9JStt5QWdQDAgTiAKqQSSbuCGdcOROgIP4dF8jiLE6Pjt+8GY3H8dNXwPDBwSTAREgIBsFS8MIuEx1lCtLd3887C06U3XtFioLJaBCEC1SRAQomT4XgLhQK7lfLigQoS3JFse3Kjr8HheH8DYjPBIvSECqRpkUZBeA6hqOq5UKgygz0yuqc14kkVL/RoXy+2ZqfUay7VAXQa7nBJSgk8JpyyG+T3Q7pjSQGk0CEgvvb3gr77KdkAxmimTuguPbEIizEDleb2IPDetvOjdHGYyuhXlXe3KmmGOUdMCPJPnVrkC/VbSYU8sodmoa7Qvlkl8A28XpxYXRyvWTUlE6FUi8ifC31bK9rbvaG1HLtnRwND0b1Pj0gvN8bW+zUHpPUZlUmehMGxYtyW9Tg3Sz71QQSuOM2xBmFv7X+q+ukKz0cV6RIyGj7+enRlYxHZEBiak/qRmUSqbWT3Rk2CPakThcZn+l36vbnREMyr7ZijW6HWmkTo7LVdLwUzxVko1cDKWU7RFf4gZ4mOFonxFv1p9ZJx7tWbG1YZXMS2k1bDvonHQ9Pxvt71VN5tDGt/9tS9o80/4zz7/kPQNFG4bYHAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 27edd90..d1fc6dd 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VdW3fbuBH+L/Kr1yvwzrztOkmb06a7TdLtJSdnDyNRNhuJdEkqiTcn/70ESJAz4AxFSPRTImtuwDfAAB8I6tuqLL5Uq2fvv60+Zfl29cy5XuXJIV09W2WH5C5dXa+O5b75dCi2x31a/aj+enNfH/bNV5t9UlVpo75afb/WFgJvMJFndZbssz8GO7tjvqmzIteWBhHC6PXqISnTvO6jIb1U98f6efElZ31ogbM93KX1K/ntr9lDus9yvjWmoJ1Hxw96l38/Np1SP77Kd0XvLcvrtNwlmx4GIGTpae1FsHWdofmerpDShFOoyQWQVb/sXh73e/soxpoLhPKnoti+yIvj3f15AVH69mEJZ4hK5RRKhc5eF0b/vV0W+GIY7ZsmievyuKmLcpaTK6ww1b4hej4B/5xmd/f1PM9Q/FK//8y29f1st1r6Uq/U4D7lG+tYRwCmFvX9i7IESI8Se5C5bGJ5nVYVLCOnHF0hnZOtbFvBu1ffv3t8sAsAal0WQl28rcssv5vvHmhYu4ZTxovPjfjzpE6YBOu/f8opAzuxmDKG6EHr1s5QkVMp8Df5/1meofhFfouP/0033DxlOO1lrT0CHF9mebI/BSYWekpECU8WsBqNORNbKoa5AM+LYBJlyv0sqOf5zk7Ueso91Lk8giTflkW2tfA/aCzQ/qKyabmSPs8rXGDJafmQbrOkTk8NNlL2SRderEObRRjZwjNH4EREcweiVTyT43EimFnD0iqSU6NzIpi5g/RkPLA6JNn+WJ5MWVPsSSsE5YtN1Lra/pBVP2T5fVpmdbolxq/ZRC5n0YJ2TkxaY3L2mOv9VM2iIyAHy3J9Ml3HyJCIIXNRPHDj8VPeiDcGXiFmabQkRmIXbD+qOilrGzdXWmMqI3AjWNfFg6VnpXCx46x6c8zzyR0H4R1qnRPCiKsYEWXE7vY8juwMzgI5suUt+pawHf4q/zmrD8nD6/RQlI+3yeZ+frOvOPWL42q2scrWX9LH+dFgpUX65nlWfTqjT6DaxXGkn7NN/bIsDmdBxGgvF9UZXUTqLhfRudEsFslmnyalssZtBqiRjZSWiQFgbhuJobpMPD3ettEgxYtjeSjTXVpv7t8VZyQvrbxgTGcNc079nLiGoN5ukn2KCMg0Px50GP23djVQDEuqTSrL+wzjV73kVIOGcCe83ZZgcXPSYyd9sddXeZVt53TjlSF/geddVt/O7mAofJnPF/l2psNW8jJvb9Eyedrf2xkL5NMe//Xvme6U4CW+is2xmpuuUNjW5+h4RU8Kt0W+y+7epnV9+hSA1LGcGRBXUclD7yo5POzTF3nycZ9uz47gijY2e3LE/cAE3NSpT+/KZPMpPXUyNREoNrJsgMcq/eXTfV1P7O1OhQdNXByc6+Cs+y1Lv8i2p7fNLu2uKWJ9nJ+TMpOgoTBH4pab7d75H0VxyNCmXj8u0n8z+cgI3D/+p9F4dRjGii7cg6VOYjrYISQGy53khVU3NP2qmIuZLq9IzXl0ycgiGx1gVGbHhXUWjigDtKRqvCR90q1VhCdsPHXEtkBPGVg41jJt5q3KDm9DZ+GIquPHQ2bXX1hl4XikoCq9c6OBCgvHcshyKTE3kkF86TiSr1Zx9OKXx4HpzrS2iWMQXziO48NWD9V/lNnccEZaS/eOXDS31ClcBJ7qJFNr8aiKhzOCwkoL5zN38sxEQx07LzP3lZvZPaJEF/a/L76k5Zu0ejs/DqyycDwP+2aReF/st8222nJw0apPs1qyjW2stnQe1aWklOaPLi2+eP9s0+fHMpGPKs/vHKSzcEQfmw3aXVkc860FXqbS0lleFndlWlXZ5/RNmjcJ28xx5r75VLZPmlg6u+6LL792Dn9OxkdgXJaN1J6oHxvjt8WeOJs70XlAb+lVtsydn6rbrNzMX0eaSk8R089FXReHN+Qz0FNhYb2ni+yv6e6cwDq1p4jrXfFgHdSg80QR2QMIlJ4ipnR7W5R5szBIttlxfGQ0FdlIdekK0JReu7CQxhNEIwnOt5LgtFgQE3pLr4mPdfHrPnnslt1FPru/SM2Fo6uTh3fFm7QuHy0rJaW4dM9VD+mmfiObPrvLkMrC8WzTTbFN6RsnTDxY5UniYW7eTAZEXL9ZJKL7tFl0lrMTfBBffB+aDc85SZZ8/o50rLj43jDZvi62s5cvQH7pXtp/SR6rl8n8WJDGwtHkBX3gz4QyiC89I2Z5bbXshQpLM+BS6E1RW238TKWFY9pwT6Ux4WyoB9KWiUR2+uukLrOvs4NBKgswchiqH5T9XbaHjxygm9e/A4n5t7CrOtnvX2dfM7B4MK4uI8NIY8ahIIqbeyx0vKbSR5GXHHLPOMbDbk4d340835x7TGf65Y7nrDxaHcMZEcw+frssorlAzDtes4pl8hjNcM8en1l5nDomMxxyx2On/NkccRguJ442rLyeOMIwG8ofXVh6nTqiGDnljias8Jy+/DZ59GCXNwS1b7bIoPKt7E8dIRh+uKMDK39zjggMv6eOBs6Zief6nqL+7XBkKP5Rdo6pfcv2TVD4o8Yx1L2Vx2mK3nDJU/N2WWRBwZvZNJN6t0P3BMVuojxBrZ/VDyyFzjSepM7tKugkRW6WUJYat/c5RYFTbjnq+1zPJJvMOx4RyfZ+OQqbckpR12d5nN/BJDVt7/MEBU15nqCe7WYwnmI2py+aWrb2NkkhEz5Z6thuzXKaIjaXL9PUsJX30xSw4Xya+rVr+QTFazaZoXat/E1RuIY/jro9w9+JlyOdomatPHIUrOGMol4t19mnKNbRinuKWrVcGzMU6mhhTFCndq3kKVKzeTQ1auWNo0ANVxT1aTfiWYrTHOkktWnHLkxSmCajwFKXVj5ZitJwR1KTdp4mKEjTGUM9nvLnidhz15PvZKQf1r9CkrTDXmP1/cN1Y3qbfl09+7b63EwNEoFnK+fGvYkbjV2W7reN9vs2jMZecThIGx+6735L5Y1sKdGK/LheXb9fX3viJvY+fLh+rxXU39UflJRoPglCSiApp/nkXHvhzToQSMxBYm7zyaXEXCTmNZ88SsxDYn7zyafEfCQWNJ8CSixAYmHzKaTEQiQWNZ+iaze68YMQiUVIrIHkfXztNugY1mLcu7KzxZpyKwwcFBCClMRYCNnngkRDYDiE7HZBAiIwIkL2vCAxERgUITtfkLAIjIuQ/S9IZASGRkgIBAmOwOiIiOt3gfEREgfRABncrL0IS2KIHAVRTEk6GCJH4uCQYDrGcHG4MB2MkOOyYToYIcfjw8QIOT6Xwg4GyJEoOIKUxAA5EgWHngAwQI6EwSFTzsEIOewQcjBA7prtIxcD5Aq2j1wMkOtwfeQaM5pEwSEHhosBcj2uPS7Gx5UoOOQIcjFAbsC3HAPkhnzLMUCuAogclS4GyJUwOOSodDFCnoTBicgZHSPkqSEUk5IYIU/i4JKDzcMQeS7X8Z5RdiQOLjnFehgiT+LgkvnuYYg8iYNL5ruHIfIkDi5d9jBEnsTBJRPEwxB5EgeXBNPDEPkSB5cE08cQ+RIHlwTTxxD5CiISTB9D5EsgPBJMH2Pkq7UBiZFvrA4kEB6JkY8x8iUQHomRjzHyJRAeiZGPMfIlEB69OsEY+RIIj8TIxxgFEgiPxCjAGAUSCI/EKMAYBRIIj8QowBgFEgifxCjAGAUSCJ/EKMAYBWoJR2IUGIs4CYRPYhRgjAIJhE9iFGCMAgmET2IUYIwCCYRPLyIxRqEEwqfXkRijUALhR8TSOsQQhRIHP6YEMUKhhCGglvQhBiiUKATUqj7E+IQShMChBDE8oVpku5SgscqWEAQkOiFGJ5QQBCQ6IUYnlBAEJDohRieSEAQkOhFGJ5IYBBQ6EUYnkhgEFDoRRieSGIQUOhFGJ/LYZVeE4YkkCCGFY4ThiSQIIYVjhOGJ1C6IwjEytkESgtCjBDE4kUQg9ClBjE0sAQgDQjDG0MQSgDCkBDE0sQQgpDCMMTSxgobCMMbQxLL/IwrDGCMTqzU2hUyMkYll/0cUMjFGJpb9H1HIxBiZWO1QKWRiY4sq+z+ikInNTaoEIKKgab+CohKCiAKn/QqKqjU2BU/7FRSVMEQUQO1XUFQtsymI2q+gqIQiJsmNtbFVXUswYgqm9isoKuGIKaDar6Co2q1SULVfQVG1G6LAar8Cooo4iEm0RpyChCQm0TJJBUUdxCRaJquguIOYRMukFVpeYU3CZRILLbOwJvEyqYWWW1iTgJnkgqIQ1tdOfBM2Hdwk1LXr3niua2gZ2Ck+oUkpmpAx0GvZhjXNihh8g1CsArkwEAbhIBStQC4NhGOSQg63OBAG5yAUs0AuD4RBOghFLZALBGGwDkKRC+QSQRi8g1DsAll8hUE8CEUvkOVXGMyDUPwCWYCFQT0IxTDQJVgY7INQHANZhIVBPwhFMpBlWBj8g1A0A1mIhWuSeC5XioVBQQjFNJDFWBgkhFBUA1mOhcFCCMU1kAVZGDSEUGQDWZKFwUMIxTaQRVkYRIRQdANZloXBRAjFN5CFWRhUhFCEA1mahcFFCMU4kMVZGGSEUJwDWZ6FZ3KuHleghcFHCMU60BXaICSEoh3oCm0wEkLxDnSFNigJoYgHukIbnIRQzANdoQ1SQijqga7QBishFPdAV2iDlhCKfKArtMFLCMU+0BXaICaEoh/oCu2bFLnPVmiDmhCKgKArtMFNCMVA0BXaICeEoiDoCm2wE8KP+Qpt8BMiWPMV2mAohOIhmAptcBRCMRG01RYvdTT2OS3l6XV7RPb+fXc0vFMHvt9Wv3dnZ01fKqvyFE0ucp59+369kn3Z/Of7cGomP0lP/WOog4WmLvQWnKA10GzMWkNNdeAMtafr7WEeNBcM5pqJbYb2Z3U2D5rkgyatY90kj7OlntMo2+c0gBUBrfjaypqzcqyLh33ymIAHXAZjzUwAjLmdMY9r3vBw41E+3DjYCQFasQbL5cCSD/xs9Uv01AM/IKIIRuToiMIJU2X3vBIwApNnrePxuHjU8fUneXw9mJDDAySg7ueA62f9VtHBgucOBti8bdU26mWLQNUDqlzTW9Wse7snUAZp5nNIqlfhbrrX4A66Lug4NqWU7jarPhH6IJ98Z0r/oN4tS1gA+PuCswBvB0HMXIgZ23FS+9A9QAC1HagdaMT5IMD708H4BCOhMxG1/zpdNjvd391uMvJcxkP7INN99yATcAGbuQ71FMD1d2vmS/sAFrACm7vWzWX7vPuRCDAhgjxzfU5LXvLYqh/kAD0NhyeHktJUUlATzg5dNzrdtOWuu3+5sabezr0ri8OmfeoHJB2Y2z2uMvTqfeojE6A32PmzNwGyHxkB456d8mSl3PYPtYM5GDQiXus5mAOme+4/bS/hDFZ8kL+hnn4dLimgFRNlBzTG5VK8M6DqpVlTgH4U6fawhuRlNjqONVgHsA2R6iqKKq3HnQLSLtTlxOHmx11WE9UAoONzKdZopjlaxHhgqLC1p1HrfrADKIKQ2SmsUfyKqp4H0A+4+US9H9gsWT7o5YAD6S6tqVrrgpnI4xK20VVTUK3eIQ6mBLiqmlAeT6NiDSdAXlOlxUP/Qx4gbpDgvPpB/4oj8AxSW3Drv0b1f/pnU0E/gzQ6qZipH1kCfuGUz8HbqI9qhUCLIUaxfxQW1BjY0LUexD7XW6NFN0BIz2hswVDKoyolYK2c9Gt2FhhAuoB3q0CX6zo+U0BDvFnaG/Wm40q/LxskAIAi4HJHmSr75z9hzsOkF3o7xM5I/Uamlq9H3vRvUwbxgIwMuMKXHe5wFHDQCtY5eO4SKAPVLnx2qurubx+6G98wApiZgo0b3MyliwtIL2eOFdWhO3XdeFRmAoBNqDdjDt82wypVuQLQW2G/+WXHQYE6yQHThcMOu6rfyqWpvsYA0gPYCLgZK6uy/KP68R9uYQSa4bFJ31ih12YAJHYTmFXFbnfc74k5F5TuKe27ollmq5+7JmyAOs73ZKl/fApgACqyx8288lXvtX7VO+h70O6Ai1w+238oDPIlgINDz7w+B5+6Nytv3cl7s6DJAPpI7y9crg2H5Kt8iBr1Owgj5CaJQ5aP9MDsEnKDMi9GeRLD3YXQi192A65/IQ7MKgAsp+s2pxt1bjdZuZw5cAuYXA4DMCO952Mrkf4Rl7ogR4QHZhq2Gg82mFHpgVHJ0lj6RubHpNy0NyBAiQVhxHp2cjmkwcXWUl9sJWacEKAYaxDZXmdWSnAjxmh2r00YT7kg7UPNGzmsFcmmJdWmuzkK+gZ0bqzNeNwyVZn5qC5k7tX1SGAIJE6sE4ddhABDpblgjkDLYj2g2Umpu8G4UTcYCY4OzjFrPcewy39lTVKZZusAUrFeYLKMirYybhqYMmLN27CVppJvUzc3Ih7oHXaqbGr0aLYCpSHi8JUXqsFIQvkOGSe9amAZ6ur+WMuCjWoMmLU4NWNqB8kZ6eR02eDNzakDmswOd6WVDC+yAD0GWhz1HAU3wttflATOwfzAjiepRPoOwZQV9Ws0trf12w6AAZBpkc40l8009aqU8RwDxnSoR6LDJV2dPNRFKe+ZEtNljHbBehJmWTB5k200j8fwGEHoXmHJ57po+sXoVwGnA26t0r7FhaqOAdyt9QwNa6dKi+63Z8BqCcwkAZdMwz0vqAkXiFzHtZp4KwcXhVwmSr2q/fUG0FwQa0jG+uF61W9En73/8P37/wGE5Oyz4YgAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7VdW5fbuJH+L+rXng7BO/2W6fEkPrvemdhO9uLjM4eW2N2MJVJLUr7Ex/89BEiQVWAVRUjsl0zaqhvqK6CAj7fvm6r8Um9evP+++ZQXu80L93ZTpIds82KTH9LHbHO7OVX79q9DuTvts/pP6l/vnprDvv1pu0/rOmvVN5sft9pC6I8mirzJ033+r9HOw6nYNnlZaEujCGH0dnNMq6xohmhIL/XTqfml/FKwPrTAxR4es+aV/PX3/Jjt84IfjSl4sccqe8zrJqt+358e8+IvWXNfFk32tfm1Kg+/HZVLNogFunZxuUE4BPa3UwtW8+1V8VAOAeSt+eoh3Q7lAYQsPTl+DLPeG1ru6QYpzTiFmlwAef3bw6+n/d4+iqnmCqH8pSx3L4vy9Ph0WUCUvn1Ywh2jUrWOSqG314cx/G5XBYEYV6FtW61Nddo2ZbXIyQ1WmBvfGD1fgH/N8senZplnKH6t3//Od83TYrda+lqv1OQ+5xvrWEcAlhb1+8uqAkhPCnuUuW5heZ3VNWxv5xzdIJ2zo+xGwbtXv7/7drQLAGpdF0JTvm2qvHhc7h5oWLuGS8bLz634L2mTMgU2/P6cSwZ2YrFkjNGD0Tnu2LczKfBf8v8v8gzFr/JbfvxntuXWKcPpIGvtEeD4a16k+3NgYqHnRJTwZAGrMZgLsaViWArwsghmUabcL4J6me/8TK+n3EOd6yNIi11V5jsL/6PGCuMva5uRK+nLvMINllyWD9kuT5vs3GQjZZ9148U6tNmEkSO8cAbORLR0IlrFMzsfZ4JZNC2tIjk3O2eCWTpJz8YDu0Oa70/V2ZI1xZ61Q1C+2EJt6t1Pef1TXjxlVd5kO2L+mkPkahZtaJfEpDVmV4+l3s/1LDoCcrKsl5P5PkaGREyZq+KBB48/F614a+AVYrwmW2IkdsXxo27SqrFxc6M15ioCD4J1XR4tPSuFqx3n9ZtTUcyeOAjvUOuSECZcxYTAI063l3F35l7hvjwc99nX+3T71NZfrgi6xV5veANnD1/DEK/iU3A4lpwKEYJRDK+Kn/PmkB5fZ4ey+qbGaJEcRv3quNojtrL1H9m35dFgpVVy80tef7ogJ1Dt6jgyWXKSMb4IIkZ7vaguSBGpu15El0azWiTbfZZWyhp3UKFmNlJaJwaAuW0khuo68Qx420aDFK+O5VhlD1mzfXpXXlC8tPKKMV00zTn1S+Iag3q7TfcZIkez4nTQYQy/Wvbncbu3zeTWY4Hxm0FybkBjuDPe7iuw8TrrsZe+2uuros53S9J4Y8hf4fkhb+4XJxgKX+fzZbFb6LCTvM7bW7SFn/f3dsHm/bzH//nfhe6U4DW+yu2pXlquUNjW5+TSj14U7sviIX98mzXN+SsUpM41O/da3ihQp3Lv/bJIP+6z3cUR3NDGFi+OOA9MwG2f+vSuSrefsnNXzWYCxUbWDfBUZ799emqamXPnufCgiauD81xcdf/Isy9y7Nl9e4J8bJvYEOfntMolaCjMibgtEZBEIhhDIO/OuE/3+48tGkMkTTtzdBSzGpb3mwSBN87BP/5oYM+183kzaM8BND9akCXMa/60Lfdl9ZDvYVdBNyT9ASSW35xUN63r1/nXnL+ZBhlGGgtSjeKmRvevsjzkiHTSoxp+mR0N5Df+r9V4dRjXS715Gy31EvOBjyEx8/lBXrdQU6GdW4pZW+jyhtRcRudNLLLRAcZvcVxYZ+WIckCbq8FLUjLbWUV4xsZzR2wL9JyBlWOtsrZ31XZ4GzorR1SfPh5yu3xhlZXjkYJq+7U0GqiwciyHvJASSyMZxdeOI/1qFccgfn0cmI7PGps4RvGV4zgdd3qq/r3Kl4Yz0Vo7O/Lg1FH78CBwLkmm1upRlccLgsJKK9czd2cEEw11W8Q6a1+1XZwRJbqy/335JaveZPXb5XFglZXjOe7bg8JTud9lle3kolWfZ7dkG9tUbe06aipJKy6fXVp89fzssl9OVUpevGOTg3RWjkgelB6r8lTsLPAyldau8qp8rLK6zj9nb7KiLdh2jTO5k3PVPmti7ep6Kr/83jv8OZ1eBuWqbKL2THlsjd/Lg6Nt8oDe2rtsWTt/ru/zart8H2kqPUdMP5dNUx7ekPfoz4WF9Z4vsv/MHi4JrFd7jrjelUfroEadZ4rIHkCg9BwxZbv7sirajUG6y0/Ty4ZzkU1U1+4Abeu1CwtpPEM0kuR+K0luiw0xobf2nvjUlL/v02/9ths+MHdue0xprhxdkx7flW+ypvpm2SkpxbUzVx+zbfNGDn1xypDKyvHssm25y+gnoph4sMqzxMM8GTYbEPF42CoRPWXtprNaXOCj+Orn0Hy8D09eKVl+Ip0qrn42THevy93i7QuQXztL+y/pt/rXdHksSGPlaIqSvumDCWUUX3tFzIvGatsLFdZmwKXQm7KxOviZSivHtOXuTGTC2VI3Ja4TiUz667Sp8q+Lg0EqK8SDbuyd7jry/oLtNbcCLLjQhd2cu8A18Xx36YUs0y93AcvKo9WFKiOCxReorotoKRDLLkBZxTJ7oclwz15gsvI4dyHJcMhdQDrnz+YigOFyhvy38nqG5DcHypP7ll7nSPyJU468t8Jz/vHFWXLerm4I8tsckUF2W9mfI9kNPxy5buVvCYlu+D1Hnl+yEi/1PUeO2+HIkOCT6pyS35bjmyG5J4NjyG0rj/MktuGSJ6/tqsiCpDaraSE5bYfuGRLaRHmGfL4oDyzJzAyeJJftOugsiWy2UJY8tvc5RxJTbjly+FLPJN/KO55QrfZ+OZKXckqRuxd5XJ5gkry193mGpKU8z5CzdisYT8KayxdNvlp7myVZCZ8suWq3ZzlPoprbl3ny1Mr7eZLUcD5PjtqNfIYENYfMkJ9W/uZITsMfR25e4O/M663OkZdWHjmS0nBGkZOW++xzJORkxz1HPlrujRmScbIxJshFu1HyJKI5PJo8tPLGkYSGK4octJvxLAloznSS/LNjF2ZJPpNRYMk9K58siWe4I8k7O08zJJ3pjCHnzvnzReJ7zuzbPunb2W+QJO1w0Nj8+HDbmt5lXzcvvm8+t0uDRODFxr3z7pJW4yHP9rtW+30XRmuvPBykjQ/9b//I5HPrUqIT+ZOzuX3v3PrunYiSDx9u32sN9YP6ByUm2r8EJSaQmNv+5d760Z2HhFwk5LV/eVMhDwn57V/+VMhHQkH7VzAVCpBQ2P4VToVCJBS1f0VToQgJxe1f8VQoRkItDO+TWy++i50IiSU4oTK/wrn13LvQETilRupV7sXUr8C5FzLLgsi+wOkXMtGCAEBgBITMtSAwEBgEIdMtCBgExkHIjAsCCYGhEDLpggBDYDSEzLsg8BAYEJHwmcaYuAqTFrzwzo0xeC7GxJWpdx1S0pgRakoQ6LkYFddjo3QxLq7PR4mRcQM+SoyNG3JV62JwXImB65KSGB5XouASZeZieFyJgUuUmYvB8fgJ42FwPMEmyMPgeC6bIM9YszwuQR5Gx5MQuMRs8DA2XsAPB2PjSQRcYt54GBov4oeNofFiftgYHE+BQ8xFD4PjSwRcYi76GBpfzZuEkMPA+DL7nkPIYVh81UuI2eUb3UQm3yPWRh+j4vOo+BgVXybfI8rbx6j4MvUe1ckwJr5MvEfUjY8R8WXiPaIafIxIIBPvEcgFGJFAJt4jkAswIoFChEAuwIgEMvE+gVyAEQlUgyeQC4wWL9PuE8gFGI9Apt0n8AgwHoFMu0/gEWA8Apl2n9pcYDwCmXafwCPAeIQy7T6BR4jxCGXafQKPEOMRyrT7BB4hxiOUaQ8IPEKMRyjTHhB4hBiPUO25CDxCY9cl0x4QeIQYj1CmPSDwCDEeoUx7QOARYjxCmfaA2u9hPCKZ9oDa8mE8Ipn2gMAjwnhEMu0BgUeE8Yhk2p1bN7lLQv82bJcar11qXKyCoYkkAiEBTYShiSQCIQFNhKGJ1I6YgCYy9sQSgTZIYtcfYXAiiUEYkJIYnkiiEIakJAYoljiEESUZY4hiiUQYk5IYpFhiESakJIYplhBExLSJMTaxhCAisIkxNrGEICKwiTE2sYQgIrCJMTaxOrCQ2MTGoUUCEJHYxBibWAIQkdjEGJvEYXeBCcYmkQBEJIoJxiaRAEQkignGJlHYkCgmGJ1EghCTx9sE45NIGGLyhJtghBIJROySkhijRAIRe6QkxihRJ0sSzcQ4XUogYhLNxDxgSiRiEs7uNygrsYhJmLrfoKxEIyaB6n6DshKPmISq+w3KSkQSEqzuNygrMUloQsIxjp2OOtuQgHW/QVmJS0JC1v0GZSUyCQla9xuUVawACVv3G5BVx/+Exm1CDUhsEho3kx5QNEBC42ZSBIoKSGjcTJqg4wkcGjiTK+jIAodGziQMOsbAoaEzWYOONnBo7EzqoOMOHBo8kz/oCQQaPYNCEB2H4NDwGSyCUFxBW1i0sEnvKH7HoQE02ATR0wnEfkQYdIJQpAHd5oVBKAhFG9CNXhiUglDMAd3qhcEqCMUd0M1eGLyCUPwB3e6FwS0IxSHQDV8Y/IJQLALdUoXBMAjFI9BNVRgcg1BMAt1WhWdScx7bWIVBNAhFKNCtVRhkg1CUAt1chUE3CEUr0O1VGJSDUMQC3WCFQToIRS3QLVYYtINQ9ALdZIVBPQhFMdBtVhj0g1A0A91ohUFBCEU10K1WGDSEUHQD02t9k1b1+V5r0BFCkQ5MrzUICaGIB6bXGqSEUOQD02sNYkIoAoLptQY5IRQJwfRag6AQiohgeq1BUghFRjC91iAqhCIkmF5rkBVCkRJMrzUIC6GICabXBiYlHvC91iAuhCIomF5rkBciiGZ6rcFgiCCe6bUGjSGCZKbXGlyGCJ2ZXmsQGiIUM73WYDVE6M70WoPaEKE302sNfkOE/kyvNUgOEQYzvTY0r2uobQot2uGnLtp9zip5Xb27ePf+/fCKse+bP/orekGiLx9+30Ru+78/foxX8ORf0nZ3BftBXcEeVSUYg67c7rTitxuJBWNF31g7mnDd0YLbG0ic3lDbfDhD3f0C3eVJaC4azbVL9gLtz+puAzgmAccU9KG0lcsYU7eeVN2tJ6OZJIJWhLbic1ZOTXncp99ScM8OMBYAY06ijXFgjfdrnuT9mqOdGMCVaLR8Di15D9NOvz1R3cMEIvJhRLGOSMyYqvpbsIARWD2Ojifg4lFX5D/JK/IQLZhnV+c55PKsXyc7WvBBblmQO7WtessmUA2BKldsnWrev9YVKIPA2Qmj3oG87d9/POp6YMqyVaB0d3n9aarvgxJnS1LpH9RLhQkLDrDAzVL0zsBRNwS60azuob8jAuIdQ7xdjXfAmgGvzYdmYOX1Rvp55Xrdf73+371+CfA5H929WU/9vVmgvBO4BHi6vMNZM1+6e8qAFThgoQcccMH0Xy4BKyIoUo/zrb42slNfiQFJgp65maE0lRTUBCN3+zS6fp/Ofo56EWsx3zYPVXnYdjcygbIHAbFLzaA+lD4yAWYdu9AMJkD1IyMgpT4372Wv3A336YM1GDS8JNSNjreiHmXIuueKwBwCq1akl1+XKwpoxUTZBZY8bi3oDaiGafYUMJUSX4+HA1c9n0fHAdYkl1vTlLqKos6aaVJAU4p0O3HZMeUN0Q1AiYVcibWaWYF2MT4o+JAPvum/IgM2XyB7IbcWtopfUdcLQK7YVqdeDG22rABUH7toPmYN1Ws9kF6fA1jqdu+XlROo7N4vux3epgsiAZmOuEy31tSCZu5ZBZiBglvUWuXpoizQ7o7XVEV2HL5VA7IApguvftAfKgWe4SZuJvX/r78MDAobgHZWMVffEQN+4S5rJuRJ5xEubLWM4nCvMGyusLsKvSYEXMlMNvFAvW8e7DZB6U56noC7U25+KFUzWWAe6+1Av0azZxG+UkCp+Yu0t+qF2bV+7TqYLADDkCsBZaoabpCFgMDpohuyYNeb4VzUyLdsb4eXcoN4QBuNuDaaHx5xFHA/5LLOwY2pQBmo6vDZPHTviD70b5UG0whYidiyAA8u040KFJfL9W1oRaXzQT2NPW1ZAJlIH+xcfmSGVbILAmxijbXLTr4SpcgFheZye75WZ9t9Gku1iWz4NBaofbB2+Gyq6+F4mWX6aRFQZCDRIRt/nRcf1ZeouM0aGJHPJra1Qu8XwaLts/moy4eH035PrNxwnsxoP5bt1l99F56wARolH0Glv9IGYgfrqM+t3/K7A43+7gDIPRh3yHmVj1AcSpMSgl1D6A0uezxWzyfLpxvl88kgb2DQiT70eFzXPKRf5c3qyAAII2b18mKiB9aImCvcopwUinBgzxF6S87uIfXHFMHUA3BpIsPtz55enwKPgwI8bk1t0iPY1/RJlD0N6m8KNSU5J3yQWvYcOtpg5qUP5iV7JtaPvn5Mq233qAmYFrCpOXqhYxsteIS40o8QE4tODGBMNIo+hyKz5YKUEqNZZY953a7mx/3pUUZC7JpRtsBUZi2qV15M+wFcP3TzZNd2RRum9bZ/6hckBhJtjrbDru3Kzkf1NO1ePdsKLMF9gKOrkV2bgaXK3M3HkKJw9DrBMjX9A6hb9QAqwUfCpcvRSxd7wlfWJG1rjC9B5JLe/rInJm1mMrgEbnocTUSzXUiesjLzoOSDwmE34O0uYrIMgtkZc8jIJ+LBDEXAgCmQ6H0N24Tqp1MjtwJoOQSrIadm9AxQoYkuUJbSmBzFXVBLLCeutNLxTSTAOxhxrBcOj1s4uo+6AudgTrCrjVSifYOlMNbZ9ti06ddVALhAqSW60thm073rZrrQgDHEei6yO+QmPTZlJR8UJlbhBK7tA0HLEs3yUcRJf5DX84ARnRaWnmnKNjFGYgVc9Ljp072Hh2y7YPbFmpDyuNo61VnZf2MJtBJ49udyOT6pB+EAMyjiVsROE405BFM/4qa+1Ku7L1SA4YKFLyax+nC7GU7KL95/+PHj3/Q7AHz9jAAA"; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 98a4377..778b949 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -327,17 +327,14 @@ dd { } /* Footer */ -.tsd-generator { +footer { border-top: 1px solid var(--color-accent); padding-top: 1rem; padding-bottom: 1rem; max-height: 3.5rem; } - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; +.tsd-generator { + margin: 0 1em; } .container-main { @@ -405,7 +402,8 @@ dd { } body { background: var(--color-background); - font-family: "Segoe UI", sans-serif; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); } diff --git a/docs/classes/image.EventData.html b/docs/classes/image.EventData.html index 8726866..c19e756 100644 --- a/docs/classes/image.EventData.html +++ b/docs/classes/image.EventData.html @@ -1,7 +1,7 @@ -EventData | Documentation

Class EventData

Instances of this class are provided to the handlers of the release and submit.

-

Hierarchy (view full)

Constructors

constructor -

Properties

eventName -object -

Constructors

constructor

Properties

eventName

eventName: string

Returns the name of the event that has been fired.

-

object

object: any

The object that fires the event.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +EventData | Documentation

Class EventData

Instances of this class are provided to the handlers of the release and submit.

+

Hierarchy (view full)

Constructors

constructor +

Properties

eventName +object +

Constructors

constructor

Properties

eventName

eventName: string

Returns the name of the event that has been fired.

+

object

object: any

The object that fires the event.

+

Settings

Member Visibility

Theme

On This Page

constructoreventNameobject
\ No newline at end of file diff --git a/docs/classes/image.FailureEventData.html b/docs/classes/image.FailureEventData.html index f77aff3..4e14d98 100644 --- a/docs/classes/image.FailureEventData.html +++ b/docs/classes/image.FailureEventData.html @@ -1,9 +1,9 @@ -FailureEventData | Documentation

Class FailureEventData

Instances of this class are provided to the handlers of the failure and intermediateImageFailed.

-

Hierarchy (view full)

Constructors

constructor -

Properties

error -eventName -object -

Constructors

constructor

Properties

error

error: Error

An object containing information about the status of the event.

-

eventName

eventName: string

Returns the name of the event that has been fired.

-

object

object: any

The object that fires the event.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +FailureEventData | Documentation

Class FailureEventData

Instances of this class are provided to the handlers of the failure and intermediateImageFailed.

+

Hierarchy (view full)

Constructors

constructor +

Properties

error +eventName +object +

Constructors

constructor

Properties

error

error: Error

An object containing information about the status of the event.

+

eventName

eventName: string

Returns the name of the event that has been fired.

+

object

object: any

The object that fires the event.

+

Settings

Member Visibility

Theme

On This Page

constructorerroreventNameobject
\ No newline at end of file diff --git a/docs/classes/image.FinalEventData.html b/docs/classes/image.FinalEventData.html index 07940e2..60179a6 100644 --- a/docs/classes/image.FinalEventData.html +++ b/docs/classes/image.FinalEventData.html @@ -1,11 +1,11 @@ -FinalEventData | Documentation

Class FinalEventData

Instances of this class are provided to the handlers of the finalImageSet.

-

Constructors

constructor -

Properties

android? -eventName -imageInfo -ios? -object -

Constructors

constructor

Properties

Optional android

android?: AnimatedImage

eventName

eventName: string

Returns the name of the event that has been fired.

-

imageInfo

imageInfo: ImageInfo

Contains information about an image.

-

Optional ios

ios?: any

object

object: any

The object that fires the event.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +FinalEventData | Documentation

Class FinalEventData

Instances of this class are provided to the handlers of the finalImageSet.

+

Constructors

constructor +

Properties

android? +eventName +imageInfo +ios? +object +

Constructors

constructor

Properties

Optional android

android?: AnimatedImage

eventName

eventName: string

Returns the name of the event that has been fired.

+

imageInfo

imageInfo: ImageInfo

Contains information about an image.

+

Optional ios

ios?: any

object

object: any

The object that fires the event.

+

Settings

Member Visibility

Theme

On This Page

constructorandroideventNameimageInfoiosobject
\ No newline at end of file diff --git a/docs/classes/image.ImageInfo.html b/docs/classes/image.ImageInfo.html index c4d8aee..2eca31a 100644 --- a/docs/classes/image.ImageInfo.html +++ b/docs/classes/image.ImageInfo.html @@ -1,6 +1,6 @@ -ImageInfo | Documentation

Class ImageInfo

Encapsulates the common abstraction behind a platform specific object (typically a Bitmap's quality) details.

-

Constructors

constructor -

Methods

getHeight -getQualityInfo -getWidth -

Constructors

constructor

Methods

getHeight

  • getHeight(): number

  • Returns number

getQualityInfo

getWidth

  • getWidth(): number

  • Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ImageInfo | Documentation

Class ImageInfo

Encapsulates the common abstraction behind a platform specific object (typically a Bitmap's quality) details.

+

Constructors

constructor +

Methods

getHeight +getQualityInfo +getWidth +

Constructors

constructor

Methods

getHeight

  • getHeight(): number

  • Returns number

getQualityInfo

getWidth

  • getWidth(): number

  • Returns number

Settings

Member Visibility

Theme

On This Page

constructorgetHeightgetQualityInfogetWidth
\ No newline at end of file diff --git a/docs/classes/image.ImagePipeline.html b/docs/classes/image.ImagePipeline.html index 219c6d4..ecf7735 100644 --- a/docs/classes/image.ImagePipeline.html +++ b/docs/classes/image.ImagePipeline.html @@ -1,26 +1,30 @@ -ImagePipeline | Documentation

Class ImagePipeline

The entry point for the image pipeline..

-

Constructors

constructor -

Methods

clearCaches -clearDiskCaches -clearMemoryCaches -evictFromCache -evictFromDiskCache -evictFromMemoryCache -getCacheKey -isInBitmapMemoryCache -isInDiskCache -prefetchToDiskCache -prefetchToMemoryCache -

Constructors

constructor

Methods

clearCaches

  • clearCaches(): void

  • Clear all the caches (memory and disk).

    -

    Returns void

clearDiskCaches

  • clearDiskCaches(): void

  • Clear disk caches.

    -

    Returns void

clearMemoryCaches

  • clearMemoryCaches(): void

  • Clear the memory caches.

    -

    Returns void

evictFromCache

  • evictFromCache(uri): void

  • Removes all images with the specified Uri from all the caches (memory and disk).

    -

    Parameters

    • uri: string

    Returns void

evictFromDiskCache

  • evictFromDiskCache(uri): void

  • Removes all images with the specified Uri from disk cache.

    -

    Parameters

    • uri: string

    Returns void

evictFromMemoryCache

  • evictFromMemoryCache(uri): void

  • Removes all images with the specified Uri from memory cache.

    -

    Parameters

    • uri: string

    Returns void

getCacheKey

  • getCacheKey(uri, options): string

  • Returns the actual cache key for url + context +ImagePipeline | Documentation

    Class ImagePipeline

    The entry point for the image pipeline..

    +

    Constructors

    constructor +

    Properties

    iosComplexCacheEviction +

    Methods

    clearCaches +clearDiskCaches +clearMemoryCaches +evictFromCache +evictFromDiskCache +evictFromMemoryCache +getCacheKey +isInBitmapMemoryCache +isInDiskCache +prefetchToDiskCache +prefetchToMemoryCache +

    Constructors

    constructor

    Properties

    Static iosComplexCacheEviction

    iosComplexCacheEviction: boolean

    iOS: set this to true to enable complex cache handling +this is necessary when you use colorMatrix, decodeWidth,... +and when you change images on drive requiring cache image eviction

    +

    Methods

    clearCaches

    • clearCaches(): void

    • Clear all the caches (memory and disk).

      +

      Returns void

    clearDiskCaches

    • clearDiskCaches(): void

    • Clear disk caches.

      +

      Returns void

    clearMemoryCaches

    • clearMemoryCaches(): void

    • Clear the memory caches.

      +

      Returns void

    evictFromCache

    • evictFromCache(uri): void

    • Removes all images with the specified Uri from all the caches (memory and disk).

      +

      Parameters

      • uri: string

      Returns void

    evictFromDiskCache

    • evictFromDiskCache(uri): void

    • Removes all images with the specified Uri from disk cache.

      +

      Parameters

      • uri: string

      Returns void

    evictFromMemoryCache

    • evictFromMemoryCache(uri): void

    • Removes all images with the specified Uri from memory cache.

      +

      Parameters

      • uri: string

      Returns void

    getCacheKey

    • getCacheKey(uri, options): string

    • Returns the actual cache key for url + context this is an iOS feature because imageView properties are used for the cache key

      -

      Parameters

      • uri: string
      • options: Partial<Img>

      Returns string

    isInBitmapMemoryCache

    • isInBitmapMemoryCache(uri): boolean

    • Returns whether the image is stored in the bitmap memory cache.

      -

      Parameters

      • uri: string

      Returns boolean

    isInDiskCache

    • isInDiskCache(uri): boolean

    • Returns whether the image is stored in the disk cache.

      -

      Parameters

      • uri: string

      Returns boolean

    prefetchToDiskCache

    • prefetchToDiskCache(uri): Promise<void>

    • Prefetch to disk cache.

      -

      Parameters

      • uri: string

      Returns Promise<void>

    prefetchToMemoryCache

    • prefetchToMemoryCache(uri): Promise<void>

    • Prefetch to memory cache.

      -

      Parameters

      • uri: string

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • uri: string
    • options: Partial<Img>

    Returns string

isInBitmapMemoryCache

  • isInBitmapMemoryCache(uri): boolean

  • Returns whether the image is stored in the bitmap memory cache.

    +

    Parameters

    • uri: string

    Returns boolean

isInDiskCache

  • isInDiskCache(uri): boolean

  • Returns whether the image is stored in the disk cache.

    +

    Parameters

    • uri: string

    Returns boolean

prefetchToDiskCache

  • prefetchToDiskCache(uri): Promise<void>

  • Prefetch to disk cache.

    +

    Parameters

    • uri: string

    Returns Promise<void>

prefetchToMemoryCache

  • prefetchToMemoryCache(uri): Promise<void>

  • Prefetch to memory cache.

    +

    Parameters

    • uri: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructoriosComplexCacheEvictionclearCachesclearDiskCachesclearMemoryCachesevictFromCacheevictFromDiskCacheevictFromMemoryCachegetCacheKeyisInBitmapMemoryCacheisInDiskCacheprefetchToDiskCacheprefetchToMemoryCache
\ No newline at end of file diff --git a/docs/classes/image.Img.html b/docs/classes/image.Img.html index f8aa023..81acede 100644 --- a/docs/classes/image.Img.html +++ b/docs/classes/image.Img.html @@ -1,73 +1,73 @@ -Img | Documentation

Class Img

Encapsulates the common abstraction behind a platform specific object (typically a Bitmap) that is used view to show remote or local images.

-

Hierarchy

  • View
    • Img

Constructors

constructor -

Properties

alwaysFade -android -animatedImageView -aspectRatio -autoPlayAnimations -backgroundUri -blurDownSampling -blurRadius -cacheKey -colorMatrix -decodeHeight -decodeWidth -fadeDuration -failureImageUri -headers -imageRotation -loadMode -lowerResSrc -noCache -placeholderImageUri -progressBarColor -progressiveRenderingEnabled -roundAsCircle -roundBottomLeft -roundBottomRight -roundTopLeft -roundTopRight -roundedCornerRadius -showProgressBar -src -stretch -tapToRetryEnabled -tintColor -failureEvent -finalImageSetEvent -intermediateImageFailedEvent -intermediateImageSetEvent -releaseEvent -submitEvent -

Methods

startAnimating -stopAnimating -updateImageUri -

Constructors

constructor

  • new Img(): Img

  • Returns Img

Properties

alwaysFade

alwaysFade: boolean

android

android: any

The native 'com.facebook.drawee.view.SimpleDraweeView' object.

-

animatedImageView

animatedImageView: boolean

IOS: if you want to show animated images you need to set this to true

-

aspectRatio

aspectRatio: number

Number value used as the aspect ratio of the image.

-

autoPlayAnimations

autoPlayAnimations: boolean

Boolean value used for enabling/disabling automatic playing of animated images.

-

backgroundUri

backgroundUri: string

String value used for the background image URI.

-

blurDownSampling

blurDownSampling: number

Number value used to scale the image before applying the blur function. Bigger value means faster processing.

-

blurRadius

blurRadius: number

Number value used as input for the blur function. Larger value means slower processing.

-

cacheKey

cacheKey: string

colorMatrix

colorMatrix: number[]

decodeHeight

decodeHeight: number

Number value used as the resized image height

-

decodeWidth

decodeWidth: number

Number value used as the resized image width

-

fadeDuration

fadeDuration: number

Number value used for the fade-in duration. This value is in milliseconds.

-

failureImageUri

failureImageUri: string | ImageSource

String value used for the failure image URI.

-

headers

headers: Record<string, string>

add custom headers to the image download request

-

imageRotation

imageRotation: number

Android: custom imageRotation

-

loadMode

loadMode: "sync" | "async"

lowerResSrc

lowerResSrc: string

String value used for the lower res image URI.

-

noCache

noCache: boolean

placeholderImageUri

placeholderImageUri: string | ImageSource

String value used for the placeholder image URI.

-

progressBarColor

progressBarColor: string

String value used for setting the color of the progress bar. Can be set to hex values ("#FF0000"") and predefined colors ("green").

-

progressiveRenderingEnabled

progressiveRenderingEnabled: boolean

Boolean value used for enabling or disabling the streaming of progressive JPEG images.

-

roundAsCircle

roundAsCircle: boolean

Boolean value used for determining if the image should be rounded as a circle.

-

roundBottomLeft

roundBottomLeft: boolean

Boolean value used for determining if the image's bottom left corner should be rounded.

-

roundBottomRight

roundBottomRight: boolean

Boolean value used for determining if the image's bottom right corner should be rounded.

-

roundTopLeft

roundTopLeft: boolean

Boolean value used for determining if the image's top left corner should be rounded.

-

roundTopRight

roundTopRight: boolean

Boolean value used for determining if the image's top right corner should be rounded.

-

roundedCornerRadius

roundedCornerRadius: number

Number value used as radius for rounding the image's corners.

-

showProgressBar

showProgressBar: boolean

Boolean value used for showing or hiding the progress bar.

-

src

src: string | ImageSource | ImageAsset | Promise<string | ImageSource | ImageAsset>

String value used for the image URI.

-

stretch

stretch: string

String value used by Image image scale type. This property can be set to: +Img | Documentation

Class Img

Encapsulates the common abstraction behind a platform specific object (typically a Bitmap) that is used view to show remote or local images.

+

Hierarchy

  • View
    • Img

Constructors

constructor +

Properties

alwaysFade +android +animatedImageView +aspectRatio +autoPlayAnimations +backgroundUri +blurDownSampling +blurRadius +cacheKey +colorMatrix +decodeHeight +decodeWidth +fadeDuration +failureImageUri +headers +imageRotation +loadMode +lowerResSrc +noCache +placeholderImageUri +progressBarColor +progressiveRenderingEnabled +roundAsCircle +roundBottomLeft +roundBottomRight +roundTopLeft +roundTopRight +roundedCornerRadius +showProgressBar +src +stretch +tapToRetryEnabled +tintColor +failureEvent +finalImageSetEvent +intermediateImageFailedEvent +intermediateImageSetEvent +releaseEvent +submitEvent +

Methods

startAnimating +stopAnimating +updateImageUri +

Constructors

constructor

  • new Img(): Img

  • Returns Img

Properties

alwaysFade

alwaysFade: boolean

android

android: any

The native 'com.facebook.drawee.view.SimpleDraweeView' object.

+

animatedImageView

animatedImageView: boolean

IOS: if you want to show animated images you need to set this to true

+

aspectRatio

aspectRatio: number

Number value used as the aspect ratio of the image.

+

autoPlayAnimations

autoPlayAnimations: boolean

Boolean value used for enabling/disabling automatic playing of animated images.

+

backgroundUri

backgroundUri: string

String value used for the background image URI.

+

blurDownSampling

blurDownSampling: number

Number value used to scale the image before applying the blur function. Bigger value means faster processing.

+

blurRadius

blurRadius: number

Number value used as input for the blur function. Larger value means slower processing.

+

cacheKey

cacheKey: string

colorMatrix

colorMatrix: number[]

decodeHeight

decodeHeight: number

Number value used as the resized image height

+

decodeWidth

decodeWidth: number

Number value used as the resized image width

+

fadeDuration

fadeDuration: number

Number value used for the fade-in duration. This value is in milliseconds.

+

failureImageUri

failureImageUri: string | ImageSource

String value used for the failure image URI.

+

headers

headers: Record<string, string>

add custom headers to the image download request

+

imageRotation

imageRotation: number

Android: custom imageRotation

+

loadMode

loadMode: "sync" | "async"

lowerResSrc

lowerResSrc: string

String value used for the lower res image URI.

+

noCache

noCache: boolean

placeholderImageUri

placeholderImageUri: string | ImageSource

String value used for the placeholder image URI.

+

progressBarColor

progressBarColor: any

String value used for setting the color of the progress bar. Can be set to hex values ("#FF0000"") and predefined colors ("green").

+

progressiveRenderingEnabled

progressiveRenderingEnabled: boolean

Boolean value used for enabling or disabling the streaming of progressive JPEG images.

+

roundAsCircle

roundAsCircle: boolean

Boolean value used for determining if the image should be rounded as a circle.

+

roundBottomLeft

roundBottomLeft: boolean

Boolean value used for determining if the image's bottom left corner should be rounded.

+

roundBottomRight

roundBottomRight: boolean

Boolean value used for determining if the image's bottom right corner should be rounded.

+

roundTopLeft

roundTopLeft: boolean

Boolean value used for determining if the image's top left corner should be rounded.

+

roundTopRight

roundTopRight: boolean

Boolean value used for determining if the image's top right corner should be rounded.

+

roundedCornerRadius

roundedCornerRadius: number

Number value used as radius for rounding the image's corners.

+

showProgressBar

showProgressBar: boolean

Boolean value used for showing or hiding the progress bar.

+

src

src: SrcType

String value used for the image URI.

+

stretch

stretch: string

String value used by Image image scale type. This property can be set to: 'center' - Performs no scaling. 'centerCrop' - Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent. 'centerInside' - Scales the child so that it fits entirely inside the parent. @@ -76,14 +76,14 @@ 'fitEnd' - Scales the child so that it fits entirely inside the parent. 'fitXY' - Scales width and height independently, so that the child matches the parent exactly. 'focusCrop' - Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.

-

tapToRetryEnabled

tapToRetryEnabled: boolean

Boolean value used for enabling/disabling a tap to retry action for the download of the Image image.

-

tintColor

tintColor: Color

Static failureEvent

failureEvent: string

This event is fired after the fetch of the final image failed.

-

Static finalImageSetEvent

finalImageSetEvent: string

This event is fired after the final image has been set.

-

Static intermediateImageFailedEvent

intermediateImageFailedEvent: string

This event is fired after the fetch of the intermediate image failed.

-

Static intermediateImageSetEvent

intermediateImageSetEvent: string

This event is fired after any intermediate image has been set.

-

Static releaseEvent

releaseEvent: string

This event is fired after the controller released the fetched image.

-

Static submitEvent

submitEvent: string

This event is fired before the image request is submitted.

-

Methods

startAnimating

  • startAnimating(): any

  • Start image animation

    -

    Returns any

stopAnimating

  • stopAnimating(): any

  • Stop image animation

    -

    Returns any

updateImageUri

  • updateImageUri(): any

  • Removes all images with the specified Uri from the memory or/and disk and reinitialize the 'src'.

    -

    Returns any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

tapToRetryEnabled

tapToRetryEnabled: boolean

Boolean value used for enabling/disabling a tap to retry action for the download of the Image image.

+

tintColor

tintColor: Color

Static failureEvent

failureEvent: string

This event is fired after the fetch of the final image failed.

+

Static finalImageSetEvent

finalImageSetEvent: string

This event is fired after the final image has been set.

+

Static intermediateImageFailedEvent

intermediateImageFailedEvent: string

This event is fired after the fetch of the intermediate image failed.

+

Static intermediateImageSetEvent

intermediateImageSetEvent: string

This event is fired after any intermediate image has been set.

+

Static releaseEvent

releaseEvent: string

This event is fired after the controller released the fetched image.

+

Static submitEvent

submitEvent: string

This event is fired before the image request is submitted.

+

Methods

startAnimating

  • startAnimating(): any

  • Start image animation

    +

    Returns any

stopAnimating

  • stopAnimating(): any

  • Stop image animation

    +

    Returns any

updateImageUri

  • updateImageUri(): any

  • Removes all images with the specified Uri from the memory or/and disk and reinitialize the 'src'.

    +

    Returns any

Settings

Member Visibility

Theme

On This Page

constructoralwaysFadeandroidanimatedImageViewaspectRatioautoPlayAnimationsbackgroundUriblurDownSamplingblurRadiuscacheKeycolorMatrixdecodeHeightdecodeWidthfadeDurationfailureImageUriheadersimageRotationloadModelowerResSrcnoCacheplaceholderImageUriprogressBarColorprogressiveRenderingEnabledroundAsCircleroundBottomLeftroundBottomRightroundTopLeftroundTopRightroundedCornerRadiusshowProgressBarsrcstretchtapToRetryEnabledtintColorfailureEventfinalImageSetEventintermediateImageFailedEventintermediateImageSetEventreleaseEventsubmitEventstartAnimatingstopAnimatingupdateImageUri
\ No newline at end of file diff --git a/docs/classes/image.IntermediateEventData.html b/docs/classes/image.IntermediateEventData.html index 86430d3..6c2facc 100644 --- a/docs/classes/image.IntermediateEventData.html +++ b/docs/classes/image.IntermediateEventData.html @@ -1,9 +1,9 @@ -IntermediateEventData | Documentation

Class IntermediateEventData

Instances of this class are provided to the handlers of the intermediateImageSet.

-

Constructors

constructor -

Properties

eventName -imageInfo -object -

Constructors

constructor

Properties

eventName

eventName: string

Returns the name of the event that has been fired.

-

imageInfo

imageInfo: ImageInfo

Contains information about an image.

-

object

object: any

The object that fires the event.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +IntermediateEventData | Documentation

Class IntermediateEventData

Instances of this class are provided to the handlers of the intermediateImageSet.

+

Constructors

constructor +

Properties

eventName +imageInfo +object +

Constructors

constructor

Properties

eventName

eventName: string

Returns the name of the event that has been fired.

+

imageInfo

imageInfo: ImageInfo

Contains information about an image.

+

object

object: any

The object that fires the event.

+

Settings

Member Visibility

Theme

On This Page

constructoreventNameimageInfoobject
\ No newline at end of file diff --git a/docs/classes/zoomimage.ZoomImg.html b/docs/classes/zoomimage.ZoomImg.html index 44a301b..b0e3658 100644 --- a/docs/classes/zoomimage.ZoomImg.html +++ b/docs/classes/zoomimage.ZoomImg.html @@ -1,76 +1,76 @@ -ZoomImg | Documentation

Class ZoomImg

Hierarchy

  • ZoomImageBase
    • ZoomImg

Constructors

constructor -

Properties

alwaysFade -android -animatedImageView -aspectRatio -autoPlayAnimations -backgroundUri -blurDownSampling -blurRadius -cacheKey -colorMatrix -decodeHeight -decodeWidth -fadeDuration -failureImageUri -headers -imageRotation -loadMode -lowerResSrc -maxZoom -minZoom -noCache -placeholderImageUri -progressBarColor -progressiveRenderingEnabled -roundAsCircle -roundBottomLeft -roundBottomRight -roundTopLeft -roundTopRight -roundedCornerRadius -showProgressBar -src -stretch -tapToRetryEnabled -tintColor -zoomScale -failureEvent -finalImageSetEvent -intermediateImageFailedEvent -intermediateImageSetEvent -releaseEvent -submitEvent -

Methods

setZoom -startAnimating -stopAnimating -updateImageUri -

Constructors

constructor

  • new ZoomImg(): ZoomImg

  • Returns ZoomImg

Properties

alwaysFade

alwaysFade: boolean

android

android: any

The native 'com.facebook.drawee.view.SimpleDraweeView' object.

-

animatedImageView

animatedImageView: boolean

IOS: if you want to show animated images you need to set this to true

-

aspectRatio

aspectRatio: number

Number value used as the aspect ratio of the image.

-

autoPlayAnimations

autoPlayAnimations: boolean

Boolean value used for enabling/disabling automatic playing of animated images.

-

backgroundUri

backgroundUri: string

String value used for the background image URI.

-

blurDownSampling

blurDownSampling: number

Number value used to scale the image before applying the blur function. Bigger value means faster processing.

-

blurRadius

blurRadius: number

Number value used as input for the blur function. Larger value means slower processing.

-

cacheKey

cacheKey: string

colorMatrix

colorMatrix: number[]

decodeHeight

decodeHeight: number

Number value used as the resized image height

-

decodeWidth

decodeWidth: number

Number value used as the resized image width

-

fadeDuration

fadeDuration: number

Number value used for the fade-in duration. This value is in milliseconds.

-

failureImageUri

failureImageUri: string | ImageSource

String value used for the failure image URI.

-

headers

headers: Record<string, string>

add custom headers to the image download request

-

imageRotation

imageRotation: number

Android: custom imageRotation

-

loadMode

loadMode: "sync" | "async"

lowerResSrc

lowerResSrc: string

String value used for the lower res image URI.

-

maxZoom

maxZoom: number

minZoom

minZoom: number

noCache

noCache: boolean

placeholderImageUri

placeholderImageUri: string | ImageSource

String value used for the placeholder image URI.

-

progressBarColor

progressBarColor: string

String value used for setting the color of the progress bar. Can be set to hex values ("#FF0000"") and predefined colors ("green").

-

progressiveRenderingEnabled

progressiveRenderingEnabled: boolean

Boolean value used for enabling or disabling the streaming of progressive JPEG images.

-

roundAsCircle

roundAsCircle: boolean

Boolean value used for determining if the image should be rounded as a circle.

-

roundBottomLeft

roundBottomLeft: boolean

Boolean value used for determining if the image's bottom left corner should be rounded.

-

roundBottomRight

roundBottomRight: boolean

Boolean value used for determining if the image's bottom right corner should be rounded.

-

roundTopLeft

roundTopLeft: boolean

Boolean value used for determining if the image's top left corner should be rounded.

-

roundTopRight

roundTopRight: boolean

Boolean value used for determining if the image's top right corner should be rounded.

-

roundedCornerRadius

roundedCornerRadius: number

Number value used as radius for rounding the image's corners.

-

showProgressBar

showProgressBar: boolean

Boolean value used for showing or hiding the progress bar.

-

src

src: string | ImageSource | ImageAsset | Promise<string | ImageSource | ImageAsset>

String value used for the image URI.

-

stretch

stretch: string

String value used by Image image scale type. This property can be set to: +ZoomImg | Documentation

Class ZoomImg

Hierarchy

  • ZoomImageBase
    • ZoomImg

Constructors

constructor +

Properties

alwaysFade +android +animatedImageView +aspectRatio +autoPlayAnimations +backgroundUri +blurDownSampling +blurRadius +cacheKey +colorMatrix +decodeHeight +decodeWidth +fadeDuration +failureImageUri +headers +imageRotation +loadMode +lowerResSrc +maxZoom +minZoom +noCache +placeholderImageUri +progressBarColor +progressiveRenderingEnabled +roundAsCircle +roundBottomLeft +roundBottomRight +roundTopLeft +roundTopRight +roundedCornerRadius +showProgressBar +src +stretch +tapToRetryEnabled +tintColor +zoomScale +failureEvent +finalImageSetEvent +intermediateImageFailedEvent +intermediateImageSetEvent +releaseEvent +submitEvent +

Methods

setZoom +startAnimating +stopAnimating +updateImageUri +

Constructors

constructor

  • new ZoomImg(): ZoomImg

  • Returns ZoomImg

Properties

alwaysFade

alwaysFade: boolean

android

android: any

The native 'com.facebook.drawee.view.SimpleDraweeView' object.

+

animatedImageView

animatedImageView: boolean

IOS: if you want to show animated images you need to set this to true

+

aspectRatio

aspectRatio: number

Number value used as the aspect ratio of the image.

+

autoPlayAnimations

autoPlayAnimations: boolean

Boolean value used for enabling/disabling automatic playing of animated images.

+

backgroundUri

backgroundUri: string

String value used for the background image URI.

+

blurDownSampling

blurDownSampling: number

Number value used to scale the image before applying the blur function. Bigger value means faster processing.

+

blurRadius

blurRadius: number

Number value used as input for the blur function. Larger value means slower processing.

+

cacheKey

cacheKey: string

colorMatrix

colorMatrix: number[]

decodeHeight

decodeHeight: number

Number value used as the resized image height

+

decodeWidth

decodeWidth: number

Number value used as the resized image width

+

fadeDuration

fadeDuration: number

Number value used for the fade-in duration. This value is in milliseconds.

+

failureImageUri

failureImageUri: string | ImageSource

String value used for the failure image URI.

+

headers

headers: Record<string, string>

add custom headers to the image download request

+

imageRotation

imageRotation: number

Android: custom imageRotation

+

loadMode

loadMode: "sync" | "async"

lowerResSrc

lowerResSrc: string

String value used for the lower res image URI.

+

maxZoom

maxZoom: number

minZoom

minZoom: number

noCache

noCache: boolean

placeholderImageUri

placeholderImageUri: string | ImageSource

String value used for the placeholder image URI.

+

progressBarColor

progressBarColor: any

String value used for setting the color of the progress bar. Can be set to hex values ("#FF0000"") and predefined colors ("green").

+

progressiveRenderingEnabled

progressiveRenderingEnabled: boolean

Boolean value used for enabling or disabling the streaming of progressive JPEG images.

+

roundAsCircle

roundAsCircle: boolean

Boolean value used for determining if the image should be rounded as a circle.

+

roundBottomLeft

roundBottomLeft: boolean

Boolean value used for determining if the image's bottom left corner should be rounded.

+

roundBottomRight

roundBottomRight: boolean

Boolean value used for determining if the image's bottom right corner should be rounded.

+

roundTopLeft

roundTopLeft: boolean

Boolean value used for determining if the image's top left corner should be rounded.

+

roundTopRight

roundTopRight: boolean

Boolean value used for determining if the image's top right corner should be rounded.

+

roundedCornerRadius

roundedCornerRadius: number

Number value used as radius for rounding the image's corners.

+

showProgressBar

showProgressBar: boolean

Boolean value used for showing or hiding the progress bar.

+

src

src: SrcType

String value used for the image URI.

+

stretch

stretch: string

String value used by Image image scale type. This property can be set to: 'center' - Performs no scaling. 'centerCrop' - Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent. 'centerInside' - Scales the child so that it fits entirely inside the parent. @@ -79,14 +79,14 @@ 'fitEnd' - Scales the child so that it fits entirely inside the parent. 'fitXY' - Scales width and height independently, so that the child matches the parent exactly. 'focusCrop' - Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.

-

tapToRetryEnabled

tapToRetryEnabled: boolean

Boolean value used for enabling/disabling a tap to retry action for the download of the Image image.

-

tintColor

tintColor: Color

zoomScale

zoomScale: number

Static failureEvent

failureEvent: string

This event is fired after the fetch of the final image failed.

-

Static finalImageSetEvent

finalImageSetEvent: string

This event is fired after the final image has been set.

-

Static intermediateImageFailedEvent

intermediateImageFailedEvent: string

This event is fired after the fetch of the intermediate image failed.

-

Static intermediateImageSetEvent

intermediateImageSetEvent: string

This event is fired after any intermediate image has been set.

-

Static releaseEvent

releaseEvent: string

This event is fired after the controller released the fetched image.

-

Static submitEvent

submitEvent: string

This event is fired before the image request is submitted.

-

Methods

Abstract setZoom

  • setZoom(scale, animated?, point?): any

  • Parameters

    • scale: number
    • Optional animated: boolean
    • Optional point: {
          x: any;
          y: any;
      }
      • x: any
      • y: any

    Returns any

startAnimating

  • startAnimating(): any

  • Start image animation

    -

    Returns any

stopAnimating

  • stopAnimating(): any

  • Stop image animation

    -

    Returns any

updateImageUri

  • updateImageUri(): any

  • Removes all images with the specified Uri from the memory or/and disk and reinitialize the 'src'.

    -

    Returns any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

tapToRetryEnabled

tapToRetryEnabled: boolean

Boolean value used for enabling/disabling a tap to retry action for the download of the Image image.

+

tintColor

tintColor: Color

zoomScale

zoomScale: number

Static failureEvent

failureEvent: string

This event is fired after the fetch of the final image failed.

+

Static finalImageSetEvent

finalImageSetEvent: string

This event is fired after the final image has been set.

+

Static intermediateImageFailedEvent

intermediateImageFailedEvent: string

This event is fired after the fetch of the intermediate image failed.

+

Static intermediateImageSetEvent

intermediateImageSetEvent: string

This event is fired after any intermediate image has been set.

+

Static releaseEvent

releaseEvent: string

This event is fired after the controller released the fetched image.

+

Static submitEvent

submitEvent: string

This event is fired before the image request is submitted.

+

Methods

Abstract setZoom

  • setZoom(scale, animated?, point?): any

  • Parameters

    • scale: number
    • Optional animated: boolean
    • Optional point: {
          x: any;
          y: any;
      }
      • x: any
      • y: any

    Returns any

startAnimating

  • startAnimating(): any

  • Start image animation

    +

    Returns any

stopAnimating

  • stopAnimating(): any

  • Stop image animation

    +

    Returns any

updateImageUri

  • updateImageUri(): any

  • Removes all images with the specified Uri from the memory or/and disk and reinitialize the 'src'.

    +

    Returns any

Settings

Member Visibility

Theme

On This Page

constructoralwaysFadeandroidanimatedImageViewaspectRatioautoPlayAnimationsbackgroundUriblurDownSamplingblurRadiuscacheKeycolorMatrixdecodeHeightdecodeWidthfadeDurationfailureImageUriheadersimageRotationloadModelowerResSrcmaxZoomminZoomnoCacheplaceholderImageUriprogressBarColorprogressiveRenderingEnabledroundAsCircleroundBottomLeftroundBottomRightroundTopLeftroundTopRightroundedCornerRadiusshowProgressBarsrcstretchtapToRetryEnabledtintColorzoomScalefailureEventfinalImageSetEventintermediateImageFailedEventintermediateImageSetEventreleaseEventsubmitEventsetZoomstartAnimatingstopAnimatingupdateImageUri
\ No newline at end of file diff --git a/docs/enums/image.ScaleType.html b/docs/enums/image.ScaleType.html index 80e6cec..3d02b6e 100644 --- a/docs/enums/image.ScaleType.html +++ b/docs/enums/image.ScaleType.html @@ -1,18 +1,18 @@ -ScaleType | Documentation

Enumeration ScaleType

Options for scaling the child bounds to the parent bounds

-

Enumeration Members

center -centerCrop -centerInside -fitCenter -fitEnd -fitStart -fitXY -focusCrop -

Enumeration Members

center

center: number

Performs no scaling.

-

centerCrop

centerCrop: number

Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.

-

centerInside

centerInside: number

Scales the child so that it fits entirely inside the parent.

-

fitCenter

fitCenter: number

Scales the child so that it fits entirely inside the parent.

-

fitEnd

fitEnd: number

Scales the child so that it fits entirely inside the parent.

-

fitStart

fitStart: number

Scales the child so that it fits entirely inside the parent.

-

fitXY

fitXY: number

Scales width and height independently, so that the child matches the parent exactly.

-

focusCrop

focusCrop: number

Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ScaleType | Documentation

Enumeration ScaleType

Options for scaling the child bounds to the parent bounds

+

Enumeration Members

center +centerCrop +centerInside +fitCenter +fitEnd +fitStart +fitXY +focusCrop +

Enumeration Members

center

center: number

Performs no scaling.

+

centerCrop

centerCrop: number

Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.

+

centerInside

centerInside: number

Scales the child so that it fits entirely inside the parent.

+

fitCenter

fitCenter: number

Scales the child so that it fits entirely inside the parent.

+

fitEnd

fitEnd: number

Scales the child so that it fits entirely inside the parent.

+

fitStart

fitStart: number

Scales the child so that it fits entirely inside the parent.

+

fitXY

fitXY: number

Scales width and height independently, so that the child matches the parent exactly.

+

focusCrop

focusCrop: number

Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.

+

Settings

Member Visibility

Theme

On This Page

centercenterCropcenterInsidefitCenterfitEndfitStartfitXYfocusCrop
\ No newline at end of file diff --git a/docs/functions/image.getImagePipeline.html b/docs/functions/image.getImagePipeline.html index e732420..e2944cf 100644 --- a/docs/functions/image.getImagePipeline.html +++ b/docs/functions/image.getImagePipeline.html @@ -1,3 +1,3 @@ -getImagePipeline | Documentation

Function getImagePipeline

  • getImagePipeline(): ImagePipeline

  • When called, initializes the android Image library. Calling this method is required. +getImagePipeline | Documentation

    Function getImagePipeline

    • getImagePipeline(): ImagePipeline

    • When called, initializes the android Image library. Calling this method is required. A good place to call it is at the application onLaunch() method.

      -

      Returns ImagePipeline

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ImagePipeline

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/image.initialize.html b/docs/functions/image.initialize.html index 76a659a..38832ea 100644 --- a/docs/functions/image.initialize.html +++ b/docs/functions/image.initialize.html @@ -1,3 +1,3 @@ -initialize | Documentation

Function initialize

  • initialize(config?): void

  • When called, initializes the android Image library. Calling this method is required. +initialize | Documentation

    Function initialize

    • initialize(config?): void

    • When called, initializes the android Image library. Calling this method is required. A good place to call it is at the application onLaunch() method.

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/image.registerPluginGetContextFromOptions.html b/docs/functions/image.registerPluginGetContextFromOptions.html new file mode 100644 index 0000000..93137f2 --- /dev/null +++ b/docs/functions/image.registerPluginGetContextFromOptions.html @@ -0,0 +1 @@ +registerPluginGetContextFromOptions | Documentation

Function registerPluginGetContextFromOptions

  • registerPluginGetContextFromOptions(callback): any

  • Parameters

    Returns any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/image.shutDown.html b/docs/functions/image.shutDown.html index 0d7a66c..588fc98 100644 --- a/docs/functions/image.shutDown.html +++ b/docs/functions/image.shutDown.html @@ -1,3 +1,3 @@ -shutDown | Documentation

Function shutDown

  • shutDown(): void

  • Shuts the native Image and SimpleDraweeView down. By design this method should not be called manually as it is handled by the Image library internally. +shutDown | Documentation

    Function shutDown

    • shutDown(): void

    • Shuts the native Image and SimpleDraweeView down. By design this method should not be called manually as it is handled by the Image library internally. NOTE: Be careful when manuallycalling this method as it will completely shutdown the functionality of Image.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/image_colorfilter.installMixins.html b/docs/functions/image_colorfilter.installMixins.html index 746e8a6..486dfa8 100644 --- a/docs/functions/image_colorfilter.installMixins.html +++ b/docs/functions/image_colorfilter.installMixins.html @@ -1 +1 @@ -installMixins | Documentation

Function installMixins

  • installMixins(): any

  • Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +installMixins | Documentation

Function installMixins

  • installMixins(): any

  • Returns any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index b0f88f7..ced209c 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -Documentation

Documentation

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Documentation

Documentation

Class Hierarchy

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 851dec6..f0898d0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Documentation

Documentation

This monorepo contains multiple packages:

+Documentation

Documentation

This monorepo contains multiple packages:

image