Type Alias: Annotation

Annotation: object

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: object

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

Index Signature

[key: string]: unknown

data.cachedStats?

optional cachedStats: Record<string, unknown>

Cached Annotation statistics which is specific to the tool

data.handles?

optional handles: Handles

Annotation handles that are grabbable for manipulation

data.label?

optional label: string

Label of an annotation

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

metadata: Types.ViewReference & object

Metadata for annotation

Type declaration

cameraPosition?

optional cameraPosition: Types.Point3

The position of the camera in world space.

toolName

toolName: string

The registered name of the tool

viewUp?

optional viewUp: Types.Point3

The viewUp for the view position

parentAnnotationUID?

optional parentAnnotationUID: string

Parent annotation UID

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

Defined in

tools/src/types/AnnotationTypes.ts:3