diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..5674cf3 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..01bcad5 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=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=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_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=i?r.index.search(`*${i}*`):[];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 Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!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&&(He=!0,F="touchstart",pe="touchmove",B="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(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&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(n){super(n);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; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);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 r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.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();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..91404e4 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WVwW7cIBCG38XnqFW3VVXl3EtfIJeqQhPADloM7oCdRVXfvdhONo53GNzLrsw/32c82PDzTxP1JTb3zXcDHULf3DUDxKc8IC2EoMPHl+DDU+xtTs/Gqeb+0+nb37sr+8NFjSCjmfQtvwk5x4OW0ePpln8JOFbpFkYbhVqnKkJMdjOTCdDAo80usvC9+fOJEM+Xx+231QdvoSBCTTzXMLqHTQfb0eW2e5d7uGvf1y9bRBkkoTzOYOCcjzCXCnDdtiNvin3NMd20rHjFtxb9j3Bp3yHrUsmpUZIelCyE/pnGclADyWVdEw69kNiFRXQQuh9iotHXtKaICC60Hvui5lrBqKRBSb9aa8KhI040OQcM+PrlSt8/GkcqdiWcDOFZRC/C1JGit5iRFJejthIt+l4o3aEmH2MTMxLjpM0PqcRggW7H+wpGZQv9tHwTcxwGkCV0yRh8sJ787ufxCtaWuLYCTiVw4kBvU+cdia4RA2Peuoob8TVkBd1oAQUzi10JIwu/R0ByKmvCoRGFhXwxfxijM9IrWkTUVbS5sM8anX+MBCtMBGvIvbxczdyidMBUjpP5Lx/2JTJHDDw6pVEsexr5sm5zRnPJj3juAc+U4xoeEZQPj11JTRaKjsChaT5cSHRJWLRDo2h0Thg0ce1LB9qX6u1Lh9uXiu1LdPt+/QMKO0HtCAwAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..5f34f47 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA72c25abOhKG38W5dXqDxLGv52a/QG56ZXkRG3czscGDsdOeXnn3kQCbv3AVYDqzL5JeNnWQ9JVKB0t8LMri13Hx/PKx+Jnlm8Wzq6LlIk/26eJ58a8seS2T/WK5OJU783m9S47H9PhX+/3TW7XfmYft10Zg8Xt5teO76mZnXeTHqjytq6IctPWFCoLd5eKQlGleQaE6V66jvJuv6nJIh520ErOsr9+y3caIjlSjk5rl5ZBUb8MeWolZ1osye81GanCTmeXhWF12IxCuIvMYp+/VJqmSEc6d1FQvyvEiiNrDZSxca4mZ1vc/snyklTqhWT6qYrU+leex/tBJzfVyKHaX12IkpojcLE/JZmNMZHl1HPZE5GZ5Oh1M5KSrCYHck+y8VcfN1+z49VBmZyPwgO9tttsN+2wlZtXM5Nfi52jnbGVmeSgOyTqrRrpOJ/SJWvzKNmOJkgp+wtfO9MN1cpjirRP9hL9/F2M5msh9wtMmOb4lZZmMELsXnuXznNrRPd1uzd9hhz3Jz/TjaQPGvfCf6M1FXm2TfbYbaV4iN6uu1sIx++9I3wap2V5+pdnr2wg9IjdvXDEcknz9NjZpJHKzPG2KfZYnefUjOdadd9gfIz3L64/ilG+y/HX1o3gf9tiTnNeaZZIft0U5PJv/gmLz/eyaPjLmpxWb5edQHLMqG5tzgNQsL2VRjVblJjMvB6+T0blyKzKvBul2ZxLoqjinZTMpGqkNJ/95z+PdihP/jN9J3maPYttdNjIXuIrMsv82bv/tM/Zf02o1JbcSuVme9obnasqSkwrO8rVagZF6HB92ycp/tpYT/P4pr3YXYLVL89cp2wWd4Exf5mFaldl6ShZhpKd6DWAfpLes3J7ytc3mx7/aJ4M7UGCIZJ/Oiv16qgm6kO5s1N9PNZLuD7Aw6ozU3081QuKrs2G/nmpi07T6qr8J0VnrSQwaxi3Db/WkXd1FR/v9H9kyRFuTtgyvhRK2k+5nX8SDPOUasXs/4yd25Yn+vd3+Nsiw5UZglu3j6cew7UZgnm12qkOtD051RuzvT/f7JsR6IzDLtjARJOZHJoIjHjbFfU4l5huBWbbXZXG83zOj/agVmWU//c8p2Y04uMnM8iCMcsTDyAA31qvy17HovIrMsp+bRVWy49bnxAeKTfUDmf1bl3q7ZP5tOO+i+iYrOQPm66kmtmWxX23S1zLlxhV4+sDgfTwka2EArx9NHvfK5NeqKlbH8ys35nVPBw3qbpjapNvktKtW1+GSbhifkzJLfuwMYlbuUSd2hJ/s6V54jjuyacY7sSJT2780oUv7Wdf6t2dTjR1NQik5S82D6WV6Pe2S8u43DCwZkZg8Y8zKNVvT5sFUM0m5ZmyYb6cbKItfrAnz/UNGuNzSPHhk7mrCSJi+mieT4Vflym4fvdsOe8qzdbFhQ4ERe8SF0dqbtVNq/svM1GSVVSY3czxk4clT57/zKi0TY4/5wQ6e/ZEpdN/epGk0FlCY8mb5YXVLE+Ne++KP+A18Xwew9Gd/+B/2+NRofdVTXD/Rwg40gPl3Yn6iZMtyk/1nqt64u9ZbTa53W0yh0vXAee0L4wXpi///q048Pt20xutOiyoyNwpnbgLMMOhE/wnirbcrcG8i8GshpVMwRV4lWZ6WZoJxnpRbiPgjFadLJENjGuzPeDnusk06IWXe5B4CCUPqe3pc3f8sA0MrERgetobiY9Dil953I52jJ92rg1BPtiR/pj7XOoyX25R1gIO0M9c9nDpteDeD/899Uv4UbfYkHjY8ZPIhY0fJ0nGqmctoZS/zKnsZqOzl0cpepMpeHqrs+8VGA9dm9YPpZl7LbMOasQ+mmjnsCm4b2H79iImzYOP8iJGtYGQ71cgpN6m0OYbG2cLHk1cseW7344z+qjlJwvXuvsxs4ythV54XnOFGWjb3RaaazvK1/fljszrsEvYXACrAmf2+NFY26fvi+WNxTsujnSI9L9STfoqN5DZLdxt7srjxuLQnHvc2GX9vnzX7WFaiEfnLWSxfnKWnn0Idfv++fLlq1A/qL2ox13xyl9p/UoFHxFwiZia3L4qzpoiYmfu/aE5MEzEzc3rxODGPiPnmk8+J+UQsMJ8CTiwgYqH5FHJiIRGLzKeIE4uImIHyEnNiMW1e29ouy8HtgahJuKwkZeHaNndZGi7F4dpmd1kgLiXi2pZ3WSYuheLaxndZLC7l4tr2d1kyLkXjWgQuC8eldFxLwWX5uBSQa0G4LCKXMlIWhGIZKcpIWRCKZaR6/aXuMHyPoYyUBaFYRooyUhaEYhkpykhZEIplpCgjZUEolpGijJQFoVhGijJSFoRiGSnKSFkQimWkKCNtQWiWkaaMtAWhWUaaMtIWhFZLHT0FKqKSvbRW5zXNSlJG2oLQLCNNGWkLQrOMNGWkLQjNMtKUkbYgNMtIU0bagtAsI00ZaQtCs4w0ZeRZEB7LyKOMPAvCYxl5lJFnQXhsP/IoI8+C8Nh+5PVGn3r44ccfysizIDyWkUcZeRaExzLyKCPPgvBYRh5l5FkQHsvIo4w8C8JjGXmUkW9B+CwjnzLyLQifZeRTRr6S5hA+ReRbDj4L06eIfMvBZ2H6vTlCPUlgYfoUkW85+Px8giLyQ7G7+xSRbzn4LHafIvJjMdn4FFFQI2IDJKCIghoRGyABRRRYED4bIAFlFFgQARsgAWUUWBABGyABZRRYEAHLPehN5eq5HMs9oIwCCyJguQeUUWBBBCz3gDIKLIiAn0pSRqEFEfCzScootCACllFIGYUWRMAyCimj0IIIWUYhZRRaECHLKKSMQgsiZBmFlFFoQYQso7A3466n3CyjkDIKLYiQZRRSRqEFEbKMQsoosiBCllFEGUUWRMhP+imjyIIIWUYRZRRZEBHLKKKMIgsiYhlFlFHkS4k2oogiyyFiYUYUUWQ5RHqp4icn1FSyty6qF0YszIgiimLZJkUUWw4Riz2miGJXtBlTRLHlELEBElNEsZZtUkRxjYgNpZgiii2IiA2lmDKKa0b8EpIyii2ImA2lmDKKI7lGveVrvX5lgy7ur2Ad0WjzDGUti5hfmjq9VaxjacT84tTprWMdyyPml6dObyXrWCIxv0B1emtZxzKJ+SWq01vNOpZKzC9Snd561qmR8ctUp7eidSyZmF+oOr01rVMvah1hP6EHrt17ELYU+rsP9faDw6Prb0A0OxAOz66/B9FsQjg8vP42RLMP4fD0+jsRzVaEw+Prb0Y0uxEOz6+/H9FsSDg8wHZLot6wO6dllW7+bjbuXl7YQ/Mfi1W7s2eWPO2O4cfCLHSeP37/7nby7Cfr5/rbS6dmOt9NzWRlI7hcmExa/43d9q9u/0bNX9s1efv1edbOuO91xs2MWdS53QHuVLvjER8LQ11QbbZaO60AGsFMFCWt/l4tuDUQO78G3aiJ65Y12vDRxoRikJ1pNBSgIbEB7bmjTisE72Ek6tRHjUALXIXxkJYiatBckRgV76gSA6NY9AQ/9YEqBoUjBXn/51rQd8B1KKjTO3ydcncA6GOhpHbtXijRKUIP05JaewINGha6TigVdX29FQBVhBqKWnCCCKIN2rbp575q84EUeb3zApBVICxiqQM0L2UAJQglSaU5+wwZBpQCKSDaGyGQK6F4ntS4wolRSDbgO5R8Dx0JBVOALZSy3f1xTwgXiOxQirLN9S0xnR6oSb337goKtD6o+6L+3S1c6FMAQokgCpIVfdAJRKf10RKILWAVS+HcO+4E2pBS4yGXtyPLgBaKG0q6d5nOg/J6Um+4HtSHtoE4CqQ4al5KAR0fUo04WuGtd+AHuU1JYdddZAdF8KmGfF5vpoMqwFASSnK2HWCAbiA1K16lhCwOTaul1Npe9QQt4Kglh/1feHEGAPp2cigZ6M4nQtRCG0eyb3KwE7RhrI2keVCGJ2FBF8aSSKILJ+xAE6YhsRTA1+sjwBUSUSDFYT/5eODLk2rY3WkAb6AYSKFAbsmCUyipJ6WDwXk+cPGkFqrvT0FagAL7UiTAfRaoKngLpM52e0UMBC7OXKW2vW8d6J6Ss/sLq9A2EPGeFHfNG7lACXQGVFb3UedB9vOkqGtO/2CXxomWK4VAe1gH9TTqSeTbk0Koh5NmV5qn3C5VQPWAhifiuL23AZIe1FBLDuGGCUxjQDOUaNzeCAAeIdy0FG7MewvAAlRWS5XlXrkAJiCStFz43iUWqDwADsVKtFcXwS3w1e2M3ZeyUnttE7RxddKu831pnLkepIV8jesNqczX+z9QVShzKLU2f3MEjIDvSOoPQ3dDoBqQlSOpJ19ftgV9Cxf6A9Wgr2OCqQy4VVImwLdHgWuovCvSpm+5Am2cVkgDAnkjF+jiDokYKXcrHBhHJB17YRnGAhwMJJ270RGaxZOaBd9DBDCgiGrI393aC2J5QK2+TQVauNyVkmT3xj9M6LgJIisyGcYlQ4+kyu2cKGhXJbZr96ogSDBQXC0Wt7crCelB6tj0ICo2Dy5nXKkz07cBgjqOsiPKXDAoLLpU9jPZQwvAZSAF3rm+7wtKUMtACrvz9R0P0KsgBHwpBOgL3aByoKxE5bs1EHQQLRWVbLX50Ii+BAFO2cP2F8J3RlWZLUbk70gAr4fyQQ+HAkca/a8H00EP87gjpeLrSXQMc5IGpC5J6uZD3XypiBe2WTHnO1KM3t0xAAO4HnCkofJy36w4UDls8HxfLg7Zodlaen75/vv3/wAf17TqKlkAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..108428c --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1383 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + 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; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/classes/Diagram.html b/docs/classes/Diagram.html new file mode 100644 index 0000000..a6731e5 --- /dev/null +++ b/docs/classes/Diagram.html @@ -0,0 +1,885 @@ +Diagram | diagramatics
+
+ +
+
+
+
+ +

Class Diagram

+
+

Diagram Class

+

Diagram is a tree structure +Diagram can be a polygon, a curve, or a diagram +Polygon is a closed path +Curve is an open path +Diagram is a tree of Diagrams

+
+
+
+

Hierarchy

+
    +
  • Diagram
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
children +origin +path +style +textdata +type +
+
+

Methods

+
__move_origin_text +add_points +bounding_box +combine +copy +dominantbaseline +fill +fontfamily +fontsize +fontweight +get_anchor +hflip +move_origin +move_origin_text +opacity +parametric_point +path_length +position +reflect +reflect_over_line +reflect_over_point +rotate +scale +stroke +strokedasharray +strokejoin +strokelinecap +strokewidth +textanchor +to_curve +to_polygon +transform +translate +update_style +update_textdata +vectoreffect +vflip +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      type_: DiagramType
      • +
    • +
      args: {
          children?: Diagram[];
          path?: Path;
          textdata?: TextData;
      } = {}
      +
        +
      • +
        Optional children?: Diagram[]
        • +
      • +
        Optional path?: Path
        • +
      • +
        Optional textdata?: TextData
    +

    Returns Diagram

+
+

Properties

+
+

children

+
children: Diagram[] = []
+
+

origin

+
origin: Vector2 = ...
+
+

path

+
path: undefined | Path = undefined
+
+

style

+
style: DiagramStyle = {}
+
+

textdata

+
textdata: TextData = {}
+
+

type

+
type: DiagramType
+
+

Methods

+
+

__move_origin_text

+
    +
  • __move_origin_text(anchor): Diagram
    • +
  • +

    Move the origin of text diagram to an anchor

    +
    +
    +

    Parameters

    +
      +
    • +
      anchor: Anchor
      +

      anchor to move the origin to. +anchors can be +'top-left', 'top-center', 'top-right' +'center-left', 'center-center', 'center-right' +'bottom-left', 'bottom-center', 'bottom-right'

      +
      +
    +

    Returns Diagram

    +
+
+

add_points

+
    + +
  • +

    Add points to the diagram +if the diagram is a polygon or curve, add points to the path +if the diagram is a diagram, add points to the last polygon or curve child

    +
    +
    +

    Parameters

    +
      +
    • +
      points: Vector2[]
      +

      points to add

      +
      +
    +

    Returns Diagram

    +
+
+

bounding_box

+
    + +
  • +

    Get the bounding box of the diagram

    +
    +

    Returns [Vector2, Vector2]

    [min, max] where min is the top left corner and max is the bottom right corner

    + +
+
+

combine

+
    + +
  • +

    Combine another diagram with this diagram

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...diagrams: Diagram[]
      +

      a diagram or a list of diagrams

      +
      +
    +

    Returns Diagram

    +
+
+

copy

+
+
+

dominantbaseline

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      dominantbaseline: "middle" | "auto" | "text-bottom" | "alphabetic" | "ideographic" | "central" | "mathematical" | "hanging" | "text-top"
    +

    Returns Diagram

+
+

fill

+
+
+

fontfamily

+
+
+

fontsize

+
+
+

fontweight

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      fontweight: number | "normal" | "bold" | "bolder" | "lighter"
    +

    Returns Diagram

+
+

get_anchor

+
    + +
  • +

    Get the position of the anchor of the diagram

    +
    +
    +

    Parameters

    +
      +
    • +
      anchor: Anchor
      +

      anchor to get, anchors can be + 'top-left', 'top-center', 'top-right' + 'center-left', 'center-center', 'center-right' + 'bottom-left', 'bottom-center', 'bottom-right'

      +
      +
    +

    Returns Vector2

    the position of the anchor

    + +
+
+

hflip

+
    + +
  • +

    Horizontal flip +Reflect the diagram over a vertical line x = a

    +
    +
    +

    Parameters

    +
      +
    • +
      a: number = 0
      +

      x value of the line

      +
      +
    +

    Returns Diagram

    +
+
+

move_origin

+
    + +
  • +

    Move the origin of the diagram to a position or anchor

    +
    +
    +

    Parameters

    +
      +
    • +
      pos: Vector2 | Anchor
      +

      position to move the origin to (Vector2), or anchor to move the origin to. +anchors can be + 'top-left', 'top-center', 'top-right' + 'center-left', 'center-center', 'center-right' + 'bottom-left', 'bottom-center', 'bottom-right'

      +
        +
      • for texts, use move_origin_text()
        • +
      +
      +
    +

    Returns Diagram

    +
+
+

move_origin_text

+
    +
  • move_origin_text(anchor): Diagram
    • +
  • +

    Move the origin of text diagram to a position

    +
    +
    +

    Parameters

    +
      +
    • +
      anchor: Anchor
      +

      anchor to move the origin to. +anchors can be +'top-left', 'top-center', 'top-right' +'center-left', 'center-center', 'center-right' +'bottom-left', 'bottom-center', 'bottom-right'

      +
      +
    +

    Returns Diagram

    +
+
+

opacity

+
+
+

parametric_point

+
    + +
  • +

    Get the point on the path at t +Path can be described parametrically in the form of (x(t), y(t)) +Path starts at t=0 and ends at t=1

    +
    +
    +

    Parameters

    +
      +
    • +
      t: number
      +

      parameter

      +
      +
      • +
    • +
      Optional segment_index: number
      +

      (only works for polygon and curves) +If segment_index (n) is defined, get the point at the nth segment +If segment_index (n) is defined, t can be outside of [0, 1] and will return the extrapolated point

      +
      +
    +

    Returns Vector2

    the position of the point

    + +
+
+

path_length

+
    + +
  • +

    Returns number

+
+

position

+
    + +
  • +

    move the diagram to a position

    +
    +
    +

    Parameters

    +
      +
    • +
      v: Vector2 = ...
      +

      position to move to (if left undefined, move to the origin)

      +
      +
    +

    Returns Diagram

    +
+
+

reflect

+
    + +
  • +

    Reflect the diagram +if given 0 arguments, reflect over the origin +if given 1 argument, reflect over a point p1 +if given 2 arguments, reflect over a line defined by two points p1 and p2

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional p1: Vector2
      +

      point

      +
      +
      • +
    • +
      Optional p2: Vector2
      +

      point

      +
      +
    +

    Returns Diagram

    +
+
+

reflect_over_line

+
    + +
  • +

    Reflect the diagram over a line defined by two points

    +
    +
    +

    Parameters

    +
      +
    • +
      p1: Vector2
      +

      point on the line

      +
      +
      • +
    • +
      p2: Vector2
      +

      point on the line

      +
      +
    +

    Returns Diagram

    +
+
+

reflect_over_point

+
    + +
  • +

    Reflect the diagram over a point

    +
    +
    +

    Parameters

    +
      +
    • +
      p: Vector2
      +

      point to reflect over

      +
      +
    +

    Returns Diagram

    +
+
+

rotate

+
    + +
  • +

    Rotate the diagram by an angle around a pivot

    +
    +
    +

    Parameters

    +
      +
    • +
      angle: number
      +

      angle to rotate

      +
      +
      • +
    • +
      pivot: undefined | Vector2 = undefined
      +

      pivot point, if left undefined, rotate around the origin

      +
      +
    +

    Returns Diagram

    +
+
+

scale

+
    + +
  • +

    Scale the diagram by a scale around a origin

    +
    +
    +

    Parameters

    +
      +
    • +
      scale: Vector2
      +

      scale to scale (x, y)

      +
      +
      • +
    • +
      Optional origin: Vector2
      +

      origin point, if left undefined, scale around the origin

      +
      +
    +

    Returns Diagram

    +
+
+

stroke

+
+
+

strokedasharray

+
+
+

strokejoin

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      linejoin: "round" | "arcs" | "bevel" | "miter" | "miter-clip"
    +

    Returns Diagram

+
+

strokelinecap

+
+
+

strokewidth

+
+
+

textanchor

+
+
+

to_curve

+
    + +
  • +

    Convert the diagram to a curve +If the diagram is a polygon, convert it to a curve +If the diagram is a Diagram, convert all of the children to curves

    +
    +

    Returns Diagram

    +
+
+

to_polygon

+
    + +
  • +

    Convert the diagram to a polygon +If the diagram is a curve, convert it to a polygon +If the diagram is a Diagram, convert all of the children to polygons

    +
    +

    Returns Diagram

    +
+
+

transform

+
    + +
  • +

    Transform the diagram by a function

    +
    +
    +

    Parameters

    +
      +
    • +
      transform_function: ((p) => Vector2)
      +

      function to transform the diagram

      +
      +
      +
    +

    Returns Diagram

    +
+
+

translate

+
+
+

Private update_style

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      stylename: keyof DiagramStyle
      • +
    • +
      stylevalue: string
    +

    Returns Diagram

+
+

Private update_textdata

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      textdataname: keyof TextData
      • +
    • +
      textdatavalue: string
    +

    Returns Diagram

+
+

vectoreffect

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      vectoreffect: "none" | "non-scaling-stroke" | "non-scaling-size" | "non-rotation" | "fixed-position"
    +

    Returns Diagram

+
+

vflip

+
    + +
  • +

    Vertical flip +Reflect the diagram over a horizontal line y = a

    +
    +
    +

    Parameters

    +
      +
    • +
      a: number = 0
      +

      y value of the line

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/Interactive.html b/docs/classes/Interactive.html new file mode 100644 index 0000000..bd39c4f --- /dev/null +++ b/docs/classes/Interactive.html @@ -0,0 +1,211 @@ +Interactive | diagramatics
+
+ +
+
+
+
+ +

Class Interactive

+
+

Hierarchy

+
    +
  • Interactive
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
container_div +draw_function +inp_inputs +inp_variables +intervals +
+
+

Methods

+
draw +slider +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      container_div: HTMLElement
      • +
    • +
      Optional inp_object_: {
          [key: string]: any;
      }
      +
        +
      • +
        [key: string]: any
    +

    Returns Interactive

+
+

Properties

+
+

container_div

+
container_div: HTMLElement
+
+

draw_function

+
draw_function: ((inp_object) => any) = ...
+
+

Type declaration

+
    +
  • +
      +
    • (inp_object): any
      • +
    • +
      +

      Parameters

      +
        +
      • +
        inp_object: {
            [key: string]: any;
        }
        +
          +
        • +
          [key: string]: any
      +

      Returns any

+
+

inp_inputs

+
inp_inputs: {
    [key: string]: HTMLInputElement;
} = {}
+
+

Type declaration

+
    +
  • +
    [key: string]: HTMLInputElement
+
+

inp_variables

+
inp_variables: {
    [key: string]: any;
} = {}
+
+

Type declaration

+
    +
  • +
    [key: string]: any
+
+

intervals

+
intervals: {
    [key: string]: any;
} = {}
+
+

Type declaration

+
    +
  • +
    [key: string]: any
+
+

Methods

+
+

draw

+
+
+

slider

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      variable_name: string
      • +
    • +
      min: number = 0
      • +
    • +
      max: number = 100
      • +
    • +
      value: number = 50
      • +
    • +
      step: number = -1
      • +
    • +
      time: number = 1.5
    +

    Returns void

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/Vector2.html b/docs/classes/Vector2.html new file mode 100644 index 0000000..adc8f1c --- /dev/null +++ b/docs/classes/Vector2.html @@ -0,0 +1,275 @@ +Vector2 | diagramatics
+
+ +
+
+
+
+ +

Class Vector2

+
+

Class for 2D Vectors

+
+
+
+

Hierarchy

+
    +
  • Vector2
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
x +y +
+
+

Methods

+
add +angle +cross +dot +equals +length +mul +normalize +rotate +scale +sub +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

x

+
x: number
+
+

y

+
y: number
+
+

Methods

+
+

add

+
+
+

angle

+
+
+

cross

+
+
+

dot

+
+
+

equals

+
+
+

length

+
+
+

mul

+
+
+

normalize

+
+
+

rotate

+
+
+

scale

+
+
+

sub

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/V2.html b/docs/functions/V2.html new file mode 100644 index 0000000..95a1959 --- /dev/null +++ b/docs/functions/V2.html @@ -0,0 +1,77 @@ +V2 | diagramatics
+
+ +
+
+
+
+ +

Function V2

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/Vdir.html b/docs/functions/Vdir.html new file mode 100644 index 0000000..f5d004e --- /dev/null +++ b/docs/functions/Vdir.html @@ -0,0 +1,79 @@ +Vdir | diagramatics
+
+ +
+
+
+
+ +

Function Vdir

+
+
    + +
  • +

    Helper function to create a Vector2 from an angle

    +
    +
    +

    Parameters

    +
      +
    • +
      angle: number
      +

      angle in radians

      +
      +
    +

    Returns Vector2

    Vector2 with length 1

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/annotation_angle.html b/docs/functions/annotation_angle.html new file mode 100644 index 0000000..c1e984f --- /dev/null +++ b/docs/functions/annotation_angle.html @@ -0,0 +1,93 @@ +annotation_angle | diagramatics
+
+ +
+
+
+
+ +

Function annotation_angle

+
+
    + +
  • +

    Create an annotation for angle

    +
    +
    +

    Parameters

    +
      +
    • +
      p: [Vector2, Vector2, Vector2]
      +

      three points to define the angle

      +
      +
      • +
    • +
      Optional str: string
      +

      string to be annotated (will be converted to mathematical italic)

      +
      +
      • +
    • +
      radius: number = 1
      +

      radius of the arc

      +
      +
      • +
    • +
      Optional text_offset: Vector2
      +

      position offset of the text

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/annotation_vector.html b/docs/functions/annotation_vector.html new file mode 100644 index 0000000..e46797d --- /dev/null +++ b/docs/functions/annotation_vector.html @@ -0,0 +1,94 @@ +annotation_vector | diagramatics
+
+ +
+
+
+
+ +

Function annotation_vector

+
+
    + +
  • +

    Create an annotation vector

    +
    +
    +

    Parameters

    +
      +
    • +
      v: Vector2
      +

      vector to be annotated

      +
      +
      • +
    • +
      Optional str: string
      +

      string to be annotated (will be converted to mathematical italic) +if you don't want to convert to mathematical italic, use annotation_vector_textmode

      +
      +
      • +
    • +
      Optional text_offset: Vector2
      +

      position offset of the text

      +
      +
      • +
    • +
      Optional arrow_head_size: number
      +

      size of the arrow head

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/annotation_vector_text.html b/docs/functions/annotation_vector_text.html new file mode 100644 index 0000000..804d49e --- /dev/null +++ b/docs/functions/annotation_vector_text.html @@ -0,0 +1,94 @@ +annotation_vector_text | diagramatics
+
+ +
+
+
+
+ +

Function annotation_vector_text

+
+
    +
  • annotation_vector_text(v, str?, text_offset?, arrow_head_size?): Diagram
    • +
  • +

    Create an annotation vector

    +
    +
    +

    Parameters

    +
      +
    • +
      v: Vector2
      +

      vector to be annotated

      +
      +
      • +
    • +
      Optional str: string
      +

      string to be annotated (will not be converted to mathematical italic) +if you want to convert to mathematical italic, use annotation_vector

      +
      +
      • +
    • +
      Optional text_offset: Vector2
      +

      positiono ffset of the text

      +
      +
      • +
    • +
      Optional arrow_head_size: number
      +

      size of the arrow head

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/arc.html b/docs/functions/arc.html new file mode 100644 index 0000000..00103ec --- /dev/null +++ b/docs/functions/arc.html @@ -0,0 +1,84 @@ +arc | diagramatics
+
+ +
+
+
+
+ +

Function arc

+
+
    + +
  • +

    Create an arc centered at origin

    +
    +
    +

    Parameters

    +
      +
    • +
      radius: number = 1
      +

      radius of the arc

      +
      +
      • +
    • +
      angle: number = ...
      +

      angle of the arc

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/arrow.html b/docs/functions/arrow.html new file mode 100644 index 0000000..cbd3f2a --- /dev/null +++ b/docs/functions/arrow.html @@ -0,0 +1,81 @@ +arrow | diagramatics
+
+ +
+
+
+
+ +

Function arrow

+
+
    + +
  • +

    Create arrow from start to end

    +
    +
    +

    Parameters

    +
      +
    • +
      v: Vector2
      • +
    • +
      headsize: number = 3
      +

      size of the arrow head

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/arrow2.html b/docs/functions/arrow2.html new file mode 100644 index 0000000..0162340 --- /dev/null +++ b/docs/functions/arrow2.html @@ -0,0 +1,76 @@ +arrow2 | diagramatics
+
+ +
+
+
+
+ +

Function arrow2

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/ax.html b/docs/functions/ax.html new file mode 100644 index 0000000..3e1b35d --- /dev/null +++ b/docs/functions/ax.html @@ -0,0 +1,83 @@ +ax | diagramatics
+
+ +
+
+
+
+ +

Function ax

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/axes_empty.html b/docs/functions/axes_empty.html new file mode 100644 index 0000000..f4e5dd1 --- /dev/null +++ b/docs/functions/axes_empty.html @@ -0,0 +1,82 @@ +axes_empty | diagramatics
+
+ +
+
+
+
+ +

Function axes_empty

+
+
    + +
  • +

    Draw xy axes without ticks

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional axes_options: axes_options
      +

      options for the axes +example: opt = { + bbox : [V2(-100,-100), V2(100,100)], +}

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/axes_transform.html b/docs/functions/axes_transform.html new file mode 100644 index 0000000..d890693 --- /dev/null +++ b/docs/functions/axes_transform.html @@ -0,0 +1,83 @@ +axes_transform | diagramatics
+
+ +
+
+
+
+ +

Function axes_transform

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/circle.html b/docs/functions/circle.html new file mode 100644 index 0000000..65ca135 --- /dev/null +++ b/docs/functions/circle.html @@ -0,0 +1,80 @@ +circle | diagramatics
+
+ +
+
+
+
+ +

Function circle

+
+
    + +
  • +

    Create circle centered at origin +currently implemented as a regular polygon with 50 sides

    +
    +
    +

    Parameters

    +
      +
    • +
      radius: number = 1
      +

      radius of the circle

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/curve.html b/docs/functions/curve.html new file mode 100644 index 0000000..d47bd45 --- /dev/null +++ b/docs/functions/curve.html @@ -0,0 +1,79 @@ +curve | diagramatics
+
+ +
+
+
+
+ +

Function curve

+
+
    + +
  • +

    Create a curve from a list of points

    +
    +
    +

    Parameters

    +
      +
    • +
      points: Vector2[]
      +

      list of points

      +
      +
    +

    Returns Diagram

    a curve diagram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/diagram_combine.html b/docs/functions/diagram_combine.html new file mode 100644 index 0000000..df619c9 --- /dev/null +++ b/docs/functions/diagram_combine.html @@ -0,0 +1,79 @@ +diagram_combine | diagramatics
+
+ +
+
+
+
+ +

Function diagram_combine

+
+
    + +
  • +

    Combine multiple diagrams into one diagram

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...diagrams: Diagram[]
      +

      list of diagrams to combine

      +
      +
    +

    Returns Diagram

    a diagram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/draw_to_svg.html b/docs/functions/draw_to_svg.html new file mode 100644 index 0000000..e5e7ee1 --- /dev/null +++ b/docs/functions/draw_to_svg.html @@ -0,0 +1,78 @@ +draw_to_svg | diagramatics
+
+ +
+
+
+
+ +

Function draw_to_svg

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      svgelement: SVGSVGElement
      • +
    • +
      diagram: Diagram
      • +
    • +
      set_html_attribute: boolean = true
      • +
    • +
      render_text: boolean = true
    +

    Returns void

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/empty.html b/docs/functions/empty.html new file mode 100644 index 0000000..de35b99 --- /dev/null +++ b/docs/functions/empty.html @@ -0,0 +1,79 @@ +empty | diagramatics
+
+ +
+
+
+
+ +

Function empty

+
+
    + +
  • +

    Create an empty diagram, contain just a single point

    +
    +
    +

    Parameters

    +
      +
    • +
      v: Vector2
      +

      position of the point

      +
      +
    +

    Returns Diagram

    an empty diagram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/from_degree.html b/docs/functions/from_degree.html new file mode 100644 index 0000000..6f33126 --- /dev/null +++ b/docs/functions/from_degree.html @@ -0,0 +1,75 @@ +from_degree | diagramatics
+
+ +
+
+
+
+ +

Function from_degree

+
+
    + +
  • +

    Helper function to convert from degrees to radians

    +
    +
    +

    Parameters

    +
      +
    • +
      angle: number
    +

    Returns number

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/inclined_plane.html b/docs/functions/inclined_plane.html new file mode 100644 index 0000000..4d2cac8 --- /dev/null +++ b/docs/functions/inclined_plane.html @@ -0,0 +1,74 @@ +inclined_plane | diagramatics
+
+ +
+
+
+
+ +

Function inclined_plane

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/line.html b/docs/functions/line.html new file mode 100644 index 0000000..f2a3580 --- /dev/null +++ b/docs/functions/line.html @@ -0,0 +1,84 @@ +line | diagramatics
+
+ +
+
+
+
+ +

Function line

+
+
    + +
  • +

    Create a line from start to end

    +
    +
    +

    Parameters

    +
    +

    Returns Diagram

    a line diagram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/linspace.html b/docs/functions/linspace.html new file mode 100644 index 0000000..7034028 --- /dev/null +++ b/docs/functions/linspace.html @@ -0,0 +1,88 @@ +linspace | diagramatics
+
+ +
+
+
+
+ +

Function linspace

+
+
    + +
  • +

    Create a equivalently spaced array of numbers from start to end

    +
    +
    +

    Parameters

    +
      +
    • +
      start: number
      +

      start value

      +
      +
      • +
    • +
      end: number
      +

      end value

      +
      +
      • +
    • +
      n: number = 100
      +

      number of points

      +
      +
    +

    Returns number[]

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/plot.html b/docs/functions/plot.html new file mode 100644 index 0000000..454ffc7 --- /dev/null +++ b/docs/functions/plot.html @@ -0,0 +1,93 @@ +plot | diagramatics
+
+ +
+
+
+
+ +

Function plot

+
+
    + +
  • +

    Plot a curve given xdata and ydata

    +
    +
    +

    Parameters

    +
      +
    • +
      xdata: number[]
      +

      x coordinates of the data

      +
      +
      • +
    • +
      ydata: number[]
      +

      y coordinates of the data

      +
      +
      • +
    • +
      Optional axes_options: axes_options
      +

      options for the axes +example: opt = { + bbox : [V2(-100,-100), V2(100,100)], + xrange : [-2, 2], + yrange : [-2, 2], +}

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/plotf.html b/docs/functions/plotf.html new file mode 100644 index 0000000..7bf6aab --- /dev/null +++ b/docs/functions/plotf.html @@ -0,0 +1,94 @@ +plotf | diagramatics
+
+ +
+
+
+
+ +

Function plotf

+
+
    + +
  • +

    Plot a function

    +
    +
    +

    Parameters

    +
      +
    • +
      f: ((x) => number)
      +

      function to plot

      +
      +
      +
        +
      • +
          +
        • (x): number
          • +
        • +
          +

          Parameters

          +
            +
          • +
            x: number
          +

          Returns number

      • +
    • +
      Optional axes_options: axes_options
      +

      options for the axes

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/plotv.html b/docs/functions/plotv.html new file mode 100644 index 0000000..02938ad --- /dev/null +++ b/docs/functions/plotv.html @@ -0,0 +1,88 @@ +plotv | diagramatics
+
+ +
+
+
+
+ +

Function plotv

+
+
    + +
  • +

    Plot a curve given a list of points

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Vector2[]
      +

      list of points

      +
      +
      • +
    • +
      Optional axes_options: axes_options
      +

      options for the axes +example: opt = { + bbox : [V2(-100,-100), V2(100,100)], + xrange : [-2, 2], + yrange : [-2, 2], +}

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/polygon.html b/docs/functions/polygon.html new file mode 100644 index 0000000..0120f7a --- /dev/null +++ b/docs/functions/polygon.html @@ -0,0 +1,79 @@ +polygon | diagramatics
+
+ +
+
+
+
+ +

Function polygon

+
+
    + +
  • +

    Create a polygon from a list of points

    +
    +
    +

    Parameters

    +
      +
    • +
      points: Vector2[]
      +

      list of points

      +
      +
    +

    Returns Diagram

    a polygon diagram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/rectangle.html b/docs/functions/rectangle.html new file mode 100644 index 0000000..24d4e61 --- /dev/null +++ b/docs/functions/rectangle.html @@ -0,0 +1,84 @@ +rectangle | diagramatics
+
+ +
+
+
+
+ +

Function rectangle

+
+
    + +
  • +

    Create rectange centered at origin

    +
    +
    +

    Parameters

    +
      +
    • +
      width: number
      +

      width of the rectangle

      +
      +
      • +
    • +
      height: number
      +

      height of the rectangle

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/regular_polygon.html b/docs/functions/regular_polygon.html new file mode 100644 index 0000000..79eaa31 --- /dev/null +++ b/docs/functions/regular_polygon.html @@ -0,0 +1,84 @@ +regular_polygon | diagramatics
+
+ +
+
+
+
+ +

Function regular_polygon

+
+
    + +
  • +

    Create regular polygon centered at origin

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
      +

      number of sides

      +
      +
      • +
    • +
      radius: number = 1
      +

      radius of the polygon

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/square.html b/docs/functions/square.html new file mode 100644 index 0000000..fc3381d --- /dev/null +++ b/docs/functions/square.html @@ -0,0 +1,79 @@ +square | diagramatics
+
+ +
+
+
+
+ +

Function square

+
+
    + +
  • +

    Create square centered at origin

    +
    +
    +

    Parameters

    +
      +
    • +
      side: number = 1
      +

      side length of the square

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/str_latex_to_unicode.html b/docs/functions/str_latex_to_unicode.html new file mode 100644 index 0000000..d95c713 --- /dev/null +++ b/docs/functions/str_latex_to_unicode.html @@ -0,0 +1,72 @@ +str_latex_to_unicode | diagramatics
+
+ +
+
+
+
+ +

Function str_latex_to_unicode

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      str: string
    +

    Returns string

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/str_to_mathematical_italic.html b/docs/functions/str_to_mathematical_italic.html new file mode 100644 index 0000000..f92a4d6 --- /dev/null +++ b/docs/functions/str_to_mathematical_italic.html @@ -0,0 +1,72 @@ +str_to_mathematical_italic | diagramatics
+
+ +
+
+
+
+ +

Function str_to_mathematical_italic

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      str: string
    +

    Returns string

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/text.html b/docs/functions/text.html new file mode 100644 index 0000000..c6dd0f2 --- /dev/null +++ b/docs/functions/text.html @@ -0,0 +1,79 @@ +text | diagramatics
+
+ +
+
+
+
+ +

Function text

+
+
    +
  • text(str): Diagram
    • +
  • +

    Create a text diagram

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +

      text to display

      +
      +
    +

    Returns Diagram

    a text diagram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/textvar.html b/docs/functions/textvar.html new file mode 100644 index 0000000..995ee2c --- /dev/null +++ b/docs/functions/textvar.html @@ -0,0 +1,79 @@ +textvar | diagramatics
+
+ +
+
+
+
+ +

Function textvar

+
+
    + +
  • +

    Create a text object with mathematical italic font

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +

      text to be displayed

      +
      +
    +

    Returns Diagram

    a Diagram object

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/under_curvef.html b/docs/functions/under_curvef.html new file mode 100644 index 0000000..27aafc4 --- /dev/null +++ b/docs/functions/under_curvef.html @@ -0,0 +1,89 @@ +under_curvef | diagramatics
+
+ +
+
+
+
+ +

Function under_curvef

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      f: ((x) => number)
      +
        +
      • +
          +
        • (x): number
          • +
        • +
          +

          Parameters

          +
            +
          • +
            x: number
          +

          Returns number

      • +
    • +
      x_start: number
      • +
    • +
      x_end: number
      • +
    • +
      Optional axes_options: axes_options
    +

    Returns Diagram

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/xtickmark.html b/docs/functions/xtickmark.html new file mode 100644 index 0000000..2531820 --- /dev/null +++ b/docs/functions/xtickmark.html @@ -0,0 +1,76 @@ +xtickmark | diagramatics
+
+ +
+
+
+
+ +

Function xtickmark

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/xtickmark_empty.html b/docs/functions/xtickmark_empty.html new file mode 100644 index 0000000..be954d4 --- /dev/null +++ b/docs/functions/xtickmark_empty.html @@ -0,0 +1,83 @@ +xtickmark_empty | diagramatics
+
+ +
+
+
+
+ +

Function xtickmark_empty

+
+
    + +
  • +

    Create a single tick mark in the x axis

    +
    +
    +

    Parameters

    +
      +
    • +
      x: number
      +

      x coordinate of the tick mark

      +
      +
      • +
    • +
      height: number = 0.1
      +

      height of the tick mark

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/xticks.html b/docs/functions/xticks.html new file mode 100644 index 0000000..7efd7d2 --- /dev/null +++ b/docs/functions/xticks.html @@ -0,0 +1,72 @@ +xticks | diagramatics
+
+ +
+
+
+
+ +

Function xticks

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/xyaxes.html b/docs/functions/xyaxes.html new file mode 100644 index 0000000..da80fe1 --- /dev/null +++ b/docs/functions/xyaxes.html @@ -0,0 +1,78 @@ +xyaxes | diagramatics
+
+ +
+
+
+
+ +

Function xyaxes

+
+
    + +
  • +

    Draw xy axes with ticks

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional axes_options: axes_options
      +

      options for the axes

      +
      +
    +

    Returns Diagram

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/xygrid.html b/docs/functions/xygrid.html new file mode 100644 index 0000000..32fc583 --- /dev/null +++ b/docs/functions/xygrid.html @@ -0,0 +1,72 @@ +xygrid | diagramatics
+
+ +
+
+
+
+ +

Function xygrid

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/ytickmark.html b/docs/functions/ytickmark.html new file mode 100644 index 0000000..bbf06fd --- /dev/null +++ b/docs/functions/ytickmark.html @@ -0,0 +1,76 @@ +ytickmark | diagramatics
+
+ +
+
+
+
+ +

Function ytickmark

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/ytickmark_empty.html b/docs/functions/ytickmark_empty.html new file mode 100644 index 0000000..326fce1 --- /dev/null +++ b/docs/functions/ytickmark_empty.html @@ -0,0 +1,74 @@ +ytickmark_empty | diagramatics
+
+ +
+
+
+
+ +

Function ytickmark_empty

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/yticks.html b/docs/functions/yticks.html new file mode 100644 index 0000000..dc5911b --- /dev/null +++ b/docs/functions/yticks.html @@ -0,0 +1,72 @@ +yticks | diagramatics
+
+ +
+
+
+
+ +

Function yticks

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..610ec10 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,58 @@ +diagramatics
+
+ +
+
+
+
+

diagramatics

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..e6c06e7 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,115 @@ +diagramatics
+
+ +
+
+
+
+

diagramatics

+
+
+

Index

+
+

Classes

+
Diagram +Interactive +Vector2 +
+
+

Variables

+
default_diagram_style +default_text_diagram_style +default_textdata +
+
+

Functions

+
V2 +Vdir +annotation_angle +annotation_vector +annotation_vector_text +arc +arrow +arrow2 +ax +axes_empty +axes_transform +circle +curve +diagram_combine +draw_to_svg +empty +from_degree +inclined_plane +line +linspace +plot +plotf +plotv +polygon +rectangle +regular_polygon +square +str_latex_to_unicode +str_to_mathematical_italic +text +textvar +under_curvef +xtickmark +xtickmark_empty +xticks +xyaxes +xygrid +ytickmark +ytickmark_empty +yticks +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/default_diagram_style.html b/docs/variables/default_diagram_style.html new file mode 100644 index 0000000..6512e31 --- /dev/null +++ b/docs/variables/default_diagram_style.html @@ -0,0 +1,63 @@ +default_diagram_style | diagramatics
+
+ +
+
+
+
+ +

Variable default_diagram_styleConst

+
default_diagram_style: DiagramStyle = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/default_text_diagram_style.html b/docs/variables/default_text_diagram_style.html new file mode 100644 index 0000000..4247f90 --- /dev/null +++ b/docs/variables/default_text_diagram_style.html @@ -0,0 +1,63 @@ +default_text_diagram_style | diagramatics
+
+ +
+
+
+
+ +

Variable default_text_diagram_styleConst

+
default_text_diagram_style: DiagramStyle = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/default_textdata.html b/docs/variables/default_textdata.html new file mode 100644 index 0000000..b3e687c --- /dev/null +++ b/docs/variables/default_textdata.html @@ -0,0 +1,63 @@ +default_textdata | diagramatics
+
+ +
+
+
+
+ +

Variable default_textdataConst

+
default_textdata: TextData = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/package.json b/package.json index de68c84..b69a600 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "main": "dist/index.js", "scripts": { "build": "tsc", + "docs" : "typedoc src/index.ts", "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [