From f312bae61472797f129006db5600de6bd6c727eb Mon Sep 17 00:00:00 2001
From: Michael Gibson <michael.gibson@techcyte.com>
Date: Fri, 28 Feb 2025 15:35:25 -0700
Subject: [PATCH] Document flag

---
 src/openseadragon.js | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/openseadragon.js b/src/openseadragon.js
index 837595aa..a75c3c55 100644
--- a/src/openseadragon.js
+++ b/src/openseadragon.js
@@ -355,6 +355,9 @@
   *     Specifies the animation duration per each {@link OpenSeadragon.Spring}
   *     which occur when the image is dragged, zoomed or rotated.
   *
+  * @property {Number} [loadTilesOnAnimationPathTiles=true]
+  *    If true, tiles are loaded when they are on the path of the animation.
+  *    If false, tiles at the animation destination are optimistically loaded
   * @property {OpenSeadragon.GestureSettings} [gestureSettingsMouse]
   *     Settings for gestures generated by a mouse pointer device. (See {@link OpenSeadragon.GestureSettings})
   * @property {Boolean} [gestureSettingsMouse.dragToPan=true] - Pan on drag gesture
@@ -1275,6 +1278,7 @@ function OpenSeadragon( options ){
             dblClickDistThreshold:  20,
             springStiffness:        6.5,
             animationTime:          1.2,
+            loadTilesOnAnimationPath: true,
             gestureSettingsMouse:   {
                 dragToPan: true,
                 scrollToZoom: true,