visualization-tools

Home > @visualization-tools/core > InteractionGroup

InteractionGroup class

Entities in this group have the same requirements as IHitTestableGroup. Allows up to 32 IInteractionGroups per plot for click / hover handlers etc.

Signature:

export declare class InteractionGroup<TUpdateArg, TStore, TTraits extends IHitTestableTrait> extends AEntityGroup<IHitTestableGroupOptions<TUpdateArg, TTraits, TStore>, IHitTestableTrait> implements IInteractionGroup<TUpdateArg, TStore, TTraits> 

Extends: AEntityGroup<IHitTestableGroupOptions<TUpdateArg, TTraits, TStore>, IHitTestableTrait>

Implements: IInteractionGroup<TUpdateArg, TStore, TTraits>

Remarks

IInteractionGroups should share IHitTestableGroups to avoid duplicate work. Each entity is allowed a single IHitTestableGroup shared between all IInteractionGroups but may have a unique IHitAllowedComponent per group.

Constructors

Constructor Modifiers Description
(constructor)(groupMask, hitTestableGroup, plot)   Constructs a new instance of the InteractionGroup class

Properties

Property Modifiers Type Description
entitiesInGroup   Set<TEntityTrait<TUpdateArg, IHitTestableTrait>>  
groupMask   number  
hitAllowedComponentStore   IEntityComponentStore<TEntityTrait<TUpdateArg, IHitTestableTrait>, IHitAllowedComponent<TUpdateArg, IHitTestableTrait>>  
hitTestableGroup   HitTestableGroup<IPlotRange, TUpdateArg, TStore>  

Methods

Method Modifiers Description
addToGroup(entity, options)    
onEntityAdded(entity, options)    
onEntityRemoved(entity)