102 lines
10 KiB
HTML
102 lines
10 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>dyomedea</title><meta name="description" content="Documentation for dyomedea"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
<div class="tsd-toolbar-contents container">
|
|
<div class="table-cell" id="tsd-search" data-base=".">
|
|
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">dyomedea</a></div>
|
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-page-title">
|
|
<h2>dyomedea</h2></div>
|
|
<div class="tsd-panel tsd-typography">
|
|
<a href="#dyomedea" id="dyomedea" style="color: inherit; text-decoration: none;">
|
|
<h1>Dyomedea</h1>
|
|
</a>
|
|
|
|
<a href="#hiking-app" id="hiking-app" style="color: inherit; text-decoration: none;">
|
|
<h2>Hiking app.</h2>
|
|
</a>
|
|
|
|
<a href="#components" id="components" style="color: inherit; text-decoration: none;">
|
|
<h2>Components</h2>
|
|
</a>
|
|
<p>TBD</p>
|
|
|
|
<a href="#data-formats" id="data-formats" style="color: inherit; text-decoration: none;">
|
|
<h2>Data formats</h2>
|
|
</a>
|
|
<p>There is a number of data formats more or less specific to geography and hiking, such as:</p>
|
|
<ul>
|
|
<li><a href="https://www.topografix.com/GPX/1/1/">GPX 1.1 Schema Documentation</a></li>
|
|
<li><a href="https://geojson.org/">GeoJSON</a></li>
|
|
<li><a href="https://en.m.wikipedia.org/wiki/Keyhole_Markup_Language">Keyhole Markup Language - Wikipedia</a></li>
|
|
<li><a href="https://wiki.openstreetmap.org/wiki/Elements">Elements — OpenStreetMap Wiki</a></li>
|
|
<li><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg"><svg> - SVG: Scalable Vector Graphics | MDN</a></li>
|
|
</ul>
|
|
<p>SVG is very generic and is used to draw 2D figures in HTML applications and doesn't care about geography.</p>
|
|
<p>KML, GeoJSON and OSM elements have been designed to represent generic geographical points and shapes. </p>
|
|
<p>GPX is more specific, having been designed to represent routes and tracks and its semantices are directly useable in our application.</p>
|
|
<p>The strucure of our components and indexes can therefore follow the GPX format.</p>
|
|
<p>OSM elements is interesting to extract information from the OSM DB, either by querying their API or by downloading portions of the database.</p>
|
|
<p>GeoJSON might be of interest as an intermediate format since a number of JS libraries have been developped to perform queries or draw GeoJSON data as SVG.</p>
|
|
<p>KML might be considered as an import format.</p>
|
|
<p>And SVG, of course will be used to render tracks and routes on a map since its elements are directly supported by React.</p>
|
|
|
|
<a href="#notes-to-self" id="notes-to-self" style="color: inherit; text-decoration: none;">
|
|
<h2>Notes to self</h2>
|
|
</a>
|
|
|
|
<a href="#patching-node_modules" id="patching-node_modules" style="color: inherit; text-decoration: none;">
|
|
<h3>Patching node_modules</h3>
|
|
</a>
|
|
<p>This can be done by updating their sources in the node_modules directory and using the patch-package npm CLI command (thanks <a href="https://stackoverflow.com/a/13302095/1402881">stackoverflow</a>) :</p>
|
|
<pre><code><span class="hl-0">$npx</span><span class="hl-1"> </span><span class="hl-0">patch</span><span class="hl-1">-</span><span class="hl-2">package</span><span class="hl-1"> </span><span class="hl-0">localized</span><span class="hl-1">-</span><span class="hl-0">strings</span>
|
|
</code></pre>
|
|
<p>However, it takes ages before <code>ionic serve</code> takes these modifications into account.</p>
|
|
|
|
<a href="#visual-code-snippets" id="visual-code-snippets" style="color: inherit; text-decoration: none;">
|
|
<h3>Visual Code snippets</h3>
|
|
</a>
|
|
<ul>
|
|
<li><a href="https://dev.to/brianmmdev/create-your-own-vscode-snippets-33c7">Create Your Own VSCode Snippets - DEV Community 👩💻👨💻</a></li>
|
|
<li><a href="https://stackoverflow.com/questions/50571130/how-can-i-create-templates-for-file-extensions-in-visual-studio-code">vscode settings - How can I create templates for file extensions in Visual Studio Code? - Stack Overflow</a></li>
|
|
</ul>
|
|
</div></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">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<ul id="tsd-filter-options">
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<nav class="tsd-navigation primary">
|
|
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li class="current selected"><a href="modules.html">dyomedea</a>
|
|
<ul>
|
|
<li class="tsd-kind-module"><a href="modules/App.html">App</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/App_test.html">App.test</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/components_map_Map.html">components/map/<wbr/>Map</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/components_map_TiledLayer.html">components/map/<wbr/>Tiled<wbr/>Layer</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/components_map_types.html">components/map/types</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/index.html">index</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/pages_Home.html">pages/<wbr/>Home</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/react_app_env.html">react-<wbr/>app-<wbr/>env</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/reportWebVitals.html">report<wbr/>Web<wbr/>Vitals</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/service_worker.html">service-<wbr/>worker</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/serviceWorkerRegistration.html">service<wbr/>Worker<wbr/>Registration</a></li>
|
|
<li class="tsd-kind-module"><a href="modules/setupTests.html">setup<wbr/>Tests</a></li></ul></li></ul></div></details></nav></div></div>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
<div class="overlay"></div><script src="assets/main.js"></script></body></html> |