Plugin Documenation Template

Plugin Overview

The plugin enables you to easily annotate images with this powerful and flexible JavaScript plugin. Perfect for adding notes, comments, and highlights to your images.

Detailed Description and Use Case

Enhance your images with interactive annotations using our robust and user-friendly Image Annotation Plugin. Designed for developers and content creators, this plugin offers a seamless way to add detailed notes, comments, and highlights directly onto images. This works by using an Attachments field and after an image is uploaded you can turn the image into a canvas that can be drawn on. Once you finish drawing and annotating you can save the image back or add it as a new image in the attachments field. 

This can be very useful for when you want to do any of the following: 

1. Medical Imaging: If you have X-rays, MRIs, or CT scans, you can annotate them to highlight areas of concern, such as tumors or fractures, and share these with colleagues or patients.
2. Educational Platforms: If you have diagrams, maps, and other visual aids, you can annotate them during online classes, making it easier to explain and understand complex concepts.
3. Real Estate: If you have floor plans and property photos, you can annotate them to mark areas of interest, suggest modifications, or highlight features during virtual tours.
4. Collaborative Design: If you have prototypes, sketches, and mockups, you can annotate them to give feedback, suggest changes, or highlight specific elements in collaborative design projects.
5. Construction and Engineering: If you have blueprints and site photos, you can mark them up to indicate progress, note issues, and communicate changes to project teams.
6. E-commerce: If you have product images, you can annotate them to highlight defects, customization requests, or specific features during the return or customization process.
7. Insurance Claims: If you have photos of damages, you can annotate them to provide context and details, facilitating a smoother claims process.
8. Scientific Research: If you have images from experiments or fieldwork, you can annotate them to highlight findings, note anomalies, and share insights with peers.
9. Social Media and Content Creation: If you have photos, you can annotate them to create engaging content, add context, or highlight specific elements before sharing on social media platforms.
10. Security and Surveillance: If you have surveillance images, you can annotate them to highlight suspicious activities, mark individuals of interest, and share these annotations with your team for further investigation.

Video Guide

Installing the plugin

Prerequisites:

1. The page must have a form
2. The form must have an attachments field present
3. Javascript must be enabled (applicable if your're on trial account)

Step-by-Step Installation:

1. Navigate to the page with this form, this can be a parent or child  page. 
2. Click on the Plugins
3. Find the Image Annotation plugin
4. Select the form 
5. Select the attachments field

Limitations

• This only works with files under 10MB
• Does not work with File or the discontinued Image field type

Removing the Plugin

To remove the plugin, find the Javascript code that is surrounted with a comment for the plugin name and delete the code. Do the same for the CSS as well.