Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "stable/src/api/annotations/types.gen"

Index

Interfaces

Type aliases

Type aliases

AnnotationData

AnnotationData: AnnotationsBoundingVolume | AnnotationsClassification | AnnotationsDetection | AnnotationsExtractedText | AnnotationsFileLink | AnnotationsIsoPlanAnnotation | AnnotationsJunction | AnnotationsKeypointCollection | AnnotationsLine | AnnotationsObjectDetection | AnnotationsTextRegion | AnnotationsUnhandledSymbolObject | AnnotationsUnhandledTextObject | AnnotationsCogniteAnnotationTypesDiagramsAssetLink | AnnotationsCogniteAnnotationTypesDiagramsInstanceLink | AnnotationsCogniteAnnotationTypesImagesAssetLink | AnnotationsCogniteAnnotationTypesImagesInstanceLink

The annotation information. The format of this object is decided by and validated against the annotationType attribute.

example

{"assetRef":{"externalId":"abc"},"symbolRegion":{"xMin":0.1,"xMax":0.2,"yMin":0.1,"yMax":0.2},"textRegion":{"xMin":0.2,"xMax":0.3,"yMin":0.2,"yMax":0.3},"pageNumber":43}

AnnotationsAssetRef

AnnotationsAssetRef: { externalId?: undefined | string; id?: undefined | number }

A reference to an asset. Either the internal ID or the external ID must be provided (exactly one).

Type declaration

  • Optional externalId?: undefined | string
  • Optional id?: undefined | number

AnnotationsFileRef

AnnotationsFileRef: { externalId?: undefined | string; id?: undefined | number }

A reference to a file. Either the internal ID or the external ID must be provided (exactly one).

Type declaration

  • Optional externalId?: undefined | string
  • Optional id?: undefined | number