visualization-tools

Home > @visualization-tools/core > HitTestableGroup

HitTestableGroup class

Entities in this group must implement IHitTestableTrait and have an associated IHitAllowedComponent and IHitTestComponent which can be accessed through the group. Hit test composition is not currently supported.

Signature:

export declare class HitTestableGroup<TPlotRange extends IPlotRange, TUpdateArg, TComponentState> extends AEntityGroup<IHitTestableGroupOptions<TUpdateArg, IHitTestableTrait, TComponentState>, IHitTestableTrait> implements IHitTestableGroup<TPlotRange, TUpdateArg, TComponentState> 

Extends: AEntityGroup<IHitTestableGroupOptions<TUpdateArg, IHitTestableTrait, TComponentState>, IHitTestableTrait>

Implements: IHitTestableGroup<TPlotRange, TUpdateArg, TComponentState>

Remarks

May be shared by multiple interaction groups, entities should not be added to this group through the plot, this is done by the interaction group. When implementing an interaction group these should use the reference counting methods refCountingAddEntity and refCountingRemoveEntity.

Constructors

Constructor Modifiers Description
(constructor)(argProvider, plot)   Constructs a new instance of the HitTestableGroup class

Properties

Property Modifiers Type Description
argProvider   IEntityUpdateArgProvider<TPlotRange, TUpdateArg, unknown>  
entitiesInGroup   Set<TEntityTrait<TUpdateArg, IHitTestableTrait>>  

Methods

Method Modifiers Description
getEntitiesByHitTester()    
getHitTester(entity)    
onEntityAdded(entity, options)    
onEntityRemoved(entity)    
refCountingAddEntity(entity, options)    
refCountingRemoveEntity(entity)