Calibration
1. Overview of Calibration and Scale
Calibration is a critical feature that enables users to measure distances, perimeters, and areas using calculation markups. Scales are document-tied, meaning once a user sets a scale on a document, others with shared access can use the same scale. Both primary users (document owners) and secondary users (shared users) can set, edit, and delete scales under specific conditions.
2. User Permissions Table
User Type |
Set Calibration/Scale |
Use Calibration/Scale Set by Another User |
Delete Calibration/Scale |
Edit Calibration/Scale |
Primary User (Doc Owner) |
Yes |
Yes |
Yes (if not used by secondary users) |
Yes (if not used by secondary users) |
Secondary User |
Yes (within the limit) |
Yes |
Yes (if not used by primary or other secondary users) |
Yes (if not used by primary or other secondary users) |
3. Key Features & Actions
Setting a New Scale
-
Users will see a 'Set Scale' modal the first time they attempt to use a calculation tool if no scale has been previously set.
-
The user can enter:
-
Paper Units (e.g., inches, feet)
-
Actual Units (e.g., 1 inch = 5 feet)
-
Apply Scale To: All Pages (default), Current Page (future enhancement), Custom (future enhancement)
-
Scale values can be entered in decimal or fractional formats.
Scale Saving Behavior
-
The Save button will only activate when all required fields are filled.
-
Successful saves will show a confirmation message: 'Set scale successfully.'
-
If the save fails due to network issues, users will see an error message: 'Scale set unsuccessfully. Please try again.'
Dynamic Scale Modal
-
Once a scale is set, a Dynamic Scale Modal appears in the top-right corner for easy reference.
-
The modal updates in real-time as users select calculation tools or place markups.
-
Users can drag the modal to reposition it within the viewer.
Managing Multiple Scales
-
Users can set up to 7 scales per document.
-
Attempting to add an 8th scale will display a message: 'Max 7 scales.'
4. Editing and Deleting Scales
Editing a Scale
-
Users can edit a scale if it has NOT been used by another user.
-
Editing a scale will NOT retroactively update markups that were placed before the edit.
-
If an edit attempt fails, users will see: 'Scale not edited. Please try again.'
Deleting a Scale
-
Users can delete a scale if it has NOT been used by another user.
-
Attempting to delete a scale in use by another user will show a disabled delete icon with a hover message: 'Scale in use by another user; edit and delete are disabled.'
5. Key System Messages to Know
-
Success (5 sec): 'Scale set successfully.'
-
Error (10 sec): 'Scale not set. Please try again.'
-
Deletion Success (5 sec): 'Scale deleted successfully.'
-
Deletion Failure (10 sec): 'Scale not deleted. Please try again.'
-
Disabled Icon Message: 'Scale in use by another user; edit and delete are disabled.'