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

MarkerCollection.getPointsGroupHead() method

Gets the points group head for the given marker id.

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 null and will set the API error accordingly

If markerId is already a points group head the function will return a reference to the queried marker and will set the API error accordingly

Signature:

getPointsGroupHead(markerId: number): Marker | null;

Parameters

Returns:

Marker | null

Points group head marker or null if not found