Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@williamngan
williamngan committed Aug 19, 2017
1 parent e2b562f commit c63aa6b
Show file tree
Hide file tree
Showing 47 changed files with 1,070 additions and 1,340 deletions.
3 changes: 2 additions & 1 deletion .npmignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ tslint.json
tsconfig.json
webpack.config.js
mocha.opts
index.html
index.html
CNAME
253 changes: 179 additions & 74 deletions docs/classes/_bound_.bound.html
View file

Large diffs are not rendered by default.

99 changes: 48 additions & 51 deletions docs/classes/_canvas_.canvasform.html
View file

Large diffs are not rendered by default.

155 changes: 76 additions & 79 deletions docs/classes/_canvas_.canvasspace.html
View file

Large diffs are not rendered by default.

256 changes: 128 additions & 128 deletions docs/classes/_color_.color.html
View file

Large diffs are not rendered by default.

56 changes: 50 additions & 6 deletions docs/classes/_create_.create.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ <h3>Methods</h3>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#distributerandom" class="tsd-kind-icon">distribute<wbr>Random</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#gridcells" class="tsd-kind-icon">grid<wbr>Cells</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#gridpts" class="tsd-kind-icon">grid<wbr>Pts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#radialpts" class="tsd-kind-icon">radial<wbr>Pts</a></li>
</ul>
</section>
</div>
Expand All @@ -111,7 +112,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> distribute<wbr>Random</h3
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Create.ts#L21">Create.ts:21</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Create.ts#L22">Create.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -154,7 +155,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> grid<wbr>Cells</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Create.ts#L61">Create.ts:61</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Create.ts#L63">Create.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -198,7 +199,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> grid<wbr>Pts</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Create.ts#L41">Create.ts:41</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Create.ts#L42">Create.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -238,6 +239,49 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signa
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="radialpts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> radial<wbr>Pts</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">radial<wbr>Pts<span class="tsd-signature-symbol">(</span>center<span class="tsd-signature-symbol">: </span><a href="../modules/_pt_.html#ptlike" class="tsd-signature-type">PtLike</a>, radius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pt_.group.html" class="tsd-signature-type">Group</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Create.ts#L85">Create.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a set of Pts around a circular path</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>center: <a href="../modules/_pt_.html#ptlike" class="tsd-signature-type">PtLike</a></h5>
<div class="tsd-comment tsd-typography">
<p>circle center</p>
</div>
</li>
<li>
<h5>radius: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>circle radius</p>
</div>
</li>
<li>
<h5>count: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>number of Pts to create</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signature-type">Group</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down Expand Up @@ -279,9 +323,6 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signa
<li class=" tsd-kind-external-module">
<a href="../modules/_util_.html">"<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__app_.html">"_<wbr>app"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__lib_.html">"_<wbr>lib"</a>
</li>
Expand Down Expand Up @@ -315,6 +356,9 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signa
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_create_.create.html#gridpts" class="tsd-kind-icon">grid<wbr>Pts</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_create_.create.html#radialpts" class="tsd-kind-icon">radial<wbr>Pts</a>
</li>
</ul>
</li>
</ul>
Expand Down
19 changes: 8 additions & 11 deletions docs/classes/_form_.font.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L180">Form.ts:180</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L180">Form.ts:180</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -200,7 +200,7 @@ <h3>face</h3>
<div class="tsd-signature tsd-kind-icon">face<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L178">Form.ts:178</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L178">Form.ts:178</a></li>
</ul>
</aside>
</section>
Expand All @@ -210,7 +210,7 @@ <h3>line<wbr>Height</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L177">Form.ts:177</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L177">Form.ts:177</a></li>
</ul>
</aside>
</section>
Expand All @@ -220,7 +220,7 @@ <h3>size</h3>
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L176">Form.ts:176</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L176">Form.ts:176</a></li>
</ul>
</aside>
</section>
Expand All @@ -230,7 +230,7 @@ <h3>style</h3>
<div class="tsd-signature tsd-kind-icon">style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L179">Form.ts:179</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L179">Form.ts:179</a></li>
</ul>
</aside>
</section>
Expand All @@ -240,7 +240,7 @@ <h3>weight</h3>
<div class="tsd-signature tsd-kind-icon">weight<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L180">Form.ts:180</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L180">Form.ts:180</a></li>
</ul>
</aside>
</section>
Expand All @@ -257,7 +257,7 @@ <h3>value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L202">Form.ts:202</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L202">Form.ts:202</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -282,7 +282,7 @@ <h3>to<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L208">Form.ts:208</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L208">Form.ts:208</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -335,9 +335,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<li class=" tsd-kind-external-module">
<a href="../modules/_util_.html">"<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__app_.html">"_<wbr>app"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__lib_.html">"_<wbr>lib"</a>
</li>
Expand Down
5 changes: 1 addition & 4 deletions docs/classes/_form_.form.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>space</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/c9354ca/src/Form.ts#L17">Form.ts:17</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/e2b562f/src/Form.ts#L17">Form.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -167,9 +167,6 @@ <h4 class="tsd-returns-title">Returns <a href="_space_.space.html" class="tsd-si
<li class=" tsd-kind-external-module">
<a href="../modules/_util_.html">"<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__app_.html">"_<wbr>app"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__lib_.html">"_<wbr>lib"</a>
</li>
Expand Down
Loading

0 comments on commit c63aa6b

Please sign in to comment.