Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@williamngan
williamngan committed Jul 28, 2017
1 parent 75aec96 commit ee4872e
Show file tree
Hide file tree
Showing 54 changed files with 3,936 additions and 3,540 deletions.
865 changes: 0 additions & 865 deletions docs/assets/css/main-original.css
View file

This file was deleted.

200 changes: 79 additions & 121 deletions docs/assets/css/main.css
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

459 changes: 294 additions & 165 deletions docs/classes/_bound_.bound.html
View file

Large diffs are not rendered by default.

642 changes: 455 additions & 187 deletions docs/classes/_canvasform_.canvasform.html → docs/classes/_canvas_.canvasform.html
View file

Large diffs are not rendered by default.

658 changes: 441 additions & 217 deletions docs/classes/_canvasspace_.canvasspace.html → docs/classes/_canvas_.canvasspace.html
View file

Large diffs are not rendered by default.

556 changes: 228 additions & 328 deletions docs/classes/_color_.color.html
View file

Large diffs are not rendered by default.

83 changes: 73 additions & 10 deletions docs/classes/_create_.create.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ <h2>Index</h2>
<h3>Methods</h3>
<ul class="tsd-index-list">
<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>
</ul>
</section>
</div>
Expand All @@ -96,13 +98,13 @@ <h2>Methods</h2>
<a name="distributerandom" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> distribute<wbr>Random</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">distribute<wbr>Random<span class="tsd-signature-symbol">(</span>bound<span class="tsd-signature-symbol">: </span><a href="_bound_.bound.html" class="tsd-signature-type">Bound</a>, count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, dimensions<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_.pt.html" class="tsd-signature-type">Pt</a><span class="tsd-signature-symbol">[]</span></li>
<li class="tsd-signature tsd-kind-icon">distribute<wbr>Random<span class="tsd-signature-symbol">(</span>bound<span class="tsd-signature-symbol">: </span><a href="_bound_.bound.html" class="tsd-signature-type">Bound</a>, count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, dimensions<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/ptx/blob/e02c686/src/Create.ts#L6">Create.ts:6</a></li>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/75aec96/src/Create.ts#L10">Create.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -117,7 +119,68 @@ <h5>count: <span class="tsd-signature-type">number</span></h5>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> dimensions: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pt_.pt.html" class="tsd-signature-type">Pt</a><span class="tsd-signature-symbol">[]</span></h4>
<h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signature-type">Group</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="gridcells" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> grid<wbr>Cells</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">grid<wbr>Cells<span class="tsd-signature-symbol">(</span>bound<span class="tsd-signature-symbol">: </span><a href="_bound_.bound.html" class="tsd-signature-type">Bound</a>, columns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rows<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><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/75aec96/src/Create.ts#L34">Create.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bound: <a href="_bound_.bound.html" class="tsd-signature-type">Bound</a></h5>
</li>
<li>
<h5>columns: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>rows: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signature-type">Group</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="gridpts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> grid<wbr>Pts</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">grid<wbr>Pts<span class="tsd-signature-symbol">(</span>bound<span class="tsd-signature-symbol">: </span><a href="_bound_.bound.html" class="tsd-signature-type">Bound</a>, columns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rows<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, orientation<span class="tsd-signature-symbol">?: </span><a href="../modules/_pt_.html#ptlike" class="tsd-signature-type">PtLike</a><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/ptx/blob/75aec96/src/Create.ts#L21">Create.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bound: <a href="_bound_.bound.html" class="tsd-signature-type">Bound</a></h5>
</li>
<li>
<h5>columns: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>rows: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> orientation: <a href="../modules/_pt_.html#ptlike" class="tsd-signature-type">PtLike</a><span class="tsd-signature-symbol"> =&nbsp;[0.5, 0.5]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signature-type">Group</a></h4>
</li>
</ul>
</section>
Expand All @@ -133,10 +196,7 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.pt.html" class="tsd-signatur
<a href="../modules/_bound_.html">"<wbr>Bound"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_canvasform_.html">"<wbr>Canvas<wbr>Form"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_canvasspace_.html">"<wbr>Canvas<wbr>Space"</a>
<a href="../modules/_canvas_.html">"<wbr>Canvas"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_color_.html">"<wbr>Color"</a>
Expand Down Expand Up @@ -168,9 +228,6 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.pt.html" class="tsd-signatur
<li class=" tsd-kind-external-module">
<a href="../modules/__app_.html">"_<wbr>app"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__augment_.html">"_<wbr>augment"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__lib_.html">"_<wbr>lib"</a>
</li>
Expand Down Expand Up @@ -198,6 +255,12 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.pt.html" class="tsd-signatur
<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>
</ul>
</li>
</ul>
Expand Down
66 changes: 47 additions & 19 deletions docs/classes/_form_.font.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,16 @@ <h3>Constructors</h3>
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_form_.font.html#face" class="tsd-kind-icon">face</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_form_.font.html#lineheight" class="tsd-kind-icon">line<wbr>Height</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_form_.font.html#size" class="tsd-kind-icon">size</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_form_.font.html#style" class="tsd-kind-icon">style</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_form_.font.html#weight" class="tsd-kind-icon">weight</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_form_.font.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_form_.font.html#value" class="tsd-kind-icon">value</a></li>
</ul>
</section>
</div>
Expand All @@ -110,26 +112,32 @@ <h2>Constructors</h2>
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Font<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, face<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, style<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_form_.font.html" class="tsd-signature-type">Font</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Font<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, face<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, weight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, style<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, lineHeight<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="_form_.font.html" class="tsd-signature-type">Font</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/ptx/blob/e02c686/src/Form.ts#L7">Form.ts:7</a></li>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/75aec96/src/Form.ts#L13">Form.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> size: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;11</span></h5>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> size: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;12</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> face: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;sans-serif&quot;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> weight: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> style: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> lineHeight: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;1.5</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_form_.font.html" class="tsd-signature-type">Font</a></h4>
</li>
Expand All @@ -144,7 +152,17 @@ <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/e02c686/src/Form.ts#L6">Form.ts:6</a></li>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/75aec96/src/Form.ts#L11">Form.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="lineheight" class="tsd-anchor"></a>
<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/75aec96/src/Form.ts#L10">Form.ts:10</a></li>
</ul>
</aside>
</section>
Expand All @@ -154,7 +172,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/e02c686/src/Form.ts#L5">Form.ts:5</a></li>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/75aec96/src/Form.ts#L9">Form.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -164,24 +182,34 @@ <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/e02c686/src/Form.ts#L7">Form.ts:7</a></li>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/75aec96/src/Form.ts#L12">Form.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="weight" class="tsd-anchor"></a>
<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/75aec96/src/Form.ts#L13">Form.ts:13</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<a name="value" class="tsd-anchor"></a>
<h3>value</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/e02c686/src/Form.ts#L15">Form.ts:15</a></li>
<li>Defined in <a href="https://github.com/williamngan/ptx/blob/75aec96/src/Form.ts#L25">Form.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -200,10 +228,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<a href="../modules/_bound_.html">"<wbr>Bound"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_canvasform_.html">"<wbr>Canvas<wbr>Form"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_canvasspace_.html">"<wbr>Canvas<wbr>Space"</a>
<a href="../modules/_canvas_.html">"<wbr>Canvas"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_color_.html">"<wbr>Color"</a>
Expand Down Expand Up @@ -235,9 +260,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<li class=" tsd-kind-external-module">
<a href="../modules/__app_.html">"_<wbr>app"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__augment_.html">"_<wbr>augment"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/__lib_.html">"_<wbr>lib"</a>
</li>
Expand Down Expand Up @@ -268,14 +290,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_form_.font.html#face" class="tsd-kind-icon">face</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_form_.font.html#lineheight" class="tsd-kind-icon">line<wbr>Height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_form_.font.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_form_.font.html#style" class="tsd-kind-icon">style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_form_.font.html#weight" class="tsd-kind-icon">weight</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_form_.font.html#data" class="tsd-kind-icon">data</a>
<a href="_form_.font.html#value" class="tsd-kind-icon">value</a>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit ee4872e

Please sign in to comment.