Skip to main content

Interface: ScaleOverlayAnnotation

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

Extends​

Properties​

annotationUID?​

optional annotationUID: string

A unique identifier for this annotation

Inherited from​

Annotation.annotationUID

Defined in​

tools/src/types/AnnotationTypes.ts:117

autoGenerated?​

optional autoGenerated: boolean

If the annotation is auto generated from other annotations

Inherited from​

Annotation.autoGenerated

Defined in​

tools/src/types/AnnotationTypes.ts:147

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

data​

data: object

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

handles​

handles: object

handles.points​

points: Point3[]

viewportId​

viewportId: string

Overrides​

Annotation.data

Defined in​

tools/src/types/ToolSpecificAnnotationTypes.ts:488

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

interpolationUID?​

optional interpolationUID: string

The interpolationUID, to match up annotations getting interpolated

Inherited from​

Annotation.interpolationUID

Defined in​

tools/src/types/AnnotationTypes.ts:128

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

isLocked?​

optional isLocked: boolean

If the annotation is locked for manipulation

Inherited from​

Annotation.isLocked

Defined in​

tools/src/types/AnnotationTypes.ts:139

isSelected?​

optional isSelected: boolean

If the annotation is selected

Inherited from​

Annotation.isSelected

Defined in​

tools/src/types/AnnotationTypes.ts:145

isVisible?​

optional isVisible: boolean

If the annotation is visible for manipulation

Inherited from​

Annotation.isVisible

Defined in​

tools/src/types/AnnotationTypes.ts:141

metadata?​

optional metadata: AnnotationMetadata

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

Inherited from​

Annotation.metadata

Defined in​

tools/src/types/AnnotationTypes.ts:149

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

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.

Inherited from​

Annotation.predecessorImageId

Defined in​

tools/src/types/AnnotationTypes.ts:161