Docs built from a0d0a95

guides/advanced-usage.html

@@ -12,7 +12,7 @@
     <link rel="preload" href="/kano/assets/inter-roman-latin.bvIUbFQP.woff2" as="font" type="font/woff2" crossorigin="">
     <link rel="modulepreload" href="/kano/assets/chunks/framework.J61Sinzt.js">
     <link rel="modulepreload" href="/kano/assets/chunks/theme.YarLmGoi.js">
-    <link rel="modulepreload" href="/kano/assets/guides_advanced-usage.md.qONvRcqJ.lean.js">
+    <link rel="modulepreload" href="/kano/assets/guides_advanced-usage.md.nrrs05j8.lean.js">
     <link href="https://cdnjs.cloudflare.com/ajax/libs/line-awesome/1.3.0/line-awesome/css/line-awesome.min.css" rel="stylesheet">
     <link rel="icon" href="https://s3.eu-central-1.amazonaws.com/kalisioscope/kano/kano-icon-64x64.png">
     <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
@@ -80,7 +80,7 @@
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
 <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">    // Otherwise the event targets the map background</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  }</span></span>
-<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">})</span></span></code></pre></div><p>The following events are related to map state changes and do not provide additional properties like interaction events:</p><ul><li><code>movestart</code> whenever the view of the 2D map starts changing (e.g. user starts dragging the map),</li><li><code>moveend</code> whenever the center of the 2D map stops changing (e.g. user stopped dragging the map),</li><li><code>move</code> during any movement of the 2D map (including pan and fly animations),</li><li><code>zoomstart</code> whenever the 2D map zoom is about to change (e.g. before zoom animation),</li><li><code>zoomend</code> whenever the 2D map zoom changed (after any animations),</li><li><code>zoom</code> during any change in zoom level, including zoom and fly animations.</li></ul><h4 id="backend-events" tabindex="-1">Backend events <a class="header-anchor" href="#backend-events" aria-label="Permalink to &quot;Backend events&quot;">​</a></h4><p>Backend <a href="https://feathersjs.com/api/events.html" target="_blank" rel="noreferrer">service events</a> can be listened by integrating application, in this case the <code>serviceEvent</code> property, respectively the <code>data</code> property, contains the service event name, respectively service event data, in the post-robot event payload:</p><ul><li><code>catalog</code> whenever a service event is emitted on the <code>catalog</code> service</li><li><code>features</code> whenever a service event is emitted on the <code>features</code> service</li></ul><p>For instance, you can listen to changes in the catalog service like this:</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  postRobot.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">on</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;catalog&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">event</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=&gt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
+<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">})</span></span></code></pre></div><p>The following events are related to map state changes and do not provide additional properties like interaction events:</p><ul><li><code>movestart</code> whenever the view of the 2D map starts changing (e.g. user starts dragging the map),</li><li><code>moveend</code> whenever the center of the 2D map stops changing (e.g. user stopped dragging the map),</li><li><code>move</code> during any movement of the 2D map (including pan and fly animations),</li><li><code>zoomstart</code> whenever the 2D map zoom is about to change (e.g. before zoom animation),</li><li><code>zoomend</code> whenever the 2D map zoom changed (after any animations),</li><li><code>zoom</code> during any change in zoom level, including zoom and fly animations.</li></ul><h3 id="backend-events" tabindex="-1">Backend events <a class="header-anchor" href="#backend-events" aria-label="Permalink to &quot;Backend events&quot;">​</a></h3><p>Backend <a href="https://feathersjs.com/api/events.html" target="_blank" rel="noreferrer">service events</a> can be listened by integrating application, in this case the <code>serviceEvent</code> property, respectively the <code>data</code> property, contains the service event name, respectively service event data, in the post-robot event payload:</p><ul><li><code>catalog</code> whenever a service event is emitted on the <code>catalog</code> service</li><li><code>features</code> whenever a service event is emitted on the <code>features</code> service</li></ul><p>For instance, you can listen to changes in the catalog service like this:</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  postRobot.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">on</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;catalog&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">event</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=&gt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    const</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">serviceEvent</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">data</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> event.data</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">`Received ${</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">serviceEvent</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">} catalog event`</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  })</span></span></code></pre></div><p>Kano also provides you with an internal event bus service called <code>events</code> that can be used to dispatch custom events to all connected clients. This service internally has only a <code>create</code> method to send events, you can send a custom event named <code>item-selected</code> through this service like this:</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">  // Tell others clients selection changed</span></span>
@@ -178,7 +178,7 @@
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    ...</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  }</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></div></div></main><footer class="VPDocFooter" data-v-e6f2a212 data-v-b4b63abf><!--[--><!--]--><!----><nav class="prev-next" data-v-b4b63abf><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link prev" href="/kano/guides/customizing-kano.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Previous page</span><span class="title" data-v-b4b63abf>Customizing Kano</span><!--]--></a></div><div class="pager" data-v-b4b63abf><a class="VPLink link pager-link next" href="/kano/guides/kano-api.html" data-v-b4b63abf><!--[--><span class="desc" data-v-b4b63abf>Next page</span><span class="title" data-v-b4b63abf>Using the Kano API</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-9d8abc1e data-v-566314d4><div class="container" data-v-566314d4><!----><p class="copyright" data-v-566314d4>MIT Licensed | Copyright © 2017-20xx Kalisio</p></div></footer><!--[--><!--]--></div></div></div>
-    <script>window.__VP_HASH_MAP__=JSON.parse("{\"index.md\":\"Xmx78NTg\",\"history.md\":\"VskAxfcc\",\"about_roadmap.md\":\"Tsa-l91W\",\"guides_understanding-kano.md\":\"kgvoQdRq\",\"guides_kano-api.md\":\"WjHbeTHk\",\"about_contributing.md\":\"Q-A41HE2\",\"about_introduction.md\":\"ZchEHfVq\",\"about_license.md\":\"qdb0yiyt\",\"guides_customizing-kano.md\":\"rxbW7pJd\",\"about_contact.md\":\"MLWlmPcp\",\"guides_installing-kano.md\":\"ju5qSgOm\",\"guides_getting-started.md\":\"6pc9104C\",\"reference_configuration.md\":\"H2fn7Ne6\",\"guides_advanced-usage.md\":\"qONvRcqJ\",\"reference_api.md\":\"wWmT5Fzy\",\"guides_installing-services.md\":\"dsJfA9g8\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Kano\",\"description\":\"A powerful real-time Geovisualizer\",\"base\":\"/kano/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/kano/kano-icon-256x256.png\",\"domain\":\"dev.kalisio.xyz\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/kano\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Reference\",\"link\":\"/reference/configuration\"},{\"text\":\"History\",\"link\":\"/history\"}],\"sidebar\":{\"/about/\":[{\"text\":\"Introduction\",\"link\":\"/about/introduction\"},{\"text\":\"Roadmap\",\"link\":\"/about/roadmap\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Understanding Kano\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Getting Started\",\"link\":\"/guides/getting-started\"},{\"text\":\"Installing Kano\",\"link\":\"/guides/installing-kano\"},{\"text\":\"Customizing Kano\",\"link\":\"/guides/customizing-kano\"},{\"text\":\"Advanced usage\",\"link\":\"/guides/advanced-usage\"},{\"text\":\"Using the Kano API\",\"link\":\"/guides/kano-api\"},{\"text\":\"Installing Services\",\"link\":\"/guides/installing-services\"}],\"/reference/\":[{\"text\":\"Configuration\",\"link\":\"/reference/configuration\"},{\"text\":\"API\",\"link\":\"/reference/api\"}]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"},\"trustLogos\":[{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/airbus.png\",\"link\":\"https://www.airbus.com/\"},{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/irsn.png\",\"link\":\"https://www.irsn.fr/\"}],\"maps\":{\"jwt\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZXYua2FsaXNpby54eXoiLCJpc3MiOiJrYWxpc2lvIn0.CGvJwPPkuiFvNzo3zUBb-_vwD0CKbUfm7w7TkCY-Ts4\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"index.md\":\"Xmx78NTg\",\"about_contact.md\":\"MLWlmPcp\",\"reference_configuration.md\":\"H2fn7Ne6\",\"about_contributing.md\":\"Q-A41HE2\",\"reference_api.md\":\"wWmT5Fzy\",\"guides_understanding-kano.md\":\"kgvoQdRq\",\"guides_getting-started.md\":\"6pc9104C\",\"history.md\":\"VskAxfcc\",\"about_license.md\":\"qdb0yiyt\",\"guides_advanced-usage.md\":\"nrrs05j8\",\"guides_kano-api.md\":\"WjHbeTHk\",\"guides_installing-kano.md\":\"ju5qSgOm\",\"guides_installing-services.md\":\"dsJfA9g8\",\"about_roadmap.md\":\"Tsa-l91W\",\"about_introduction.md\":\"ZchEHfVq\",\"guides_customizing-kano.md\":\"rxbW7pJd\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Kano\",\"description\":\"A powerful real-time Geovisualizer\",\"base\":\"/kano/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/kano/kano-icon-256x256.png\",\"domain\":\"dev.kalisio.xyz\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/kalisio/kano\"}],\"nav\":[{\"text\":\"About\",\"link\":\"/about/introduction\"},{\"text\":\"Guides\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Reference\",\"link\":\"/reference/configuration\"},{\"text\":\"History\",\"link\":\"/history\"}],\"sidebar\":{\"/about/\":[{\"text\":\"Introduction\",\"link\":\"/about/introduction\"},{\"text\":\"Roadmap\",\"link\":\"/about/roadmap\"},{\"text\":\"Contributing\",\"link\":\"/about/contributing\"},{\"text\":\"License\",\"link\":\"/about/license\"},{\"text\":\"Contact\",\"link\":\"/about/contact\"}],\"/guides/\":[{\"text\":\"Understanding Kano\",\"link\":\"/guides/understanding-kano\"},{\"text\":\"Getting Started\",\"link\":\"/guides/getting-started\"},{\"text\":\"Installing Kano\",\"link\":\"/guides/installing-kano\"},{\"text\":\"Customizing Kano\",\"link\":\"/guides/customizing-kano\"},{\"text\":\"Advanced usage\",\"link\":\"/guides/advanced-usage\"},{\"text\":\"Using the Kano API\",\"link\":\"/guides/kano-api\"},{\"text\":\"Installing Services\",\"link\":\"/guides/installing-services\"}],\"/reference/\":[{\"text\":\"Configuration\",\"link\":\"/reference/configuration\"},{\"text\":\"API\",\"link\":\"/reference/api\"}]},\"footer\":{\"copyright\":\"MIT Licensed | Copyright © 2017-20xx Kalisio\"},\"trustLogos\":[{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/airbus.png\",\"link\":\"https://www.airbus.com/\"},{\"imageLink\":\"https://s3.eu-central-1.amazonaws.com/kalisioscope/assets/logos/irsn.png\",\"link\":\"https://www.irsn.fr/\"}],\"maps\":{\"jwt\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZXYua2FsaXNpby54eXoiLCJpc3MiOiJrYWxpc2lvIn0.CGvJwPPkuiFvNzo3zUBb-_vwD0CKbUfm7w7TkCY-Ts4\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
 
   </body>
 </html>