Home > @magiclane/maps-sdk > MarkerCollection > getPointsGroupComponents

MarkerCollection.getPointsGroupComponents() method

Gets the points group components.

This requires the collection to be added to a map view collection with MarkerCollectionRenderSettings.buildPointsGroupConfig set to true

If points group head info is not available the function will return a default list and will set the API error accordingly

Signature:

getPointsGroupComponents(groupId: number): Marker[];

Parameters

Parameter

Type

Description

groupId

number

The group id. It needs to be the marker id returned by MarkerCollection.getPointsGroupHead method

Returns:

Marker[]

Points group components list if the groupId is valid, empty list otherwise. The list does not contain the group head marker.