deploy: 74b5509

Author: warm-coolguy

docs/afm/core.html

@@ -679,6 +679,18 @@ <h5 id="mapconfiguration.vuetify" tabindex="-1">mapConfiguration.vuetify</h5>
   }
 }
 </code></pre>
+<p>Regarding icons, you may add <code>vuetifyOptions.icons.values</code> as <code>{&quot;name&quot;: x}</code>, where <code>x</code> are the path commands (commonly '<a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d">d</a>') of the SVG to draw. An icon 'pen' will then be available as <code>&quot;$vuetify.icons.pen&quot;</code> in <code>v-icon</code> (and all places in the configuration where icons can be set). Any required styling can be added via <code>.css</code>, appropriate classnames would be <code>.v-icon__svg</code> and its path child <code>.v-icon__svg path</code>.</p>
+<pre><code class="language-js">{
+  icons: {
+    values: {
+      // example path from icomoon free
+      &quot;arrow-drop-up&quot;: &quot;M298.667 341.333l213.333 213.333 213.333-213.333h-426.667z&quot;,
+    }
+  }
+}
+</code></pre>
+<p>This specific path would require resizing via CSS, e.g. <code>scale: 0.0234375;</code> on the path.</p>
+<p>If you need a compilation from <a href="https://icomoon.io/">icomoon's</a> svg export (or samey format) to such an object, see <code>scripts/precompileSvg.js</code> in the root folder.</p>
 <h2 id="store" tabindex="-1">Store</h2>
 <p>The core module features a vuex root store that all plugin vuex modules are plugged into. However, the root contents are only relevant to plugins. It is accessible with <code>map.$store</code>, and can be used as a starting point for plugin access.</p>
 <p>To ease use, the map instance also features a <code>subscribe</code> method that will register a watcher to any state field. Please mind that only documented paths should be used, and all others are subject to change without notice.</p>

docs/afm/plugin-attributions.html

@@ -38,6 +38,11 @@ <h3 id="attributions-1" tabindex="-1">attributions</h3>
 </thead>
 <tbody>
 <tr>
+<td>icons</td>
+<td>Record&lt;string, string&gt;?</td>
+<td>Optional icon override.</td>
+</tr>
+<tr>
 <td>initiallyOpen</td>
 <td>boolean?</td>
 <td>Whether the information box is open by default. Only usable when renderType is set to 'independent', otherwise the IconMenu handles this.</td>
@@ -94,6 +99,28 @@ <h3 id="attributions-1" tabindex="-1">attributions</h3>
   ],
 }
 </code></pre>
+<h4 id="attributions.icons" tabindex="-1">attributions.icons</h4>
+<table>
+<thead>
+<tr>
+<th>fieldName</th>
+<th>type</th>
+<th>description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>close</td>
+<td>string?</td>
+<td>Icon shown when pressing the button closes the attributions. Defaults to <code>'fa-chevron-right'</code>.</td>
+</tr>
+<tr>
+<td>open</td>
+<td>string?</td>
+<td>Icon shown when pressing the button opens the attributions. Defaults to <code>'fa-regular fa-copyright'</code>.</td>
+</tr>
+</tbody>
+</table>
 <h4 id="attributions.layerattribution" tabindex="-1">attributions.layerAttribution</h4>
 <table>
 <thead>

docs/afm/plugin-legend.html

@@ -26,6 +26,45 @@ <h1 id="legend" tabindex="-1">Legend</h1>
 <p>The Legend module offers legend images as supplied by OGC services via <code>GetLegendGraphic</code> and <code>GetLegendURL</code> calls.</p>
 <h2 id="configuration" tabindex="-1">Configuration</h2>
 <p>For details on the <code>displayComponent</code> attribute, refer to the <a href="https://dataport.github.io/polar/docs/afm/core.html#global-plugin-parameters">Global Plugin Parameters</a> section of <code>@polar/core</code>.</p>
+<h3 id="legend-1" tabindex="-1">legend</h3>
+<table>
+<thead>
+<tr>
+<th>fieldName</th>
+<th>type</th>
+<th>description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>icons</td>
+<td>Record&lt;string, string&gt;?</td>
+<td>Optional icon override.</td>
+</tr>
+</tbody>
+</table>
+<h4 id="legend.icons" tabindex="-1">legend.icons</h4>
+<table>
+<thead>
+<tr>
+<th>fieldName</th>
+<th>type</th>
+<th>description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>close</td>
+<td>string?</td>
+<td>Icon shown when pressing the button closes the legends. Defaults to <code>'fa-chevron-right'</code>.</td>
+</tr>
+<tr>
+<td>open</td>
+<td>string?</td>
+<td>Icon shown when pressing the button opens the legends. Defaults to <code>'fa-info'</code>.</td>
+</tr>
+</tbody>
+</table>
 
 
     <h2>Locales</h2>

