Skip to main content

Image Annotation

note

The Image Annotation question is available in the Form Builder and Sequential Form Builder question menus.

The Image Annotation question lets users draw annotations on top of an image inside a form.
When the form is submitted, the annotated image is saved to the file service and the question output is a URL string.

What it supports​

  • Draw-only annotation (freehand pen)
  • Explicit annotation mode toggle (Annotate / Done)
  • Clear annotations and redraw
  • Two preset-image configuration modes:
    • Preset image from URL
    • Preset image upload (uploaded to the file service, URL stored)
  • User-upload mode (form respondent uploads an image, then annotates)

How to set it up​

  1. In the form builder, add the Image Annotation field from the Data category.
  2. Open question settings and choose an Image source option:
    • User uploads an image
    • Preset image from URL
    • Upload a preset image
  3. If using preset URL mode, enter a direct image URL.
  4. If using preset upload mode, upload a file. The builder uploads it to the file service and stores the resulting URL.
  5. Save the form and test in preview or staging.

Runtime behavior​

  • If a preset image is configured, it appears as the background image for annotation.
  • Users click Annotate to enter drawing mode.
  • Users click Done to finish drawing and apply annotations.
  • Clear annotations removes only drawn strokes and restores the base image.
  • In User uploads an image mode, users can replace the base image with Upload different image.

Output and placeholders​

The field outputs a single URL string via:

  • ${questionKey.answer}

This URL points to the final annotated image saved by the platform.

Notes and limitations​

  • This field outputs URL text only (not inline HTML image output).
  • If a preset URL uses a placeholder, that placeholder must resolve to a valid image URL at runtime.
  • Read-only mode prevents new annotation input.