BGDIINF_SB-2978: Updates according to comments

Author: vladyslav-tk

src/modules/map/components/cesium/CesiumWMSLayer.vue

@@ -9,12 +9,11 @@ import { CoordinateSystem, WEBMERCATOR } from '@/utils/coordinateSystems'
 import { ImageryLayer, Rectangle, WebMapServiceImageryProvider } from 'cesium'
 import { TILEGRID_EXTENT_EPSG_4326 } from '@/config'
 import { mapState } from 'vuex'
-import { YEAR_TO_DESCRIBE_ALL_OR_CURRENT_DATA } from '@/api/layers/LayerTimeConfigEntry.class'
 import GeoAdminWMSLayer from '@/api/layers/GeoAdminWMSLayer.class'
 import addImageryLayerMixins from '@/modules/map/components/cesium/utils/addImageryLayer-mixins'
-import { getWMSTimestampFromConfig } from '@/utils/wmsLayerUtils'
 
-// todo should we adapt LOD to resolution?
+import { getTimestampFromConfig } from '@/utils/layerUtils'
+
 const MAXIMUM_LEVEL_OF_DETAILS = 18
 
 export default {
@@ -57,7 +56,7 @@ export default {
             return this.wmsLayerConfig.getURL()
         },
         timestamp() {
-            return getWMSTimestampFromConfig(this.wmsLayerConfig)
+            return getTimestampFromConfig(this.wmsLayerConfig, this.previewYear)
         },
         /**
          * Definition of all relevant URL param for our WMS backends. Passes as parameters to

src/modules/map/components/cesium/CesiumWMTSLayer.vue

@@ -10,9 +10,9 @@ import { CoordinateSystem, WEBMERCATOR } from '@/utils/coordinateSystems'
 import { ImageryLayer, Rectangle, UrlTemplateImageryProvider } from 'cesium'
 import { TILEGRID_EXTENT_EPSG_4326 } from '@/config'
 import addImageryLayerMixins from './utils/addImageryLayer-mixins'
-import { getTimestampForPreviewLayer } from '@/utils/wmtsLayerUtils'
 
-// todo should we adapt LOD to resolution?
+import { getTimestampFromConfig } from '@/utils/layerUtils'
+
 const MAXIMUM_LEVEL_OF_DETAILS = 18
 
 export default {
@@ -43,7 +43,7 @@ export default {
             return this.wmtsLayerConfig.opacity || 1.0
         },
         timestampForPreviewYear() {
-            return getTimestampForPreviewLayer(this.previewYear, this.wmtsLayerConfig)
+            return getTimestampFromConfig(this.wmtsLayerConfig, this.previewYear)
         },
         url() {
             return this.wmtsLayerConfig.getURL(

src/modules/map/components/cesium/utils/addImageryLayer-mixins.js

@@ -7,6 +7,11 @@
  * `getViewer`). The mixin will manage this layer and will remove it from the viewer as soon as the
  * component that has incorporated this mixin will be removed from the DOM.
  *
+ * `url` should be defined in the component and contains layer URL
+ *
+ * Component that will use this mixin should have `createImagery` method which takes layer URL as a
+ * parameter
+ *
  * It is also set/update zIndex of the layer, which places the layer accordingly in the stack of the
  * imagery layers in Cesium viewer.
  */

src/modules/map/components/openlayers/OpenLayersWMSLayer.vue

@@ -18,7 +18,8 @@ import TileGrid from 'ol/tilegrid/TileGrid'
 import proj4 from 'proj4'
 import { mapState } from 'vuex'
 import addLayerToMapMixin from './utils/addLayerToMap-mixins'
-import { getWMSTimestampFromConfig } from '@/utils/wmsLayerUtils'
+
+import { getTimestampFromConfig } from '@/utils/layerUtils'
 
 /** Renders a WMS layer on the map */
 export default {
@@ -64,7 +65,7 @@ export default {
             return this.wmsLayerConfig.getURL()
         },
         timestamp() {
-            return getWMSTimestampFromConfig(this.wmsLayerConfig)
+            return getTimestampFromConfig(this.wmsLayerConfig, this.previewYear)
         },
         /**
          * Definition of all relevant URL param for our WMS backends. This is because both

src/modules/map/components/openlayers/OpenLayersWMTSLayer.vue

@@ -14,7 +14,8 @@ import { XYZ as XYZSource } from 'ol/source'
 import TileGrid from 'ol/tilegrid/TileGrid'
 import proj4 from 'proj4'
 import addLayerToMapMixin from './utils/addLayerToMap-mixins'
-import { getTimestampForPreviewLayer } from '@/utils/wmtsLayerUtils'
+
+import { getTimestampFromConfig } from '@/utils/layerUtils'
 
 /** Renders a WMTS layer on the map */
 export default {
@@ -45,7 +46,7 @@ export default {
             return this.wmtsLayerConfig.opacity || 1.0
         },
         timestampForPreviewYear() {
-            return getTimestampForPreviewLayer(this.previewYear, this.wmtsLayerConfig)
+            return getTimestampFromConfig(this.wmtsLayerConfig, this.previewYear)
         },
         url() {
             return this.wmtsLayerConfig.getURL(

src/utils/layerUtils.js

@@ -1,3 +1,6 @@
+import { YEAR_TO_DESCRIBE_ALL_OR_CURRENT_DATA } from '@/api/layers/LayerTimeConfigEntry.class'
+import GeoAdminWMTSLayer from '@/api/layers/GeoAdminWMTSLayer.class'
+
 export class ActiveLayerConfig {
     /**
      * @param {String} id The layer id
@@ -13,3 +16,29 @@ export class ActiveLayerConfig {
         this.customAttributes = customAttributes
     }
 }
+
+/**
+ * Returns timestamp for WMS or WMTS layer from config data
+ *
+ * @param {GeoAdminWMSLayer | GeoAdminWMTSLayer} config
+ * @param {Number} previewYear
+ * @returns {String | string | LayerTimeConfig.currentTimeEntry.timestamp}
+ */
+export function getTimestampFromConfig(config, previewYear) {
+    const isWMTS = config instanceof GeoAdminWMTSLayer
+    if (config.timeConfig) {
+        // if there is a preview year set, we search for the matching timestamp
+        if (previewYear && config.timeConfig.years.includes(previewYear) && isWMTS) {
+            const matchingTimeEntry = config.timeConfig.getTimeEntryForYear(previewYear)
+            if (matchingTimeEntry || isWMTS) {
+                return matchingTimeEntry.timestamp
+            }
+        }
+        // if a time entry is defined, and is different from 'all'
+        // (no need to pass 'all' to our WMS, that's the default timestamp used under the hood)
+        if (config.timeConfig.currentYear !== YEAR_TO_DESCRIBE_ALL_OR_CURRENT_DATA && !isWMTS) {
+            return config.timeConfig.currentTimestamp
+        }
+    }
+    return isWMTS ? null : ''
+}