@opengeoweb/store 9.20.2 → 9.22.0

package/index.esm.js

@@ -1,4 +1,4 @@
-import { webmapUtils, LayerType, getWMJSMapById, WMLayer, webmapTestSettings, handleDateUtilsISOString, getCapabilities } from '@opengeoweb/webmap';
+import { webmapUtils, LayerType, getWMJSMapById, WMLayer, webmapTestSettings, getWMSRequests, isProjectionSupported, handleDateUtilsISOString, getCapabilities } from '@opengeoweb/webmap';
 import { createAction, createSlice, createSelector, createEntityAdapter, createListenerMiddleware } from '@reduxjs/toolkit';
 import { getGeoJson, moveFeature, createInterSections, getLastEmptyFeatureIndex, defaultLayers, emptyGeoJSON, addSelectionTypeToGeoJSON, getFeatureCollection, defaultIntersectionStyleProperties } from '@opengeoweb/webmap-react';
 export { defaultLayers } from '@opengeoweb/webmap-react';
@@ -3911,6 +3911,7 @@ const slice$5 = createSlice({
         return;
       }
       draft.byId[mapId].animationStartTime = animationStartTime;
+      draft.byId[mapId].isAnimationLengthAuto = false;
     },
     setAnimationEndTime: (draft, action) => {
       const {
@@ -3921,6 +3922,7 @@ const slice$5 = createSlice({
         return;
       }
       draft.byId[mapId].animationEndTime = animationEndTime;
+      draft.byId[mapId].isAnimationLengthAuto = false;
     },
     setAnimationDelay: (draft, action) => {
       const {
@@ -4057,6 +4059,16 @@ const slice$5 = createSlice({
       }
       draft.byId[mapId].isTimeSpanAuto = timeSpanAuto;
     },
+    toggleAnimationLengthAuto: (draft, action) => {
+      const {
+        mapId,
+        autoAnimationLength
+      } = action.payload;
+      if (!draft.byId[mapId]) {
+        return;
+      }
+      draft.byId[mapId].isAnimationLengthAuto = autoAnimationLength;
+    },
     toggleTimeSliderHover: (draft, action) => {
       const {
         mapId,
@@ -5825,6 +5837,13 @@ const getMapTimeSliderSecondsPerPx = createSelector(getMapById, store => store ?
  * @returns {boolean} returnType: boolean
  */
 const isTimestepAuto = createSelector(getMapById, store => store ? store.isTimestepAuto : false, selectorMemoizationOptions);
+/**
+ * Returns map is animation auto
+ * @param {object} store store: object - store object
+ * @param {string} mapId mapId: string - Id of the map
+ * @returns {boolean} returnType: boolean
+ */
+const isAnimationLengthAuto = createSelector(getMapById, store => (store === null || store === void 0 ? void 0 : store.isAnimationLengthAuto) || false, selectorMemoizationOptions);
 /**
  * Returns map is timespan auto
  *
@@ -6089,6 +6108,25 @@ const getAnimationList = createSelector(getMapById, getAnimationStartTime, getAn
   }
   return timeList;
 }, selectorMemoizationOptions);
+/**
+ * @param {object} store store: object - store object
+ * @param {string} mapId mapId: string - Id of the map
+ * @returns {object} Returns min and max value of time dimension of autoTimeStep-layer. If no autoTimeStep-layer it returns default start/end time from store.
+ */
+const getAnimationRange = createSelector(store => store, getAutoTimeStepLayerId, getAnimationStartTime, getAnimationEndTime, isAnimationLengthAuto, getLayerTimeDimension, (store, autoTimeStepLayerId, startTime, endTime, isAnimationLengthAuto) => {
+  const layerTimeDimension = getLayerTimeDimension(store, autoTimeStepLayerId);
+  const {
+    minValue,
+    maxValue
+  } = layerTimeDimension || {};
+  const hasTimeDimension = minValue && maxValue;
+  const animationStartTime = isAnimationLengthAuto && autoTimeStepLayerId && hasTimeDimension ? minValue : startTime;
+  const animationEndTime = isAnimationLengthAuto && autoTimeStepLayerId && hasTimeDimension ? maxValue : endTime;
+  return {
+    animationStartTime,
+    animationEndTime
+  };
+});
 
 var selectors$2 = /*#__PURE__*/Object.freeze({
 	__proto__: null,
@@ -6098,6 +6136,7 @@ var selectors$2 = /*#__PURE__*/Object.freeze({
 	getAllUniqueDimensions: getAllUniqueDimensions,
 	getAnimationEndTime: getAnimationEndTime,
 	getAnimationList: getAnimationList,
+	getAnimationRange: getAnimationRange,
 	getAnimationStartTime: getAnimationStartTime,
 	getAutoTimeStepLayerId: getAutoTimeStepLayerId,
 	getAutoUpdateLayerId: getAutoUpdateLayerId,
@@ -6140,6 +6179,7 @@ var selectors$2 = /*#__PURE__*/Object.freeze({
 	getSelectedTime: getSelectedTime,
 	getSrs: getSrs,
 	isAnimating: isAnimating,
+	isAnimationLengthAuto: isAnimationLengthAuto,
 	isAutoUpdating: isAutoUpdating,
 	isTimeSliderHoverOn: isTimeSliderHoverOn,
 	isTimeSliderVisible: isTimeSliderVisible,
@@ -7592,6 +7632,8 @@ fixRegExpWellKnownSymbolLogic('split', function (SPLIT, nativeSplit, maybeCallNa
 
 /* A map with all the timerIds and their current step */
 const stepMap = new Map();
+/* A map with a list of timers and their dwell */
+const timerDwellMap = new Map();
 /**
  * Returns the next step for given timerId.
  * @param timerId The timer id
@@ -7605,6 +7647,30 @@ const getNextStep = (timerId, numberOfStepsInAnimation, numStepsToGoForward = 1)
   const nextStepClipped = (nextStep % numberOfStepsInAnimation + numberOfStepsInAnimation) % numberOfStepsInAnimation;
   return nextStepClipped;
 };
+/**
+ * Handles dwell at the end of the animation loop sequence. The number of steps to wait till proceed can be set by the dwell parameter.
+ * @param timerId The timer id
+ * @param numberOfStepsInAnimation Number of steps in the animation
+ * @param dwell The number of steps to wait at the end of the animation sequence before to continue
+ * @returns
+ */
+const handleTimerDwell = (timerId, numberOfStepsInAnimation, dwell = 8) => {
+  if (dwell > 0) {
+    const currentStep = getCurrentStep(timerId);
+    // Reset the dwell if we are not at the last animation step
+    if (currentStep < numberOfStepsInAnimation - 1) {
+      timerDwellMap.set(timerId, dwell);
+      return false;
+    }
+    // We are at the last animation step, check the dwell
+    const timerDwell = timerDwellMap.has(timerId) && timerDwellMap.get(timerId) || 0;
+    if (currentStep === numberOfStepsInAnimation - 1 && timerDwell > 0) {
+      timerDwellMap.set(timerId, timerDwell - 1);
+      return true;
+    }
+  }
+  return false;
+};
 /**
  * Set step for the timerId
  * @param timerId
@@ -7640,7 +7706,7 @@ const prefetchAnimationTargetsForMetronome = (timerId, animationListValues, targ
       const targetMapId = target.targetId;
       const wmMap = getWMJSMapById(targetMapId);
       if (wmMap) {
-        const layersImageUrls = wmMap.getWMSRequests([{
+        const layersImageUrls = getWMSRequests(wmMap, [{
           name: 'time',
           currentValue: nextTimeValueStepToCheck
         }]);
@@ -7959,8 +8025,8 @@ function* setMapPresetSaga({
       }));
       yield call$e(handleBaseLayersSaga, mapId, allBaseLayers);
       if (proj) {
-        const isProjectionSupported = webmapUtils.getWMJSMapById(mapId).isProjectionSupported(proj.srs);
-        if (!isProjectionSupported) {
+        const checkIsprojectionSupported = isProjectionSupported(proj.srs);
+        if (!checkIsprojectionSupported) {
           throw new Error(`Projection ${proj.srs} is not supported`);
         }
         //  set bbox
@@ -8192,7 +8258,7 @@ function* setStepBackwardOrForwardSaga({
   }
 }
 function* rootSaga$4() {
-  // resets WMJSMap state
+  // resets IWMJSMap state
   yield takeLatest(mapActions.mapStopAnimation.type, stopAnimationSaga);
   yield takeLatest(mapActions.mapStartAnimation.type, startAnimationSaga);
   yield takeLatest(layerActions.layerDelete.type, deleteLayerSaga);
@@ -8256,7 +8322,8 @@ const metronomeHandler = (timerIds, listenerApi) => {
         value: ''
       });
     }
-    const timerShouldStepForward = prefetchAnimationTargetsForMetronome(timerId, animationListValues, targets);
+    const timerIsInDwell = handleTimerDwell(timerId, animationListValues.length);
+    const timerShouldStepForward = prefetchAnimationTargetsForMetronome(timerId, animationListValues, targets) && !timerIsInDwell;
     // Determine the next step
     const timerStep = timerShouldStepForward ? getNextStep(timerId, animationListValues.length) : getCurrentStep(timerId);
     setStep(timerId, timerStep);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/store",
-  "version": "9.20.2",
+  "version": "9.22.0",
   "description": "GeoWeb Store library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {

package/src/store/mapStore/index.d.ts

@@ -37,6 +37,7 @@ export declare const mapStoreActions: {
     setEndTimeOverriding: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").SetEndTimeOverriding, "mapReducer/setEndTimeOverriding">;
     toggleTimestepAuto: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").ToggleTimestepAutoPayload, "mapReducer/toggleTimestepAuto">;
     toggleTimeSpanAuto: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").ToggleTimeSpanAutoPayload, "mapReducer/toggleTimeSpanAuto">;
+    toggleAnimationLengthAuto: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").ToggleAnimationLengthAutoPayload, "mapReducer/toggleAnimationLengthAuto">;
     toggleTimeSliderHover: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").ToggleTimeSliderHoverPayload, "mapReducer/toggleTimeSliderHover">;
     toggleTimeSliderIsVisible: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").ToggleTimeSliderIsVisiblePayload, "mapReducer/toggleTimeSliderIsVisible">;
     toggleZoomControls: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").ToggleZoomControlsPayload, "mapReducer/toggleZoomControls">;

package/src/store/mapStore/map/mapListenerAnimationUtils.d.ts

@@ -7,6 +7,14 @@ import { SetTimeSyncPayload } from '../../generic/synchronizationActions/types';
  * @returns
  */
 export declare const getNextStep: (timerId: string, numberOfStepsInAnimation: number, numStepsToGoForward?: number) => number;
+/**
+ * Handles dwell at the end of the animation loop sequence. The number of steps to wait till proceed can be set by the dwell parameter.
+ * @param timerId The timer id
+ * @param numberOfStepsInAnimation Number of steps in the animation
+ * @param dwell The number of steps to wait at the end of the animation sequence before to continue
+ * @returns
+ */
+export declare const handleTimerDwell: (timerId: string, numberOfStepsInAnimation: number, dwell?: number) => boolean;
 /**
  * Set step for the timerId
  * @param timerId

package/src/store/mapStore/map/reducer.d.ts

@@ -1,6 +1,6 @@
 import { PayloadAction, Draft } from '@reduxjs/toolkit';
 import { MapPinLocationPayload, SetBboxPayload, SetStepBackWardOrForward, UpdateAllMapDimensionsPayload } from '@opengeoweb/webmap-react';
-import type { WebMapState, SetAutoLayerIdPayload, SetMapAnimationStartPayload, SetMapAnimationStopPayload, SetTimeSliderSpanPayload, SetTimeStepPayload, SetAnimationStartTimePayload, SetAnimationEndTimePayload, SetAnimationDelayPayload, MoveLayerPayload, SetTimeSliderWidthPayload, SetTimeSliderCenterTimePayload, SetEndTimeOverriding, ToggleAutoUpdatePayload, ToggleTimestepAutoPayload, ToggleTimeSpanAutoPayload, ToggleTimeSliderHoverPayload, DisableMapPinPayload, SetTimeSliderSecondsPerPxPayload, ToggleTimeSliderIsVisiblePayload, SetDockedLayerManagerSize } from './types';
+import type { WebMapState, SetAutoLayerIdPayload, SetMapAnimationStartPayload, SetMapAnimationStopPayload, SetTimeSliderSpanPayload, SetTimeStepPayload, SetAnimationStartTimePayload, SetAnimationEndTimePayload, SetAnimationDelayPayload, MoveLayerPayload, SetTimeSliderWidthPayload, SetTimeSliderCenterTimePayload, SetEndTimeOverriding, ToggleAutoUpdatePayload, ToggleTimestepAutoPayload, ToggleTimeSpanAutoPayload, ToggleTimeSliderHoverPayload, DisableMapPinPayload, SetTimeSliderSecondsPerPxPayload, ToggleTimeSliderIsVisiblePayload, SetDockedLayerManagerSize, ToggleAnimationLengthAutoPayload } from './types';
 import { ToggleMapPinIsVisiblePayload, ToggleZoomControlsPayload } from '../types';
 /**
  * Checks if the layer id is already taken in one of the maps.
@@ -44,6 +44,7 @@ export declare const slice: import("@reduxjs/toolkit").Slice<WebMapState, {
     setEndTimeOverriding: (draft: Draft<WebMapState>, action: PayloadAction<SetEndTimeOverriding>) => void;
     toggleTimestepAuto: (draft: Draft<WebMapState>, action: PayloadAction<ToggleTimestepAutoPayload>) => void;
     toggleTimeSpanAuto: (draft: Draft<WebMapState>, action: PayloadAction<ToggleTimeSpanAutoPayload>) => void;
+    toggleAnimationLengthAuto: (draft: Draft<WebMapState>, action: PayloadAction<ToggleAnimationLengthAutoPayload>) => void;
     toggleTimeSliderHover: (draft: Draft<WebMapState>, action: PayloadAction<ToggleTimeSliderHoverPayload>) => void;
     toggleTimeSliderIsVisible: (draft: Draft<WebMapState>, action: PayloadAction<ToggleTimeSliderIsVisiblePayload>) => void;
     toggleZoomControls: (draft: Draft<WebMapState>, action: PayloadAction<ToggleZoomControlsPayload>) => void;
@@ -92,6 +93,7 @@ export declare const mapActions: {
     setEndTimeOverriding: import("@reduxjs/toolkit").ActionCreatorWithPayload<SetEndTimeOverriding, "mapReducer/setEndTimeOverriding">;
     toggleTimestepAuto: import("@reduxjs/toolkit").ActionCreatorWithPayload<ToggleTimestepAutoPayload, "mapReducer/toggleTimestepAuto">;
     toggleTimeSpanAuto: import("@reduxjs/toolkit").ActionCreatorWithPayload<ToggleTimeSpanAutoPayload, "mapReducer/toggleTimeSpanAuto">;
+    toggleAnimationLengthAuto: import("@reduxjs/toolkit").ActionCreatorWithPayload<ToggleAnimationLengthAutoPayload, "mapReducer/toggleAnimationLengthAuto">;
     toggleTimeSliderHover: import("@reduxjs/toolkit").ActionCreatorWithPayload<ToggleTimeSliderHoverPayload, "mapReducer/toggleTimeSliderHover">;
     toggleTimeSliderIsVisible: import("@reduxjs/toolkit").ActionCreatorWithPayload<ToggleTimeSliderIsVisiblePayload, "mapReducer/toggleTimeSliderIsVisible">;
     toggleZoomControls: import("@reduxjs/toolkit").ActionCreatorWithPayload<ToggleZoomControlsPayload, "mapReducer/toggleZoomControls">;

package/src/store/mapStore/map/selectors.d.ts

@@ -455,6 +455,17 @@ export declare const isTimestepAuto: ((state: any, mapId: any) => boolean | unde
 }> & {
     clearCache: () => void;
 };
+/**
+ * Returns map is animation auto
+ * @param {object} store store: object - store object
+ * @param {string} mapId mapId: string - Id of the map
+ * @returns {boolean} returnType: boolean
+ */
+export declare const isAnimationLengthAuto: ((state: any, mapId: any) => boolean) & import("reselect").OutputSelectorFields<(args_0: WebMap | undefined) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
 /**
  * Returns map is timespan auto
  *
@@ -704,3 +715,19 @@ export declare const getAnimationList: ((state: any, mapId: any) => WebMapAnimat
 }> & {
     clearCache: () => void;
 };
+/**
+ * @param {object} store store: object - store object
+ * @param {string} mapId mapId: string - Id of the map
+ * @returns {object} Returns min and max value of time dimension of autoTimeStep-layer. If no autoTimeStep-layer it returns default start/end time from store.
+ */
+export declare const getAnimationRange: ((state: any, mapId: any) => {
+    animationStartTime: string | undefined;
+    animationEndTime: string | undefined;
+}) & import("reselect").OutputSelectorFields<(args_0: CoreAppStore, args_1: string | undefined, args_2: string | undefined, args_3: string | undefined, args_4: boolean, args_5: Dimension | undefined) => {
+    animationStartTime: string | undefined;
+    animationEndTime: string | undefined;
+}, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};

package/src/store/mapStore/map/types.d.ts

@@ -43,6 +43,7 @@ export interface WebMap {
     timeSliderSecondsPerPx?: number;
     isTimestepAuto?: boolean;
     isTimeSpanAuto?: boolean;
+    isAnimationLengthAuto?: boolean;
     isTimeSliderHoverOn?: boolean;
     isTimeSliderVisible?: boolean;
     shouldShowZoomControls?: boolean;
@@ -179,6 +180,11 @@ export interface ToggleTimeSpanAutoPayload {
     timeSpanAuto: boolean;
     origin?: MapActionOrigin;
 }
+export interface ToggleAnimationLengthAutoPayload {
+    mapId: string;
+    autoAnimationLength: boolean;
+    origin?: MapActionOrigin;
+}
 export interface ToggleTimeSliderHoverPayload {
     mapId: string;
     isTimeSliderHoverOn: boolean;