Skip to main content

Type Alias: Annotation

Annotation: object

Defines the basic annotation type. This SHOULD be an interface, but typescript doesn't properly handle extending interfaces.

Type declaration​

annotationUID?​

optional annotationUID: string

A unique identifier for this annotation

autoGenerated?​

optional autoGenerated: boolean

If the annotation is auto generated from other annotations

childAnnotationUIDs?​

optional childAnnotationUIDs: string[]

Array that contains all child annotation UID

An annotation may have one or more child annotations when it is contour and have some holes in it.

data​

data: AnnotationData

Data for annotation, Derivatives need to define their own data types.

highlighted?​

optional highlighted: boolean

If the annotation is being hovered over and is highlighted

interpolationUID?​

optional interpolationUID: string

The interpolationUID, to match up annotations getting interpolated

invalidated?​

optional invalidated: boolean

Has annotation data been invalidated (e.g., as a result of mouse interactions)

isLocked?​

optional isLocked: boolean

If the annotation is locked for manipulation

isSelected?​

optional isSelected: boolean

If the annotation is selected

isVisible?​

optional isVisible: boolean

If the annotation is visible for manipulation

metadata?​

optional metadata: AnnotationMetadata

Metadata for annotation. Optional for any type, but required for measurements

parentAnnotationUID?​

optional parentAnnotationUID: string

Parent annotation UID

An annotation may have a parent annotation when it is, for example, a hole inside a contour.

predecessorImageId?​

optional predecessorImageId: string

The predecessorImageId is the image id this instance object was loaded from. It is the predecessor since the current annotation state may not reflect the current state and this object is in fact not the loaded object.

This can be set to distinguish annotation sources externally to CS3D.

Defined in​

tools/src/types/AnnotationTypes.ts:52