ImageAnnotation
The Annotorious image annotation model aligns closely with the W3C Web Annotation Data Model, but has a few key differences and simplifications which are explained in detail in this guide.
Example
Here’s an example of a typical Annotorious annotation object:
Properties
Property | Type | Default | Description |
---|---|---|---|
id | string | required | Unique ID. Will be autp-generated if not provided. |
target | ImageAnnotationTarget | required | Defines the annotated image region. |
bodies | AnnotationBody[] | [] | List of annotation bodies. |
properties | object | Can hold any custom properties you want to associate with the annotation. |
ImageAnnotationTarget
Represents the target of an image annotation.
Property | Type | Default | Description |
---|---|---|---|
annotation | string | Reference to the parent annotation. Will be auto-generated if not provided. | |
selector | Shape | required | Annotated image region shape. |
creator | User | User who created the annotation. | |
created | Date | Creation timestamp of the annotation. | |
updatedBy | User | User who last modified the annotation. | |
updated | Date | Last update timestamp of the annotation. |
AnnotationBody
Represents a payload body of an annotation.
Property | Type | Default | Description |
---|---|---|---|
id | string | required | Unique identifier for the body. |
annotation | string | Reference to the parent annotation. Will be auto-generated if not provided. | |
type | string | Annotation body type. | |
purpose | string | Annotation body purpose. | |
value | string | Annotation body value. | |
creator | User | User who created the body. | |
created | Date | Creation timestamp of the body. | |
updatedBy | User | User who last modified the body. | |
updated | Date | Last update timestamp of the body. |
Purposes
You can use any string of your choice for the purpose
field of the
AnnotationBody
. However, it is recommended to use the purpose values
predefined in the W3C model
for better interoperability with other systems.
For convenience, Annotorious provides IDE auto-complete support for these standard purposes:
- assessing
- bookmarking
- classifying
- commenting
- describing
- editing
- highlighting
- identifying
- linking
- moderating
- questioning
- replying
- tagging