Class: SDKAnnotation<T>

sdkApi/interfaces/entities/iAnnotation.SDKAnnotation

Represents an annotation instance within the SDK.

Implements

Type parameters

Name Type
T any

Implements

Table of contents

Constructors

Properties

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

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.

Implementation of

IAnnotation.clientId

coordinates

• Optional coordinates: any

The coordinates of the annotation.

Implementation of

IAnnotation.coordinates

createdAt

• createdAt: IDate

The creation date of the annotation.

Implementation of

IAnnotation.createdAt

creator

• creator: string

The creator of the annotation.

Implementation of

IAnnotation.creator

data

• Optional data: T

The data of the annotation.

datasetId

• datasetId: string

The ID of the dataset the annotation belongs to.

Implementation of

IAnnotation.datasetId

description

• Optional description: string

The description of the annotation.

id

• id: string

The ID of the annotation.

Implementation of

IAnnotation.id

itemId

• itemId: string

The item ID of the annotation.

Implementation of

IAnnotation.itemId

label

• label: string

The label of the annotation.

Implementation of

IAnnotation.label

labelSuggestions

• labelSuggestions: Object

The label suggestions for the annotation.

Index signature

▪ [p: string]: number

Implementation of

IAnnotation.labelSuggestions

metadata

• metadata: any

The metadata of the annotation.

Implementation of

IAnnotation.metadata

snapshots

• snapshots: SnapshotService<T>

The snapshots of the annotation.

type

• type: string

The type of the annotation.

Implementation of

IAnnotation.type

updatedAt

• updatedAt: IDate

The last update date of the annotation.

Implementation of

IAnnotation.updatedAt

updatedBy

• updatedBy: string

The last updater of the annotation.

Implementation of

IAnnotation.updatedBy

Methods

toJSON

▸ toJSON(): Object

Returns the annotation as a JSON object.

Returns

Object

Name Type
attributes string[]
clientId string
coordinates any
createdAt IDate
creator string
data T
datasetId string
description string
id string
itemId string
label string
labelColor string
labelSuggestions { [p: string]: number; }
metadata any
type string
updatedAt IDate
updatedBy string