docs/afm/plugin-zoom.html

@@ -26,6 +26,7 @@ <h1 id="zoom" tabindex="-1">Zoom</h1>
 <h2 id="scope" tabindex="-1">Scope</h2>
 <p>The Zoom plugin offers functionality regarding map zooming.</p>
 <h2 id="configuration" tabindex="-1">Configuration</h2>
+<h3 id="zoom-1" tabindex="-1">zoom</h3>
 <p>The Zoom plugin offers a plus/minus button, and will adjust itself to the map's zoom settings on initialization.<br />
 It can be configured as followed.</p>
 <table>
@@ -38,6 +39,11 @@ <h2 id="configuration" tabindex="-1">Configuration</h2>
 </thead>
 <tbody>
 <tr>
+<td>icons</td>
+<td>Record&lt;string, string&gt;?</td>
+<td>Optional icon override.</td>
+</tr>
+<tr>
 <td>renderType</td>
 <td>'iconMenu' | 'independent'?</td>
 <td>Whether the zoom related buttons are being rendered independently or as part of the IconMenu. Defaults to <code>'independent'</code>.</td>
@@ -62,6 +68,28 @@ <h2 id="configuration" tabindex="-1">Configuration</h2>
   showZoomSlider: true,
 }
 </code></pre>
+<h4 id="zoom.icons" tabindex="-1">zoom.icons</h4>
+<table>
+<thead>
+<tr>
+<th>fieldName</th>
+<th>type</th>
+<th>description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>zoomIn</td>
+<td>string?</td>
+<td>Icon shown on zoom-in (plus) button. Defaults to <code>'fa-plus'</code>.</td>
+</tr>
+<tr>
+<td>zoomOut</td>
+<td>string?</td>
+<td>Icon shown on zoom-out (minus) button. Defaults to <code>'fa-minus'</code>.</td>
+</tr>
+</tbody>
+</table>
 <h2 id="store" tabindex="-1">Store</h2>
 <h3 id="state" tabindex="-1">State</h3>
 <p>The map's zoom level can be listened to.</p>

docs/diplan/assets/BasicLoader.gif

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1, minimal-ui">
+  <title>🧊📚 POLAR Documentation</title>
+	<link rel="stylesheet" href="./github-markdown.css">
+  <style>
+    body {
+      box-sizing: border-box;
+      min-width: 200px;
+      max-width: 980px;
+      margin: 0 auto;
+      padding: 45px;
+    }
+    @media (prefers-color-scheme: dark) {
+      html {
+        background-color: #0d1117;
+      }
+    }
+  </style>
+</head>
+<body>
+  <article class="markdown-body">
+    <h1 id="polar-client-diplankarten" tabindex="-1">POLAR client DiPlanKarten</h1>
+<p>This client is a work-in-progress. This document will contain use cases and configuration examples when done.</p>
+
+<p>For our example client, <a href="./example/prod-example.html">see here</a>. It's also in WIP state.</p>
+<p>TODO</p>
+
+    <h2>Child documents</h2><nav><ul>
+      <li><a href="core.html" target="_blank">core.html</a></li><li><a href="plugin-address-search.html" target="_blank">plugin-address-search.html</a></li><li><a href="plugin-attributions.html" target="_blank">plugin-attributions.html</a></li><li><a href="plugin-draw.html" target="_blank">plugin-draw.html</a></li><li><a href="plugin-gfi.html" target="_blank">plugin-gfi.html</a></li><li><a href="plugin-icon-menu.html" target="_blank">plugin-icon-menu.html</a></li><li><a href="plugin-layer-chooser.html" target="_blank">plugin-layer-chooser.html</a></li><li><a href="plugin-loading-indicator.html" target="_blank">plugin-loading-indicator.html</a></li><li><a href="plugin-pins.html" target="_blank">plugin-pins.html</a></li><li><a href="plugin-scale.html" target="_blank">plugin-scale.html</a></li><li><a href="plugin-toast.html" target="_blank">plugin-toast.html</a></li><li><a href="plugin-zoom.html" target="_blank">plugin-zoom.html</a></li>
+      </ul></nav>
+    
+  </article>
+  <hr>
+  <a href="https://github.com/Dataport/polar/blob/main/LEGALNOTICE.md" style="font-family: sans-serif;">Legal Notice (Impressum)</a>
+</body>
+</html>