@opengeoweb/time-slider 20.0.0 → 20.0.1

package/dist/src/lib/components/TimeSlider/timeSliderUtils.d.ts

@@ -16,16 +16,6 @@ export declare enum Scale {
     Months3 = 8,
     Year = 9
 }
-export declare enum AnimationLength {
-    Minutes15 = 15,
-    Minutes30 = 30,
-    Hours1 = 60,
-    Hours2 = 120,
-    Hours3 = 180,
-    Hours6 = 360,
-    Hours12 = 720,
-    Hours24 = 1440
-}
 export type SpeedFactorType = 0.1 | 0.2 | 0.5 | 1 | 2 | 4 | 8 | 16;
 /**
  * In this Map collection all fundamental scales
@@ -49,24 +39,8 @@ export declare const scalingCoefficient: (end: number, start: number, width: num
 export declare const timestampToPixelEdges: (timestamp: number, start: number, end: number, width: number) => number;
 export declare const timestampToPixel: (timestamp: number, centerTime: number, widthPx: number, secondsPerPx: number) => number;
 export declare const pixelToTimestamp: (timePx: number, centerTime: number, widthPx: number, secondsPerPx: number) => number;
-/**
- * This function creates and returns an array where there is secondsPerPx
- * number of the data set added for a data scale (secondsPerPx)
- * to secondsPerPxToScale.
- * @param secondsPerPx
- * @returns an array containing secondsPerPx numbers.
- * The secondsPerPx number for a data scale is included
- * contrary to secondsPerPxToScale.
- */
-export declare const secondsPerPxValues: (secondsPerPx: number) => number[];
 export declare const secondsPerPxFromCanvasWidth: (canvasWidth: number, spanInSeconds: number) => number | undefined;
 export declare const getNewCenterOfFixedPointZoom: (fixedTimePoint: number, oldSecondsPerPx: number, newSecondsPerPx: number, oldCenterTime: number) => number;
-/**
- * Move the time slider such that a given time point (timePoint)
- * is at a given pixel width (timePointPx).
- * @returns a new center time for the resulting position
- */
-export declare const moveRelativeToTimePoint: (timePoint: number, timePointPx: number, secondsPerPx: number, canvasWidth: number) => number;
 /** This reusable custom hook tells whether given pointer event targets current canvas node.
  * Example:
  *
@@ -107,9 +81,17 @@ export declare const minutesToDescribedDuration: (minutes: number) => string;
  * @returns
  */
 export declare function getLargestTimeUnit(minutes: number): number;
+/** For a data scale an appropriate fundamental scale is chosen
+ * depending on secondsPerPx of data. When a time range of
+ * data is for example many months. the fundamental scale Scale.Year
+ * is chosen here and the legend of the time slider is drawn in the
+ * same as if originally a year scale would have been chose.
+ *
+ * If a  time range of data is a few weeks, Scale.Month is chosen. So, all
+ * the time range of data can be shown in the window.
+ */
 export declare const getFundamentalScale: (secondsPerPx: number) => Scale;
 export declare const getScaleFromSpan: (span: number) => Scale;
-export declare const calculateMouseTimeAndCheckBounds: (x: number, startAnimationPosition: number, endAnimationPosition: number, DRAG_AREA_WIDTH: number, pixelsBetweenViewportAndTimesliderOnLeft: number | undefined, centerTime: number, canvasWidth: number, secondsPerPx: number, tooltipPosition: React.RefObject<number | undefined>) => number | undefined;
 export declare const defaultAnimationDelayAtStart = 250;
 export declare const defaultDelay = 1000;
 export declare const defaultTimeStep = 60;
