@opengeoweb/time-slider 20.0.1 → 20.1.0

package/dist/index.esm.js

@@ -986,20 +986,19 @@ var withModeSelections = function withModeSelections(setting, now) {
   }
   return setting;
 };
+/* A longer timestep floors to the hour, so a window keeps the frames its offsets ask for. */
+var MAX_ANCHOR_ROUNDING_IN_MINUTES = 60;
+var startOfTimeStep = function startOfTimeStep(instant, timeStep) {
+  return dateUtils.fromUnix(roundWithTimeStep(dateUtils.unix(instant), Math.min(timeStep, MAX_ANCHOR_ROUNDING_IN_MINUTES), 'floor'));
+};
 /**
  * A recurring period anchors on its time of day within the current UTC date, so the
  * window it resolves rolls onto the next day once the clock passes midnight.
  */
-var resolveAnchorInstant = function resolveAnchorInstant(setting, now) {
-  if (now === void 0) {
-    now = dateUtils.utc();
-  }
-  if (setting.mode !== AnimationLengthMode.RecurringPeriod) {
-    return now;
-  }
-  var _setting$recurringPer = setting.recurringPeriod.anchorTime.split(':').map(Number),
-    hours = _setting$recurringPer[0],
-    minutes = _setting$recurringPer[1];
+var recurringPeriodAnchor = function recurringPeriodAnchor(anchorTime, now) {
+  var _anchorTime$split$map = anchorTime.split(':').map(Number),
+    hours = _anchorTime$split$map[0],
+    minutes = _anchorTime$split$map[1];
   return dateUtils.set(now, {
     hours: hours,
     minutes: minutes,
@@ -1007,29 +1006,34 @@ var resolveAnchorInstant = function resolveAnchorInstant(setting, now) {
     milliseconds: 0
   });
 };
-/**
- * The instant a mode counts its offsets from. Only ReferenceTime takes one from
- * outside, so handing a layer's reference time to any other mode cannot move it.
- */
-var anchorInstantFor = function anchorInstantFor(setting, referenceTime, now) {
-  if (now === void 0) {
-    now = dateUtils.utc();
+/** The instant a mode counts its offsets from. */
+var anchorInstantFor = function anchorInstantFor(setting, _temp) {
+  var _ref4 = _temp === void 0 ? {} : _temp,
+    _ref4$now = _ref4.now,
+    now = _ref4$now === void 0 ? dateUtils.utc() : _ref4$now,
+    referenceTime = _ref4.referenceTime,
+    timeStep = _ref4.timeStep;
+  if (setting.mode === AnimationLengthMode.ReferenceTime && referenceTime) {
+    return dateUtils.utc(referenceTime);
+  }
+  if (setting.mode === AnimationLengthMode.RecurringPeriod) {
+    return recurringPeriodAnchor(setting.recurringPeriod.anchorTime, now);
   }
-  return setting.mode === AnimationLengthMode.ReferenceTime && referenceTime ? dateUtils.utc(referenceTime) : resolveAnchorInstant(setting, now);
+  return timeStep ? startOfTimeStep(now, timeStep) : now;
 };
 /**
  * Offsets are signed: negative lands before the anchor, positive after. They are
  * applied as calendar durations, so "+ 1 month" lands on the same day of the next
  * month rather than a fixed number of days later.
  */
-var resolveAnimationRange = function resolveAnimationRange(setting, now) {
-  if (now === void 0) {
-    now = dateUtils.utc();
+var resolveAnimationRange = function resolveAnimationRange(setting, anchorInputs) {
+  if (anchorInputs === void 0) {
+    anchorInputs = {};
   }
   var _activeOffsets = activeOffsets(setting),
     startOffset = _activeOffsets.startOffset,
     endOffset = _activeOffsets.endOffset;
-  var anchor = resolveAnchorInstant(setting, now);
+  var anchor = anchorInstantFor(setting, anchorInputs);
   return {
     animationStartTime: toAnimationTime(dateUtils.add(anchor, offsetToDuration(startOffset))),
     animationEndTime: toAnimationTime(dateUtils.add(anchor, offsetToDuration(endOffset)))
@@ -1065,9 +1069,9 @@ var offsetForInstant = function offsetForInstant(anchor, instant, unit) {
 var snapInstantToOffsetGrid = function snapInstantToOffsetGrid(anchor, instant, unit) {
   return dateUtils.add(anchor, offsetToDuration(clampOffset(offsetForInstant(anchor, instant, unit))));
 };
-var isWithinOffsetLimit = function isWithinOffsetLimit(_ref4) {
-  var value = _ref4.value,
-    unit = _ref4.unit;
+var isWithinOffsetLimit = function isWithinOffsetLimit(_ref5) {
+  var value = _ref5.value,
+    unit = _ref5.unit;
   return Math.abs(value) <= maxOffsetByUnit[unit];
 };
 /**
@@ -1075,10 +1079,10 @@ var isWithinOffsetLimit = function isWithinOffsetLimit(_ref4) {
  * out keeps the offset it holds: reading its instant back would subtract whatever time
  * passed since that instant was resolved.
  */
-var offsetsForRange = function offsetsForRange(setting, _ref5, now) {
-  var animationStartTime = _ref5.animationStartTime,
-    animationEndTime = _ref5.animationEndTime;
-  var anchor = resolveAnchorInstant(setting, now);
+var offsetsForRange = function offsetsForRange(setting, _ref6, anchorInputs) {
+  var animationStartTime = _ref6.animationStartTime,
+    animationEndTime = _ref6.animationEndTime;
+  var anchor = anchorInstantFor(setting, anchorInputs);
   var unit = activeEditUnit(setting);
   var heldOffsets = activeOffsets(setting);
   var offsetOf = function offsetOf(time) {
@@ -1097,9 +1101,9 @@ var offsetsForRange = function offsetsForRange(setting, _ref5, now) {
  * own selections change, and only on the edges the range names; the modes that read their
  * range from elsewhere keep it, and so does an edge the mode's offsets cannot reach.
  */
-var withDraggedRange = function withDraggedRange(setting, range, now) {
-  if (now === void 0) {
-    now = dateUtils.utc();
+var withDraggedRange = function withDraggedRange(setting, range, anchorInputs) {
+  if (anchorInputs === void 0) {
+    anchorInputs = {};
   }
   if (setting.mode === AnimationLengthMode.Exact) {
     var _range$animationStart, _range$animationEndTi;
@@ -1110,7 +1114,7 @@ var withDraggedRange = function withDraggedRange(setting, range, now) {
       }
     });
   }
-  var offsets = isAnchoredMode(setting.mode) ? offsetsForRange(setting, range, now) : undefined;
+  var offsets = isAnchoredMode(setting.mode) ? offsetsForRange(setting, range, anchorInputs) : undefined;
   if (!offsets) {
     return setting;
   }
@@ -1130,18 +1134,18 @@ var withDraggedRange = function withDraggedRange(setting, range, now) {
 };
 /** Offsets can use different units, so validity is decided on the resolved instants. */
 /** Exact names its range outright; every other mode resolves one from its offsets. */
-var settingRange = function settingRange(setting, now) {
-  if (now === void 0) {
-    now = dateUtils.utc();
+var settingRange = function settingRange(setting, anchorInputs) {
+  if (anchorInputs === void 0) {
+    anchorInputs = {};
   }
-  return setting.mode === AnimationLengthMode.Exact ? setting.exact : resolveAnimationRange(setting, now);
+  return setting.mode === AnimationLengthMode.Exact ? setting.exact : resolveAnimationRange(setting, anchorInputs);
 };
 /* Exact times are picked to the minute, so seconds must not decide validity. */
-var isValidAnimationLength = function isValidAnimationLength(setting, now) {
-  if (now === void 0) {
-    now = dateUtils.utc();
+var isValidAnimationLength = function isValidAnimationLength(setting, anchorInputs) {
+  if (anchorInputs === void 0) {
+    anchorInputs = {};
   }
-  var _settingRange = settingRange(setting, now),
+  var _settingRange = settingRange(setting, anchorInputs),
     animationStartTime = _settingRange.animationStartTime,
     animationEndTime = _settingRange.animationEndTime;
   return dateUtils.isBefore(dateUtils.utc(animationStartTime).setSeconds(0, 0), dateUtils.utc(animationEndTime).setSeconds(0, 0));
@@ -1152,14 +1156,14 @@ var MAX_ANIMATION_STEPS = 10000;
  * The cost of an animation is its span divided by the time step, so a wide range
  * is affordable with a coarse step and unaffordable with a fine one.
  */
-var isWithinAnimationStepLimit = function isWithinAnimationStepLimit(setting, timeStepInMinutes, now) {
-  if (now === void 0) {
-    now = dateUtils.utc();
+var isWithinAnimationStepLimit = function isWithinAnimationStepLimit(setting, timeStepInMinutes, anchorInputs) {
+  if (anchorInputs === void 0) {
+    anchorInputs = {};
   }
   if (!timeStepInMinutes) {
     return true;
   }
-  var _settingRange2 = settingRange(setting, now),
+  var _settingRange2 = settingRange(setting, anchorInputs),
     animationStartTime = _settingRange2.animationStartTime,
     animationEndTime = _settingRange2.animationEndTime;
   var spanInMinutes = dateUtils.differenceInMinutes(dateUtils.utc(animationEndTime), dateUtils.utc(animationStartTime));
@@ -1186,9 +1190,9 @@ var defaultExactSelections = function defaultExactSelections(now) {
   };
 };
 /** Starts Exact from whatever range is already on screen, falling back to the defaults. */
-var exactAnimationLengthFrom = function exactAnimationLengthFrom(_ref6, now) {
-  var animationStartTime = _ref6.animationStartTime,
-    animationEndTime = _ref6.animationEndTime;
+var exactAnimationLengthFrom = function exactAnimationLengthFrom(_ref7, now) {
+  var animationStartTime = _ref7.animationStartTime,
+    animationEndTime = _ref7.animationEndTime;
   if (now === void 0) {
     now = dateUtils.utc();
   }
@@ -1208,9 +1212,9 @@ var getOffsetFromTime = function getOffsetFromTime(time, anchorTime) {
     value: value
   };
 };
-var getAnimationLengthFromRange = function getAnimationLengthFromRange(mode, _ref7, now) {
-  var animationStartTime = _ref7.animationStartTime,
-    animationEndTime = _ref7.animationEndTime;
+var getAnimationLengthFromRange = function getAnimationLengthFromRange(mode, _ref8, now) {
+  var animationStartTime = _ref8.animationStartTime,
+    animationEndTime = _ref8.animationEndTime;
   if (now === void 0) {
     now = dateUtils.utc();
   }
@@ -2789,7 +2793,9 @@ var AnimationLengthMenu = function AnimationLengthMenu(_ref) {
     }, isStep);
   };
   var resolvesOwnRange = isAnchoredMode(setting.mode);
-  var hasInvertedRange = !isValidAnimationLength(setting, dateUtils.utc(referenceTimeFromLayer));
+  var hasInvertedRange = !isValidAnimationLength(setting, {
+    referenceTime: referenceTimeFromLayer
+  });
   var hasTooManySteps = resolvesOwnRange && !hasInvertedRange && !isWithinAnimationStepLimit(setting, timeStep);
   var hasRangeError = hasInvertedRange || hasTooManySteps;
   var rangeError = function () {
@@ -4679,4 +4685,4 @@ var DemoWrapper = function DemoWrapper(_ref2) {
   });
 };
 
-export { ANCHOR_MINUTE_STEP, AUTO_MOVE_AREA_PADDING, AnchorTimeField, AnimationLengthMenu, AnimationLengthMode, AnimationLengthPanel, AutoUpdateButton, _BackwardForwardStepButton as BackwardForwardStepButton, ControlButtons, DRAG_AREA_WIDTH, DemoWrapper, HideSliderButton, MAX_ANIMATION_STEPS, NowButton, OptionsMenu, OptionsMenuButton, PlayButton, Scale, SpeedButton, TIME_SLIDER_LEGEND_HEIGHT, TIME_SLIDER_NAMESPACE, TimeInMinutes, TimeSlider, TimeSliderButtons, TimeSliderCurrentTimeBox, TimeSliderLegend, TimeSliderMenu, TimeSpanButton, _TimeStepButton as TimeStepButton, activeEditUnit, activeOffsets, anchorInstantFor, anchorTimeToPickerDate, asDisplayTime, clampOffset, convertStringTimeToUnix, defaultAnimationDelayAtStart, defaultDelay, defaultEndOffset, defaultExactSelections, defaultOffsetSelections, defaultRecurringPeriodSelections, defaultSecondsPerPx, defaultStartOffset, defaultTimeSpan, defaultTimeStep, exactAnimationLengthFrom, exceedsAnimationStepLimit, getAnimationLengthFromRange, getAutoMoveAreaWidth, getFilteredTime, getFundamentalScale, getLargestTimeUnit, getNewCenterOfFixedPointZoom, getPixelsBetweenViewportAndTimesliderOnLeft, getPositions, getScaleFromSpan, getSpeedDelay, getTimeBoxWidth, getTimeSliderLegendElement, getTimeSliderLegendId, handleSetNowEvent, isAnchoredMode, isDraggingEndWithinBounds, isDraggingStartWithinBounds, isInsideAnimationArea, isLeftAnimationIconArea, isRecurringPeriodMode, isRightAnimationIconArea, isSelectedTimeIconArea, isValidAnchorTime, isValidAnimationLength, isWithinAnimationStepLimit, marks$1 as marks, maxOffsetByUnit, minutesToDescribedDuration, modeTranslationKey, moveSelectedTimePx, offsetForInstant, onsetNewDateDebounced, pickerDateToAnchorTime, pixelToTimestamp, resolveAnchorInstant, resolveAnimationRange, roundWithTimeStep, scaleToSecondsPerPx, scalingCoefficient, secondsPerPxFromCanvasWidth, secondsPerPxToScale, setNextTimeStep, setPreviousTimeStep, settingRange, shortUnitTranslationKey, snapInstantToOffsetGrid, spanToScale, speedFactors, timeBoxGeom, timeSliderUtils, timeUnits, timeValues, timesliderTranslations, timestampToPixel, timestampToPixelEdges, toAnchorTime, toExactAnimationTime, unitTranslationKey, useCanvasTarget, withDraggedRange, withModeSelections };
+export { ANCHOR_MINUTE_STEP, AUTO_MOVE_AREA_PADDING, AnchorTimeField, AnimationLengthMenu, AnimationLengthMode, AnimationLengthPanel, AutoUpdateButton, _BackwardForwardStepButton as BackwardForwardStepButton, ControlButtons, DRAG_AREA_WIDTH, DemoWrapper, HideSliderButton, MAX_ANIMATION_STEPS, NowButton, OptionsMenu, OptionsMenuButton, PlayButton, Scale, SpeedButton, TIME_SLIDER_LEGEND_HEIGHT, TIME_SLIDER_NAMESPACE, TimeInMinutes, TimeSlider, TimeSliderButtons, TimeSliderCurrentTimeBox, TimeSliderLegend, TimeSliderMenu, TimeSpanButton, _TimeStepButton as TimeStepButton, activeEditUnit, activeOffsets, anchorInstantFor, anchorTimeToPickerDate, asDisplayTime, clampOffset, convertStringTimeToUnix, defaultAnimationDelayAtStart, defaultDelay, defaultEndOffset, defaultExactSelections, defaultOffsetSelections, defaultRecurringPeriodSelections, defaultSecondsPerPx, defaultStartOffset, defaultTimeSpan, defaultTimeStep, exactAnimationLengthFrom, exceedsAnimationStepLimit, getAnimationLengthFromRange, getAutoMoveAreaWidth, getFilteredTime, getFundamentalScale, getLargestTimeUnit, getNewCenterOfFixedPointZoom, getPixelsBetweenViewportAndTimesliderOnLeft, getPositions, getScaleFromSpan, getSpeedDelay, getTimeBoxWidth, getTimeSliderLegendElement, getTimeSliderLegendId, handleSetNowEvent, isAnchoredMode, isDraggingEndWithinBounds, isDraggingStartWithinBounds, isInsideAnimationArea, isLeftAnimationIconArea, isRecurringPeriodMode, isRightAnimationIconArea, isSelectedTimeIconArea, isValidAnchorTime, isValidAnimationLength, isWithinAnimationStepLimit, marks$1 as marks, maxOffsetByUnit, minutesToDescribedDuration, modeTranslationKey, moveSelectedTimePx, offsetForInstant, onsetNewDateDebounced, pickerDateToAnchorTime, pixelToTimestamp, resolveAnimationRange, roundWithTimeStep, scaleToSecondsPerPx, scalingCoefficient, secondsPerPxFromCanvasWidth, secondsPerPxToScale, setNextTimeStep, setPreviousTimeStep, settingRange, shortUnitTranslationKey, snapInstantToOffsetGrid, spanToScale, speedFactors, timeBoxGeom, timeSliderUtils, timeUnits, timeValues, timesliderTranslations, timestampToPixel, timestampToPixelEdges, toAnchorTime, toExactAnimationTime, unitTranslationKey, useCanvasTarget, withDraggedRange, withModeSelections };

package/dist/src/lib/components/TimeSliderButtons/AnimationLengthPanel/animationLengthUtils.d.ts

@@ -89,22 +89,22 @@ export declare const activeEditUnit: (setting: AnimationLengthSetting) => TimeUn
 export declare const defaultRecurringPeriodSelections: (now?: Date) => RecurringPeriodSelections;
 /** Presets carry settings the compiler cannot vouch for, so the selected mode is given the slice it needs. */
 export declare const withModeSelections: (setting: AnimationLengthSetting, now?: Date) => AnimationLengthSetting;
-/**
- * A recurring period anchors on its time of day within the current UTC date, so the
- * window it resolves rolls onto the next day once the clock passes midnight.
- */
-export declare const resolveAnchorInstant: (setting: AnimationLengthSetting, now?: Date) => Date;
-/**
- * The instant a mode counts its offsets from. Only ReferenceTime takes one from
- * outside, so handing a layer's reference time to any other mode cannot move it.
- */
-export declare const anchorInstantFor: (setting: AnimationLengthSetting, referenceTime?: string, now?: Date) => Date;
+/** What the anchored modes count their offsets from; each mode reads only its own input. */
+export interface AnimationAnchorInputs {
+    now?: Date;
+    /** The leading layer's reference time, which only ReferenceTime counts from. */
+    referenceTime?: string;
+    /** In minutes; the clock is floored onto it, as the animation frames are. */
+    timeStep?: number;
+}
+/** The instant a mode counts its offsets from. */
+export declare const anchorInstantFor: (setting: AnimationLengthSetting, { now, referenceTime, timeStep, }?: AnimationAnchorInputs) => Date;
 /**
  * Offsets are signed: negative lands before the anchor, positive after. They are
  * applied as calendar durations, so "+ 1 month" lands on the same day of the next
  * month rather than a fixed number of days later.
  */
-export declare const resolveAnimationRange: (setting: AnimationLengthSetting, now?: Date) => AnimationRange;
+export declare const resolveAnimationRange: (setting: AnimationLengthSetting, anchorInputs?: AnimationAnchorInputs) => AnimationRange;
 /** The whole-unit offset landing nearest the instant, so a handle reaches only what the menu can express. */
 export declare const offsetForInstant: (anchor: Date, instant: Date, unit: TimeUnit) => RelativeTimeOffset;
 /** Snaps a dragged handle onto the grid the mode's offsets can describe. */
@@ -114,18 +114,18 @@ export declare const snapInstantToOffsetGrid: (anchor: Date, instant: Date, unit
  * own selections change, and only on the edges the range names; the modes that read their
  * range from elsewhere keep it, and so does an edge the mode's offsets cannot reach.
  */
-export declare const withDraggedRange: (setting: AnimationLengthSetting, range: Partial<AnimationRange>, now?: Date) => AnimationLengthSetting;
+export declare const withDraggedRange: (setting: AnimationLengthSetting, range: Partial<AnimationRange>, anchorInputs?: AnimationAnchorInputs) => AnimationLengthSetting;
 /** Offsets can use different units, so validity is decided on the resolved instants. */
 /** Exact names its range outright; every other mode resolves one from its offsets. */
-export declare const settingRange: (setting: AnimationLengthSetting, now?: Date) => AnimationRange;
-export declare const isValidAnimationLength: (setting: AnimationLengthSetting, now?: Date) => boolean;
+export declare const settingRange: (setting: AnimationLengthSetting, anchorInputs?: AnimationAnchorInputs) => AnimationRange;
+export declare const isValidAnimationLength: (setting: AnimationLengthSetting, anchorInputs?: AnimationAnchorInputs) => boolean;
 /** Frames the animation may hold; the range is expanded one entry per time step. */
 export declare const MAX_ANIMATION_STEPS = 10000;
 /**
  * The cost of an animation is its span divided by the time step, so a wide range
  * is affordable with a coarse step and unaffordable with a fine one.
  */
-export declare const isWithinAnimationStepLimit: (setting: AnimationLengthSetting, timeStepInMinutes: number | undefined, now?: Date) => boolean;
+export declare const isWithinAnimationStepLimit: (setting: AnimationLengthSetting, timeStepInMinutes: number | undefined, anchorInputs?: AnimationAnchorInputs) => boolean;
 export declare const toExactAnimationTime: (date: Date) => string;
 /** A day either side of now, so an exact window opens on something usable. */
 export declare const defaultExactSelections: (now?: Date) => ExactSelections;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@opengeoweb/time-slider",
-    "version": "20.0.1",
+    "version": "20.1.0",
     "description": "GeoWeb time-slider library for the opengeoweb project",
     "license": "Apache-2.0",
     "repository": {
@@ -20,9 +20,9 @@
         }
     },
     "dependencies": {
-        "@opengeoweb/shared": "20.0.1",
+        "@opengeoweb/shared": "20.1.0",
         "lodash": "^4.18.1",
-        "@opengeoweb/theme": "20.0.1",
+        "@opengeoweb/theme": "20.1.0",
         "@mui/x-date-pickers": "^9.3.0",
         "@mui/system": "^9.0.1",
         "i18next": "^25.0.1",