Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesLMilner committed Jan 22, 2023
1 parent 6af865c commit d0c9454
Show file tree
Hide file tree
Showing 27 changed files with 553 additions and 530 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

60 changes: 41 additions & 19 deletions docs/classes/TerraDraw.html

Large diffs are not rendered by default.

86 changes: 43 additions & 43 deletions docs/classes/TerraDrawCircleMode.html

Large diffs are not rendered by default.

88 changes: 44 additions & 44 deletions docs/classes/TerraDrawFreehandMode.html

Large diffs are not rendered by default.

54 changes: 27 additions & 27 deletions docs/classes/TerraDrawGoogleMapsAdapter.html

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions docs/classes/TerraDrawLeafletAdapter.html

Large diffs are not rendered by default.

92 changes: 46 additions & 46 deletions docs/classes/TerraDrawLineStringMode.html

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/classes/TerraDrawMapLibreGLAdapter.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">TerraDrawAdapter</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L12">adapters/maplibre-gl.adapter.ts:12</a></li></ul></aside>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L12">adapters/maplibre-gl.adapter.ts:12</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">
Expand Down Expand Up @@ -68,7 +68,7 @@ <h5>coordinate<wbr/>Precision<span class="tsd-signature-symbol">: </span><span c
<h5>map<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="TerraDrawMapLibreGLAdapter.html" class="tsd-signature-type" data-tsd-kind="Class">TerraDrawMapLibreGLAdapter</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L15">adapters/maplibre-gl.adapter.ts:15</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L15">adapters/maplibre-gl.adapter.ts:15</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="getMapContainer" class="tsd-anchor"></a>
Expand All @@ -84,24 +84,24 @@ <h4>Type declaration</h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.getMapContainer</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L37">adapters/maplibre-gl.adapter.ts:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L37">adapters/maplibre-gl.adapter.ts:37</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="mapboxglAdapter" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>mapboxgl<wbr/>Adapter</span><a href="#mapboxglAdapter" 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">mapboxgl<wbr/>Adapter<span class="tsd-signature-symbol">:</span> <a href="TerraDrawMapboxGLAdapter.html" class="tsd-signature-type" data-tsd-kind="Class">TerraDrawMapboxGLAdapter</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L13">adapters/maplibre-gl.adapter.ts:13</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L13">adapters/maplibre-gl.adapter.ts:13</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="project" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>project</span><a href="#project" 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">project<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span></div><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.project</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L35">adapters/maplibre-gl.adapter.ts:35</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L35">adapters/maplibre-gl.adapter.ts:35</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="setCursor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Cursor</span><a href="#setCursor" 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">set<wbr/>Cursor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SetCursor</span></div><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.setCursor</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L36">adapters/maplibre-gl.adapter.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L36">adapters/maplibre-gl.adapter.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="setDoubleClickToZoom" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Double<wbr/>Click<wbr/>To<wbr/>Zoom</span><a href="#setDoubleClickToZoom" 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">set<wbr/>Double<wbr/>Click<wbr/>To<wbr/>Zoom<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
Expand All @@ -120,13 +120,13 @@ <h5>enabled: <span class="tsd-signature-type">boolean</span></h5></li></ul></div
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.setDoubleClickToZoom</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L33">adapters/maplibre-gl.adapter.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L33">adapters/maplibre-gl.adapter.ts:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="unproject" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unproject</span><a href="#unproject" 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">unproject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Unproject</span></div><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.unproject</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L34">adapters/maplibre-gl.adapter.ts:34</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L34">adapters/maplibre-gl.adapter.ts:34</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="register" class="tsd-anchor"></a>
Expand All @@ -142,7 +142,7 @@ <h5>callbacks: <span class="tsd-signature-type">TerraDrawCallbacks</span></h5></
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.register</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L39">adapters/maplibre-gl.adapter.ts:39</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L39">adapters/maplibre-gl.adapter.ts:39</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="render" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>render</span><a href="#render" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand Down Expand Up @@ -172,7 +172,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TerraDraw
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.render</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L47">adapters/maplibre-gl.adapter.ts:47</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L47">adapters/maplibre-gl.adapter.ts:47</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unregister" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unregister</span><a href="#unregister" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -181,7 +181,7 @@ <h3 class="tsd-anchor-link"><span>unregister</span><a href="#unregister" aria-la
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Implementation of TerraDrawAdapter.unregister</p>
<ul>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/21a6aca/src/adapters/maplibre-gl.adapter.ts#L43">adapters/maplibre-gl.adapter.ts:43</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/JamesLMilner/terra-draw/blob/6af865c/src/adapters/maplibre-gl.adapter.ts#L43">adapters/maplibre-gl.adapter.ts:43</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit d0c9454

Please sign in to comment.