From 2a2a4c250bd6d8a771ff9a77dc3c78f9f5a25e35 Mon Sep 17 00:00:00 2001 From: Matthew Petroff Date: Thu, 1 Aug 2019 20:48:28 -0400 Subject: [PATCH] Fix hot spot scale parameter documentation. --- doc/json-config-parameters.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/json-config-parameters.md b/doc/json-config-parameters.md index 0193e4a..796bee6 100644 --- a/doc/json-config-parameters.md +++ b/doc/json-config-parameters.md @@ -318,7 +318,10 @@ for the hot spot's `click` event. The event object and the contents of #### `scale` (boolean) -When `true`, the hotspot is scaled to match the fish eye effect of the image +When `true`, the hot spot is scaled to match changes in the field of view, +relative to the initial field of view. Note that this does not account for +changes in local image scale that occur due to distortions within the viewport. +Defaults to `false`. ### `hotSpotDebug` (boolean)