Class InteractionGroup

Manage a virtual group of interaction by setting a group uid in every added interaction. It can add, remove, find interaction, and toggle the active state of interactions.

Index

Constructors

Methods

add deactivateAll destroy find findByIncluding getGroupInteractions hasInteraction remove setActive

Constructors

constructor

new InteractionGroup(map: Map, groupUid?: string): InteractionGroup
Parameters
- map: Map
- OptionalgroupUid: string
Returns InteractionGroup
- Defined in interaction/interactionGroup.ts:16

Methods

add

add(uid: string, interaction: Interaction): void
Adds the given interaction to the given map with an uid. The interaction can't be in multiple groups at the same time.
Parameters
- uid: string
  The uid to associate with the interaction
- interaction: Interaction
  The interaction to add
Returns void
- Defined in interaction/interactionGroup.ts:37

deactivateAll

deactivateAll(): void
Deactivate all draw interaction of this group.

Returns void
- Defined in interaction/interactionGroup.ts:122

destroy

destroy(): void
Deactivates and remove every interaction of this group.

Returns void
- Defined in interaction/interactionGroup.ts:131

find

find(uid: string): undefined | Interaction
Finds an interaction by its uid
Parameters
- uid: string
  The uid of the interaction to find
Returns undefined | Interaction
The interaction if found, undefined otherwise
- Defined in interaction/interactionGroup.ts:61

findByIncluding

findByIncluding(uidPart: string): Interaction[]
Finds all interaction having uid included in the provided uid.
Parameters
- uidPart: string
  A start part uid of the interaction to find.
Returns Interaction[]
The interaction if found or undefined otherwise.
- Defined in interaction/interactionGroup.ts:72

getGroupInteractions

getGroupInteractions(): Interaction[]
Returns Interaction[]
all the interaction of the wanted group.
- Defined in interaction/interactionGroup.ts:24

hasInteraction

hasInteraction(uid: string): boolean
Verifies if the interaction is already present in the map
Parameters
- uid: string
  The uid of the interaction to check
Returns boolean
boolean indicating if the interaction is present
- Defined in interaction/interactionGroup.ts:97

remove

remove(uid: string): void
Removes the given interaction from the map.
Parameters
- uid: string
  The uid of the interaction to remove
Returns void
- Defined in interaction/interactionGroup.ts:82

setActive

setActive(active: boolean, uid: string): void
Activate the interaction (and deactivate other interactions of this group) or deactivate it.
Parameters
- active: boolean
- uid: string
Returns void
- Defined in interaction/interactionGroup.ts:107