Class: SDKAnnotation
entities.SDKAnnotation
Represents an annotation instance within the SDK.
Implements
Table of contents
Constructors
Properties
- annotationId
- attributes
- clientId
- coordinates
- createdAt
- creator
- data
- datasetId
- description
- id
- itemId
- label
- labelSuggestions
- metadata
- type
- updatedAt
- updatedBy
Constructors
constructor
• new SDKAnnotation(annotation)
Creates an instance of SDKAnnotation.
Parameters
| Name | Type | Description |
|---|---|---|
annotation |
any |
Annotation data to initialize the SDKAnnotation object with. |
Properties
annotationId
• Optional annotationId: string
The annotation ID of the annotation.
attributes
• attributes: string[]
The attributes of the annotation.
clientId
• clientId: string
The client ID of the annotation.
coordinates
• Optional coordinates: any
The coordinates of the annotation.
createdAt
• createdAt: IDate
The creation date of the annotation.
creator
• creator: string
The creator of the annotation.
data
• Optional data: any
The data of the annotation.
datasetId
• datasetId: string
The ID of the dataset the annotation belongs to.
description
• Optional description: string
The description of the annotation.
id
• id: string
The ID of the annotation.
Implementation of
itemId
• itemId: string
The item ID of the annotation.
Implementation of
label
• label: string
The label of the annotation.
Implementation of
labelSuggestions
• labelSuggestions: Object
The label suggestions for the annotation.
Index signature
▪ [p: string]: number
Implementation of
metadata
• metadata: any
The metadata of the annotation.
Implementation of
type
• type: string
The type of the annotation.
Implementation of
updatedAt
• updatedAt: IDate
The last update date of the annotation.
Implementation of
updatedBy
• updatedBy: string
The last updater of the annotation.