visualization-tools

Home > @visualization-tools/core > IHitTestComponent > index

IHitTestComponent.index() method

Where a hit test requires generating / modifying a data structure, this can be done here.

Signature:

index(entity: TEntityTrait<TUpdateArg, TTraits>, updateArg: TUpdateArg, componentState: TComponentState): void;

Parameters

Parameter	Type	Description
entity	TEntityTrait<TUpdateArg, TTraits>	The entity to index.
updateArg	TUpdateArg	Specific to the current plot type.
componentState	TComponentState	The data structure to update.

Returns:

void