Get collection id.
collection id
Get collection name.
Collection name
Set collection name.
Collection name
Get marker count.
Collection size
Add a new marker to collection.
The marker added to the collection
The new marker position in collection. -1 means at the collection end (topmost)
Get marker at a specific index (alias for getMarkerAt).
Delete all markers.
Delete a marker by index.
The index of the marker to be deleted
Get the marker at the given index.
Return null if index is not valid.
The marker index
Marker object. If the index is not valid then null is returned
Get the marker with the given id.
The marker id
Marker object or null if not found
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
The group id. It needs to be the marker id returned by MarkerCollection.getPointsGroupHead method
Points group components list if the groupId is valid, empty list otherwise. The list does not contain the group head marker.
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
The marker id belonging to the points group
Points group head marker or null if not found
Hit test in collection markers.
The coordinates of the position to be tested
OptionalignoreMarker: MarkerThe marker to be ignored in the test
The list of marker matches
Get the index of the given marker.
The marker
The index of the given marker if the marker is in the collection, -1 if the marker is not in the collection
Serialize to buffer.
Serialized Uint8Array buffer on success, null otherwise
Serialize collection to JSON format.
StaticcreateCreate a new marker collection.
The type of markers this collection will hold
The name of the collection
StaticfromStaticinitStaticloadDeserialize from buffer.
The buffer to deserialize from
Deserialized MarkerCollection object on success, null otherwise
Marker collection class
Holds markers of a single visual style and geometry class for a map view.
Common tasks are creating a collection for a specific marker kind and adding or removing markers, looking up markers by position or identifier, iterating or counting entries, querying the collection's geographic extent for layout or hit‑testing, grouping and retrieving related components.
Can be presented on a map via the MapViewMarkerCollections object associated with a GemMapController.
Also see MarkerSketches for a specialized marker collection with per-marker render settings.