Skip to main content

Interface: CircleROIStartEndThresholdAnnotation

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.

cachedStats?

optional cachedStats: object

cachedStats.pointsInVolume

pointsInVolume: Point3[]

cachedStats.projectionPoints

projectionPoints: Point3[][]

cachedStats.statistics?

optional statistics: ROICachedStats

endCoordinate

endCoordinate: number

handles

handles: object

handles.activeHandleIndex

activeHandleIndex: number

handles.points

points: [Point3, Point3]

handles.textBox?

optional textBox: object

handles.textBox.hasMoved

hasMoved: boolean

handles.textBox.worldBoundingBox

worldBoundingBox: object

handles.textBox.worldBoundingBox.bottomLeft

bottomLeft: Point3

handles.textBox.worldBoundingBox.bottomRight

bottomRight: Point3

handles.textBox.worldBoundingBox.topLeft

topLeft: Point3

handles.textBox.worldBoundingBox.topRight

topRight: Point3

handles.textBox.worldPosition

worldPosition: Point3

label

label: string

startCoordinate

startCoordinate: number

Overrides

Annotation.data

Defined in

tools/src/types/ToolSpecificAnnotationTypes.ts:291


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

Metadata for annotation

annotationUID?

optional annotationUID: string

cameraFocalPoint?

optional cameraFocalPoint: Point3

cameraPosition?

optional cameraPosition: Point3

enabledElement

enabledElement: IEnabledElement

FrameOfReferenceUID

FrameOfReferenceUID: string

referencedImageId?

optional referencedImageId: string

spacingInNormal

spacingInNormal: number

toolName

toolName: string

viewPlaneNormal?

optional viewPlaneNormal: Point3

viewUp?

optional viewUp: Point3

volumeId

volumeId: string

Overrides

Annotation.metadata

Defined in

tools/src/types/ToolSpecificAnnotationTypes.ts:278


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