Default the MapOverlay visibility to true for clarity and make sure i…

…t's initially rendered. Added some comments.
wegue-oss · Dec 16, 2021 · 377a3b2 · 377a3b2
1 parent 3695691
commit 377a3b2
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/src/components/modulecore/MapOverlay.vue b/src/components/modulecore/MapOverlay.vue
@@ -17,7 +17,7 @@
     inheritAttrs: false,
     props: {
       overlayId: { type: String, required: true },
-      visible: { type: Boolean, required: false, default: false },
+      visible: { type: Boolean, required: false, default: true },
       offset: { type: Array, required: false, default: undefined },
       positioning: { type: String, required: false, default: 'top-left' },
       coordinates: { type: Array, required: false, default: undefined },
@@ -48,6 +48,18 @@
         });
     },
     methods: {
+      /**
+       * This function is executed, after the map is bound (see mixins/Mapable).
+       * Create the overlay if visible.
+       */
+      onMapBound () {
+        if (this.show) {
+          this.createOlOverlay();
+        }
+      },
+      /**
+       * Creates the OpenLayers overlay control and adds it to the map.
+       */
       createOlOverlay () {
         if (!this.olOverlay) {
           var overlayContainer = this.$refs.overlayContainer;
@@ -65,6 +77,9 @@
           this.map.addOverlay(this.olOverlay);
         }
       },
+      /**
+       * Destroys the OpenLayers overlay control and removes it from the map.
+       */
       destroyOlOverlay () {
         if (this.olOverlay) {
           this.map.removeOverlay(this.olOverlay);
@@ -73,13 +88,19 @@
       }
     },
     watch: {
+      /**
+       * Create / destroy the OpenLayers overlay control when the visibility toggles.
+       */
       show () {
         if (this.show) {
           this.createOlOverlay();
         } else {
           this.destroyOlOverlay();
         }
       },
+      /**
+       * Update the position of the OpenLayers overlay control.
+       */
       position () {
         if (this.olOverlay) {
           this.olOverlay.setPosition(this.position);

diff --git a/src/components/ol/HoverTooltip.vue b/src/components/ol/HoverTooltip.vue
@@ -5,6 +5,7 @@
 <template>
   <wgu-map-overlay
     overlayId="wgu-hover-tooltip"
+    :visible=false
     autoPan
     :autoPanDuration="250"
     positioning="top-center"