HERE iOS SDK Developer's Guide

NMAClusterLayer

Class Summary

class NMAClusterLayer

Derived from: NSObject

NMAClusterLayer is a container of NMAMapMarker.

Include: NMAKit.framework/headers/NMAClusterLayer.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAClusterLayer

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSArray *  markers

Array of NMAMapMarker instances stored in this layer

[readable, writable, assign] NMAClusterTheme theme

Theme used during cluster markers rendering

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(BOOL) addMarker:(nonnull NMAMapMarker *) marker

Adds a marker to this layer

-(BOOL) addMarkers:(nonnull NSArray< NMAMapMarker * > *) markers

Adds an array of markers to this layer

-(nonnull instancetype) init

-(BOOL) removeMarker:(nonnull NMAMapMarker *) marker

Removes a marker from this layer

-(BOOL) removeMarkers:(nonnull NSArray< NMAMapMarker * > *) markers

Removes an array of markers from this layer

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) clusterLayer

Constructs an empty NMAClusterLayer

Class Details

NMAClusterLayer is a container of NMAMapMarker. Once added to the layer markers will start to cluster when the layer is attached to the map.

Public Property Details

[readable, assign] NSArray * markers

Array of NMAMapMarker instances stored in this layer.

[readable, writable, assign] NMAClusterThemetheme

Theme used during cluster markers rendering.

Instance Method Details

-(BOOL) addMarker:(nonnull NMAMapMarker *) marker

Adds a marker to this layer.

Parameters:

  • marker

    NMAMapMarker to be added.

Returns:

YES if the marker was successfully added.

-(BOOL) addMarkers:(nonnull NSArray< NMAMapMarker * > *) markers

Adds an array of markers to this layer.

Parameters:

  • markers

    Array of NMAMapMaker instances.

Returns:

YES if at least one marker was successfully added.

-(nonnull instancetype) init

Initialize a NMAClusterLayer instance

-(BOOL) removeMarker:(nonnull NMAMapMarker *) marker

Removes a marker from this layer.

Parameters:

  • marker

    NMAMapMarker to be removed.

Returns:

YES if the marker was successfully removed.

-(BOOL) removeMarkers:(nonnull NSArray< NMAMapMarker * > *) markers

Removes an array of markers from this layer.

Parameters:

  • markers

    Array of NMAMapMaker instances.

Returns:

YES if at least one marker was successfully removed.

Class Method Details

+(nonnull instancetype) clusterLayer

Constructs an empty NMAClusterLayer.