@@ -121,9 +103,3 @@ export declare const roundWithTimeStep: (unixTime: number, timeStep: number, typ
  * Returns speed delay for given speedFactor. For options, see defined above in "speedFactors"
  */
 export declare const getSpeedDelay: (speedFactor: SpeedFactorType) => number;
-export declare const timeSliderLegendDefaultProps: {
-    timeSliderWidth: number;
-    centerTime: number;
-    secondsPerPx: number;
-    selectedTime: number;
-};

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

@@ -11,6 +11,9 @@ export interface RelativeTimeOffset {
     value: number;
     unit: TimeUnit;
 }
+export declare const maxOffsetByUnit: Record<TimeUnit, number>;
+/** Shared by the menu and the slider handles, so neither can reach an offset the other rejects. */
+export declare const clampOffset: ({ value, unit, }: RelativeTimeOffset) => RelativeTimeOffset;
 export interface OffsetSelections {
     startOffset: RelativeTimeOffset;
     endOffset: RelativeTimeOffset;
@@ -81,6 +84,8 @@ export declare const isRecurringPeriodMode: (mode: AnimationLengthMode) => mode
 export declare const isValidAnchorTime: (anchorTime?: string) => boolean;
 /** The offsets of whichever mode is selected; the modes without offsets use the defaults. */
 export declare const activeOffsets: (setting: AnimationLengthSetting) => OffsetSelections;
+/** The unit the offsets are edited and dragged in. */
+export declare const activeEditUnit: (setting: AnimationLengthSetting) => TimeUnit;
 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;
@@ -89,12 +94,27 @@ export declare const withModeSelections: (setting: AnimationLengthSetting, now?:
  * 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;
 /**
  * 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;
+/** 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. */
+export declare const snapInstantToOffsetGrid: (anchor: Date, instant: Date, unit: TimeUnit) => Date;
+/**
+ * A range set on the slider belongs to whichever mode is selected, so only that mode's
+ * 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;
 /** 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;

package/dist/src/lib/components/TimeSliderButtons/index.d.ts

@@ -1,4 +1,3 @@
-export * from './AnimationLengthButton/AnimationLengthButton';
 export * from './AnimationLengthPanel';
 export * from './AutoUpdateButton/AutoUpdateButton';
 export * from './BackwardForwardStepButton/BackwardForwardStepButton';

package/dist/src/lib/components/TimeSliderLegend/TimeSliderLegend.d.ts

@@ -26,6 +26,9 @@ export interface TimeSliderLegendProps {
     setIsDraggingEndAnimation?: (isDraggingEndAnimation: boolean) => void;
     onStartTimeChange?: (startTime: number) => void;
     onEndTimeChange?: (endTime: number) => void;
+    /** Positions the handles may occupy; defaults to the time step grid. */
+    snapAnimationTime?: (timeUnix: number) => number;
+    isAnimationRangeDraggable?: boolean;
     onSetTimeSliderSpan?: (newSpan: number, newCenterTime: number) => void;
     adjustSelectedTimeOnWheel?: ({ event, deltaY, }: {
         event: WheelEvent | KeyboardEvent;

package/dist/src/lib/components/TimeSliderLegend/timeSliderLegendUtils.d.ts

@@ -25,8 +25,10 @@ export declare const timeValues: number[];
 export declare const TIME_SLIDER_LEGEND_HEIGHT = 24;
 export declare const DRAG_AREA_WIDTH = 24;
 export type ShowTooltip = 'animationStart' | 'animationEnd' | 'mousePointer' | undefined;
-export declare const isDraggingStartWithinBounds: (endPos: number, mousePosition: number) => boolean;
-export declare const isDraggingEndWithinBounds: (startPos: number, mousePosition: number, canvasWidth: number) => boolean;
+export declare const isDraggingStartWithinBounds: (endPos: number, mousePosition: number, startPos: number) => boolean;
+export declare const isDraggingEndWithinBounds: (startPos: number, mousePosition: number, canvasWidth: number, endPos: number) => boolean;
+/** The animation holds one frame per time step, so a wide enough range would outgrow the limit. */
+export declare const exceedsAnimationStepLimit: (startTimeUnix: number, endTimeUnix: number, timeStepInMinutes?: number) => boolean;
 export declare const getTimeSliderLegendId: (mapId: string) => string;
 export declare const getTimeSliderLegendElement: (mapId: string) => Element | null;
 export declare const getPixelsBetweenViewportAndTimesliderOnLeft: (mapId: string) => number | undefined;

package/package.json

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

package/dist/src/lib/components/TimeSliderButtons/AnimationLengthButton/AnimationLengthButton.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import { AnimationLength } from '../../TimeSlider/timeSliderUtils';
-interface AnimationLengthButtonProps {
-    disabled?: boolean;
-    animationLength?: AnimationLength;
-    isAuto?: boolean;
-    layerHasTimeStep?: boolean;
-    onChangeAnimationLength?: (length: number) => void;
-    toggleAnimationLengthAuto?: () => void;
-}
-export declare const AnimationLengthButton: ({ disabled, animationLength, isAuto, layerHasTimeStep, onChangeAnimationLength, toggleAnimationLengthAuto, }: AnimationLengthButtonProps) => React.ReactElement;
-export {};