Skip to main content

Interface: AdvancedMagnifyAnnotation

Extends​

Properties​

annotationUID?​

optional annotationUID: string

A unique identifier for this annotation

Inherited from​

Annotation.annotationUID

Defined in​

tools/src/types/AnnotationTypes.ts:5

autoGenerated?​

optional autoGenerated: boolean

If the annotation is auto generated from other annotations

Inherited from​

Annotation.autoGenerated

Defined in​

tools/src/types/AnnotationTypes.ts:35

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.

Inherited from​

Annotation.childAnnotationUIDs

Defined in​

tools/src/types/AnnotationTypes.ts:23

data​

data: object

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

handles​

handles: object

handles.activeHandleIndex​

activeHandleIndex: number

handles.points​

points: [Point3, Point3, Point3, Point3]

isCanvasAnnotation​

isCanvasAnnotation: boolean

magnifyViewportId​

magnifyViewportId: string

sourceViewportId​

sourceViewportId: string

zoomFactor​

zoomFactor: number

Overrides​

Annotation.data

Defined in​

tools/src/types/ToolSpecificAnnotationTypes.ts:95

highlighted?​

optional highlighted: boolean

If the annotation is being hovered over and is highlighted

Inherited from​

Annotation.highlighted

Defined in​

tools/src/types/AnnotationTypes.ts:25

interpolationUID?​

optional interpolationUID: string

The interpolationUID, to match up annotations getting interpolated

Inherited from​

Annotation.interpolationUID

Defined in​

tools/src/types/AnnotationTypes.ts:16

invalidated?​

optional invalidated: boolean

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

Inherited from​

Annotation.invalidated

Defined in​

tools/src/types/AnnotationTypes.ts:31

isLocked?​

optional isLocked: boolean

If the annotation is locked for manipulation

Inherited from​

Annotation.isLocked

Defined in​

tools/src/types/AnnotationTypes.ts:27

isSelected?​

optional isSelected: boolean

If the annotation is selected

Inherited from​

Annotation.isSelected

Defined in​

tools/src/types/AnnotationTypes.ts:33

isVisible?​

optional isVisible: boolean

If the annotation is visible for manipulation

Inherited from​

Annotation.isVisible

Defined in​

tools/src/types/AnnotationTypes.ts:29

metadata​

metadata: ViewReference & object

Metadata for annotation

Type declaration​

cameraPosition?​

optional cameraPosition: Point3

The position of the camera in world space.

toolName​

toolName: string

The registered name of the tool

viewUp?​

optional viewUp: Point3

The viewUp for the view position

Inherited from​

Annotation.metadata

Defined in​

tools/src/types/AnnotationTypes.ts:37

parentAnnotationUID?​

optional parentAnnotationUID: string

Parent annotation UID

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

Inherited from​

Annotation.parentAnnotationUID

Defined in​

tools/src/types/AnnotationTypes.ts:12