Class: AnnotationGroup
An annotation group
Constructors
new AnnotationGroup()
new AnnotationGroup():
AnnotationGroup
Returns
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:20
Properties
visibleFilter()
visibleFilter: (
uid) =>boolean
Parameters
• uid: string
Returns
boolean
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:18
Accessors
isVisible
getisVisible():boolean
Returns
boolean
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:70
Methods
add()
add(...
annotationUIDs):void
Adds the annotation to the group Does NOT change the visibility status of the annotation.
Parameters
• ...annotationUIDs: string[]
Returns
void
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:98
clear()
clear():
void
Removes everything from the group.
Returns
void
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:117
findNearby()
findNearby(
uid,direction):string
Finds the nearby/next annotation in the given direction
Parameters
• uid: string
• direction: 1
Returns
string
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:75
has()
has(
uid):boolean
Parameters
• uid: string
Returns
boolean
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:32
remove()
remove(...
annotationUIDs):void
Removes the annotation from the group. Does not affect the visibility status of the annotation.
Parameters
• ...annotationUIDs: string[]
Returns
void
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:108
setVisible()
setVisible(
isVisible,baseEvent,filter?):void
Sets whether annotations belonging to this group are visible or not. If there are multiple groups, then the set visible false should be called before before re-enabling the other groups with setVisible true.
Parameters
• isVisible: boolean = true
• baseEvent: BaseEventDetail
• filter?
Returns
void
Defined in
tools/src/stateManagement/annotation/AnnotationGroup.ts:40
unboundVisibleFilter()
protectedunboundVisibleFilter(uid):boolean
Returns true if other groups are free to hide this annotation. That is, if the annotation is not a member or is hidden.
Parameters
• uid: string
Returns
boolean