visualization-tools

Home > @visualization-tools/core > IWritablePlot > addToGroup

IWritablePlot.addToGroup() method

For additional type safety, use the group’s addToGroup method if present.

Signature:

addToGroup<TUpdateArg, TOptions, TGroupTraits>(entity: TEntityTrait<TUpdateArg, TRequiredTraits> & TGroupTraits, group: IEntityGroup<TOptions, TGroupTraits>, options: TOptions): boolean;

Parameters

Parameter	Type	Description
entity	TEntityTrait<TUpdateArg, TRequiredTraits> & TGroupTraits
group	IEntityGroup<TOptions, TGroupTraits>
options	TOptions

Returns:

boolean

true if the entity was added to the group.