Address comments from code review, add docstrings

Author: TrevorBurgoyne

dist/ulabel.js

@@ -180,7 +180,7 @@ export class ULabelAnnotation {
      * @param {number} image_height Height of the image.
      * @return {ULabelAnnotation} The annotation with the updated spatial payload.
      */
-    public fit_to_image_bounds(image_width: number, image_height: number): ULabelAnnotation {
+    public clamp_annotation_to_image_bounds(image_width: number, image_height: number): ULabelAnnotation {
         if (!this.is_delete_annotation()) {
             // Ensure each point in the payload is within the image
             // for polygons, we'll need to loop through all points
@@ -205,6 +205,12 @@ export class ULabelAnnotation {
         return this;
     }
 
+    /**
+     * Check if the annotation is a delete annotation, e.g. annotations drawn by the `delete_polygon`
+     * or `delete_bbox` annotation modes.
+     *
+     * @returns {boolean} True if the annotation is a delete annotation, false otherwise.
+     */
     public is_delete_annotation(): boolean {
         // Check if the annotation is a delete annotation
         return this.classification_payloads[0]["class_id"] === DELETE_CLASS_ID;

dist/ulabel.min.js

@@ -2984,7 +2984,7 @@ export class ULabel {
 
         // Snap each point to the image bounds
         if (!this.config.allow_annotations_outside_image) {
-            new_annotation = new_annotation.fit_to_image_bounds(this.config["image_width"], this.config["image_height"]);
+            new_annotation = new_annotation.clamp_annotation_to_image_bounds(this.config["image_width"], this.config["image_height"]);
         }
 
         if (spatial_type === "polygon") {
@@ -5319,6 +5319,12 @@ export class ULabel {
         return raw;
     }
 
+    /**
+     * Get the mouse position, clamped to the image bounds if `allow_annotations_outside_image` is false.
+     *
+     * @param {*} mouse_event The mouse event to get the position from
+     * @returns {[number, number]} The (x, y) coordinates of the mouse, clamped to the image bounds if required
+     */
     get_image_aware_mouse_x_y(mouse_event) {
         const x = this.get_global_mouse_x(mouse_event);
         const y = this.get_global_mouse_y(mouse_event);

src/annotation.ts

@@ -93,7 +93,7 @@ export async function ulabel_init(
         const image_width = ulabel.config["image_width"];
         for (const subtask of Object.values(ulabel.subtasks)) {
             for (const anno of Object.values(subtask.annotations.access)) {
-                anno.fit_to_image_bounds(image_width, image_height);
+                anno.clamp_annotation_to_image_bounds(image_width, image_height);
             }
         }
     }

src/index.js

@@ -2515,7 +2515,7 @@ export class SubmitButtons extends ToolboxItem {
 
                         // Ensure annotation is within the image if required
                         if (!ulabel.config.allow_annotations_outside_image) {
-                            annotation.fit_to_image_bounds(
+                            annotation.clamp_annotation_to_image_bounds(
                                 ulabel.config["image_width"],
                                 ulabel.config["image_height"],
                             );