MarkerSet<T extends Marker> Class

A set of Markers that are logically related, such that they cluster when they overlap one another in screen space. In that case, a cluster marker is drawn instead of the overlapping Markers.


Name Description
constructor(viewport?: ScreenViewport): MarkerSet Construct a new MarkerSet for a specific ScreenViewport.  
addDecoration(context: DecorateContext): void This method should be called from Decorator.decorate.  
changeViewport(viewport: ScreenViewport): void Change the ScreenViewport for this MarkerSet. Beta
getClusterMarker(cluster: Cluster<T extends Marker>): Marker ProtectedAbstract Implement this method to create a new Marker that is shown as a stand-in for a Cluster of Markers that overlap one another.  
getMinScaleViewW(vp: Viewport): number Get weight value limit establishing the distance from camera for the back of view scale factor.  
markDirty(): void Indicate that this MarkerSet has been changed and is now dirty.  


Name Type Description
markers Accessor ReadOnly Set<T extends Marker> The set of Markers in this MarkerSet.  
minimumClusterSize number The minimum number of Markers that must overlap before they are clustered.  
viewport Accessor ReadOnly ScreenViewport | undefined The ScreenViewport of this MarkerSet.  

Defined in

Last Updated: 05 June, 2020