Skip to main content

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

Cached Annotation statistics which is specific to the tool

data.handles?​

optional handles: object

Annotation handles that are grabbable for manipulation

Index Signature​

[key: string]: unknown

data.handles.activeHandleIndex?​

optional activeHandleIndex: number | null

index of the active handle being manipulated

data.handles.points?​

optional points: Types.Point3[]

world location of the handles in the space

data.handles.textBox?​

optional textBox: object

annotation text box information

data.handles.textBox.hasMoved?​

optional hasMoved: boolean

whether the text box has moved

data.handles.textBox.worldBoundingBox?​

optional worldBoundingBox: object

text box bounding box information

data.handles.textBox.worldBoundingBox.bottomLeft​

bottomLeft: Types.Point3

Bottom left location of the text box in the world space

data.handles.textBox.worldBoundingBox.bottomRight​

bottomRight: Types.Point3

Bottom right location of the text box in the world space

data.handles.textBox.worldBoundingBox.topLeft​

topLeft: Types.Point3

Top left location of the text box in the world space

data.handles.textBox.worldBoundingBox.topRight​

topRight: Types.Point3

Top right location of the text box in the world space

data.handles.textBox.worldPosition?​

optional worldPosition: Types.Point3

the world location of the text box

highlighted?​

optional highlighted: boolean

If the annotation is being hovered over and is highlighted

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