Class: SDKAnnotation<T>
Represents an annotation instance within the SDK.
Implements
Type parameters
| Name | Type |
|---|---|
T | any |
Implements
Table of contents
Constructors
Properties
- clientId
- coordinates
- createdAt
- creator
- datasetId
- annotationId
- id
- itemId
- label
- labelSuggestions
- metadata
- type
- updatedAt
- updatedBy
- attributes
- description
- data
- labelColor
- snapshots
Methods
Constructors
constructor
• new SDKAnnotation<T>(annotation)
Creates an instance of SDKAnnotation.
Type parameters
| Name | Type |
|---|---|
T | any |
Parameters
| Name | Type | Description |
|---|---|---|
annotation | any | Annotation data to initialize the SDKAnnotation object with. |
Properties
clientId
• clientId: string
The client ID of the annotation.
Implementation of
coordinates
• Optional coordinates: any
The coordinates of the annotation.
Implementation of
createdAt
• createdAt: IDate
The creation date of the annotation.
Implementation of
creator
• creator: string
The creator of the annotation.
Implementation of
datasetId
• datasetId: string
The ID of the dataset the annotation belongs to.
Implementation of
annotationId
• Optional annotationId: string
The annotation ID 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.
Implementation of
attributes
• attributes: string[]
The attributes of the annotation.
description
• Optional description: string
The description of the annotation.
data
• Optional data: T
The data of the annotation.
labelColor
• Optional labelColor: string
snapshots
• snapshots: SnapshotService<T>
The snapshots of the annotation.
Methods
toJSON
▸ toJSON(): Object
Returns the annotation as a JSON object.
Returns
Object