visualization-tools

Home > @visualization-tools/core > OnEntityModified

OnEntityModified class

Emit on a plot to indicate that an entity has been modified and that caches should be regenerated. Refer to the group’s documentation as to the conditions where this is required.

Signature:

export declare class OnEntityModified<TPlotRange extends IPlotRange, TRequiredTraits> implements TOnEntityModified<TPlotRange, TRequiredTraits> 

Implements: TOnEntityModified<TPlotRange, TRequiredTraits>

Constructors

Constructor Modifiers Description
(constructor)(onEntityModified)   Constructs a new instance of the OnEntityModified class

Properties

Property Modifiers Type Description
callbackKey static “onEntityModified”  
onEntityModified   (…args: TEntityModifiedArgs<TPlotRange, TRequiredTraits>) => void  

Methods

Method Modifiers Description
emit(plot, entity) static  
registerListener(plot, onEvent) static  
registerOneTimeListener(plot, onEvent) static