Initial beta release

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0-beta] - 2023-04-30
+
+Initial beta release.
+
 ## [0.8.0] - 2021-12-27
 
 ### Added

docs/api/functions/render.html

@@ -35,7 +35,7 @@ <h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/IRender
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Svg</span></h4><p>A valid SVG.js Svg object</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/index.ts#L151">index.ts:151</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/index.ts#L151">index.ts:151</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/renderStatic.html

@@ -36,7 +36,7 @@ <h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/IRender
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string containing a valid <code>&lt;svg&gt;</code> tag</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/index.ts#L90">index.ts:90</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/index.ts#L90">index.ts:90</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/renderglyph.html

@@ -39,7 +39,7 @@ <h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/IRender
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string containing a valid <code>&lt;svg&gt;</code> tag</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/index.ts#L108">index.ts:108</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/index.ts#L108">index.ts:108</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/interfaces/Glyph.html

@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">Glyph</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L500">schemas/schema.d.ts:500</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L500">schemas/schema.d.ts:500</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -48,14 +48,14 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <div class="tsd-comment tsd-typography"><p>A 3- or 6-digit hex colour value. Do not use this to assign player colours! This should only be used for tweaking composite pieces. Ignored if <code>player</code> is also defined.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L516">schemas/schema.d.ts:516</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L516">schemas/schema.d.ts:516</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>The name of the actual glyph. It may not contain any whitespace.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L504">schemas/schema.d.ts:504</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L504">schemas/schema.d.ts:504</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="nudge" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>nudge</span><a href="#nudge" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">nudge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">dx</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">dy</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -73,42 +73,42 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <div class="tsd-comment tsd-typography"><p>Negative values move the glyph up.</p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L532">schemas/schema.d.ts:532</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L532">schemas/schema.d.ts:532</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="opacity" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>opacity</span><a href="#opacity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">opacity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>A number between 0 and 1 indicating how opaque to render the glyph. A value of 0 means completely transparent.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L524">schemas/schema.d.ts:524</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L524">schemas/schema.d.ts:524</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="player" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>player</span><a href="#player" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">player</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>A positive integer pointing to a player position. Based on user settings, an appropriate background fill colour will be chosen.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L512">schemas/schema.d.ts:512</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L512">schemas/schema.d.ts:512</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="rotate" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>rotate</span><a href="#rotate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">rotate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>A number between -360 and 360 representing the degrees to rotate the glyph. Negative values rotate counterclockwise.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L528">schemas/schema.d.ts:528</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L528">schemas/schema.d.ts:528</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="scale" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>scale</span><a href="#scale" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">scale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>A number representing how you want the glyph proportionately scaled. Numbers &lt;1 will shrink the glyph. Numbers &gt;1 will enlarge it.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L520">schemas/schema.d.ts:520</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L520">schemas/schema.d.ts:520</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="text" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>text</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Mutually exclusive with <code>name</code>. In this case, the glyph is plain text, shrunk down to the appropriate size to fit in a cell. This is intended for very short strings, like numbers.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/0398aa7/src/schemas/schema.d.ts#L508">schemas/schema.d.ts:508</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/AbstractPlay/renderer/blob/cca14de/src/schemas/schema.d.ts#L508">schemas/schema.d.ts:508</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">