chartgpu 0.2.2 → 0.2.3

package/dist/core/renderCoordinator/zoom/zoomHelpers.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Zoom helper utilities for domain calculations and zoom state checks.
+ *
+ * Provides pure functions for computing visible domains from zoom ranges,
+ * checking full-span zoom states, and other zoom-related calculations.
+ *
+ * @module zoomHelpers
+ */
+import type { ZoomRange } from '../../../interaction/createZoomState';
+/**
+ * Domain boundaries with min and max values.
+ */
+export interface DomainBounds {
+    readonly min: number;
+    readonly max: number;
+}
+/**
+ * Visible domain with span fraction for performance optimization hints.
+ */
+export interface VisibleDomain extends DomainBounds {
+    /**
+     * Fraction of the base domain that is visible (0 to 1).
+     * Used to determine if full-resolution data can be used.
+     */
+    readonly spanFraction: number;
+}
+/**
+ * Computes the visible X domain from base domain and zoom range.
+ *
+ * Converts a percent-space zoom range [0-100] to actual domain coordinates.
+ * Returns the full base domain when zoom is null/undefined or full-span.
+ *
+ * @param baseDomain - The complete data domain (unzoomed)
+ * @param zoomRange - Zoom window in percent space [0-100], or null for full view
+ * @returns Visible domain with min, max, and span fraction
+ *
+ * @example
+ * ```ts
+ * const baseDomain = { min: 0, max: 1000 };
+ * const zoomRange = { start: 25, end: 75 };
+ * const visible = computeVisibleDomain(baseDomain, zoomRange);
+ * // Returns: { min: 250, max: 750, spanFraction: 0.5 }
+ * ```
+ */
+export declare function computeVisibleDomain(baseDomain: DomainBounds, zoomRange?: ZoomRange | null): VisibleDomain;
+/**
+ * Checks if a zoom range represents a full-span (unzoomed) view.
+ *
+ * A zoom is considered full-span if:
+ * - Range is null/undefined
+ * - Start is at or before 0% AND end is at or after 100%
+ *
+ * Small tolerance (0.5%) is applied to account for floating-point arithmetic
+ * and UI imprecision (e.g., slider at edge).
+ *
+ * @param zoomRange - Zoom window to check, or null
+ * @returns True if the zoom represents a full-span view
+ *
+ * @example
+ * ```ts
+ * isFullSpanZoom(null);                        // true
+ * isFullSpanZoom({ start: 0, end: 100 });      // true
+ * isFullSpanZoom({ start: -0.1, end: 100.1 }); // true (tolerance)
+ * isFullSpanZoom({ start: 25, end: 75 });      // false
+ * ```
+ */
+export declare function isFullSpanZoom(zoomRange: ZoomRange | null | undefined): boolean;
+/**
+ * Computes a buffer zone around the visible domain for data caching.
+ *
+ * Adds a percentage buffer on each side of the visible domain to cache
+ * extra data points for smooth panning. This reduces resampling frequency
+ * when the user pans slightly beyond the current view.
+ *
+ * @param visibleDomain - Current visible domain
+ * @param bufferPercent - Buffer percentage (0 to 1), default 0.1 (10%)
+ * @returns Buffered domain bounds
+ *
+ * @example
+ * ```ts
+ * const visible = { min: 100, max: 200 };
+ * const buffered = computeBufferedDomain(visible, 0.1);
+ * // Returns: { min: 90, max: 210 } (±10% buffer)
+ * ```
+ */
+export declare function computeBufferedDomain(visibleDomain: DomainBounds, bufferPercent?: number): DomainBounds;
+/**
+ * Converts a domain coordinate to percent-space relative to base domain.
+ *
+ * Useful for converting mouse positions or data coordinates to zoom range
+ * percentages for zoom/pan operations.
+ *
+ * @param value - Domain coordinate to convert
+ * @param baseDomain - Base domain for reference
+ * @returns Percent value [0-100]
+ *
+ * @example
+ * ```ts
+ * const percent = domainValueToPercent(500, { min: 0, max: 1000 });
+ * // Returns: 50
+ * ```
+ */
+export declare function domainValueToPercent(value: number, baseDomain: DomainBounds): number;
+/**
+ * Converts a percent-space value to domain coordinate.
+ *
+ * Inverse of `domainValueToPercent`. Useful for converting zoom range
+ * percentages back to domain coordinates.
+ *
+ * @param percent - Percent value [0-100]
+ * @param baseDomain - Base domain for reference
+ * @returns Domain coordinate
+ *
+ * @example
+ * ```ts
+ * const value = percentToDomainValue(50, { min: 0, max: 1000 });
+ * // Returns: 500
+ * ```
+ */
+export declare function percentToDomainValue(percent: number, baseDomain: DomainBounds): number;
+/**
+ * Calculates the zoom span (in percent) from a domain window.
+ *
+ * @param windowDomain - The zoomed window domain
+ * @param baseDomain - The full base domain
+ * @returns Span in percent [0-100]
+ */
+export declare function calculateZoomSpan(windowDomain: DomainBounds, baseDomain: DomainBounds): number;
+//# sourceMappingURL=zoomHelpers.d.ts.map

package/dist/core/renderCoordinator/zoom/zoomHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zoomHelpers.d.ts","sourceRoot":"","sources":["../../../../src/core/renderCoordinator/zoom/zoomHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,YAAY,EACxB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,GAC3B,aAAa,CAsBf;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAS/E;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qBAAqB,CACnC,aAAa,EAAE,YAAY,EAC3B,aAAa,GAAE,MAAY,GAC1B,YAAY,CAWd;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,GAAG,MAAM,CAMpF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,GAAG,MAAM,CAGtF;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,GAAG,MAAM,CAQ9F"}