Clarify the coordinate system of AnchorPosition

b63fba7a · Eduardo Sanz García · Eduardo · 7650093f · b63fba7a
Commit b63fba7a authored Jan 31, 2022 by Eduardo Sanz García Committed by Eduardo Jan 31, 2022
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 1 deletion

annotator.js src/types/annotator.js +3 -1

No files found.
--- a/src/types/annotator.js
+++ b/src/types/annotator.js
@@ -55,7 +55,9 @@

 /**
 * Top and bottom positions of the bounding box created by the union of the
- * highlight elements associated to an anchor.
+ * highlight elements associated to an anchor. Top and bottom positions are
+ * based on the viewport. The value zero corresponds to the top of viewport.
+ * Hidden elements that are above the viewport have negative values.
 *
 * @typedef AnchorPosition
 * @prop {string} tag - annotation tag