Cluster points within a layer
This example demonstrates point clustering on a map using the Mapbox Maps SDK for iOS. The example creates a GeoJSONSource
using a remote GeoJSON resource.
Three layers are created from the loaded GeoJSON source. A CircleLayer
representing individual unclustered earthquakes, a CircleLayer
for earthquake clusters which scales its color and radius by the number of earthquakes using a data-driven style expression, and a SymbolLayer
to add a label for the number of earthquakes within each cluster.
This example code is part of the Maps SDK for iOS Examples App, a working iOS project available on Github. iOS developers are encouraged to run the examples app locally to interact with this example in an emulator and explore other features of the Maps SDK.
See our Run the Maps SDK for iOS Examples App tutorial for step-by-step instructions.
import UIKit
import MapboxMaps
final class ViewController: UIViewController {
private var mapView: MapView!
private var cancelables = Set<AnyCancelable>()
override func viewDidLoad() {
super.viewDidLoad()
// Initialize a map view centered over the United States and using the Mapbox Dark style.
let center = CLLocationCoordinate2D(latitude: 40.669957, longitude: -103.5917968)
let cameraOptions = CameraOptions(center: center, zoom: 2)
let mapInitOptions = MapInitOptions(cameraOptions: cameraOptions, styleURI: .dark)
mapView = MapView(frame: view.bounds, mapInitOptions: mapInitOptions)
mapView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
mapView.tintColor = .lightGray
view.addSubview(mapView)
mapView.mapboxMap.onStyleLoaded.observeNext { [weak self] _ in
self?.addPointClusters()
}.store(in: &cancelables)
}
func addPointClusters() {
// Parse GeoJSON data. This example uses all M1.0+ earthquakes from 12/22/15 to 1/21/16 as logged by USGS' Earthquake hazards program.
guard let url = URL(string: "https://www.mapbox.com/mapbox-gl-js/assets/earthquakes.geojson") else { return }
// Create a GeoJSONSource from the earthquake data URL.
var source = GeoJSONSource(id: "earthquake-source")
source.data = .url(url)
// Set the clustering properties directly on the source.
source.cluster = true
source.clusterRadius = 50
// The maximum zoom level where points will be clustered.
source.clusterMaxZoom = 14
// Create three separate layers from the same source.
// `clusteredLayer` contains clustered point features.
let clusteredLayer = createClusteredLayer(source: source.id)
// `unclusteredLayer` contains individual point features that do not represent clusters.
let unclusteredLayer = createUnclusteredLayer(source: source.id)
// `clusterCountLayer` is a `SymbolLayer` that represents the point count within individual clusters.
let clusterCountLayer = createNumberLayer(source: source.id)
// Add source and layers to the map view's style.
try! mapView.mapboxMap.addSource(source)
try! mapView.mapboxMap.addLayer(clusteredLayer)
try! mapView.mapboxMap.addLayer(unclusteredLayer, layerPosition: .below(clusteredLayer.id))
try! mapView.mapboxMap.addLayer(clusterCountLayer)
}
func createClusteredLayer(source: String) -> CircleLayer {
// Create a `CircleLayer` that only contains clustered points.
var clusteredLayer = CircleLayer(id: "clustered-earthquake-layer", source: source)
clusteredLayer.filter = Exp(.has) { "point_count" }
// Set the circle's color and radius based on the number of points within each cluster.
clusteredLayer.circleColor = .expression(Exp(.step) {
Exp(.get) { "point_count" }
UIColor(red: 0.32, green: 0.73, blue: 0.84, alpha: 1.00)
100
UIColor(red: 0.95, green: 0.94, blue: 0.46, alpha: 1.00)
750
UIColor(red: 0.95, green: 0.55, blue: 0.69, alpha: 1.00)
})
clusteredLayer.circleRadius = .expression(Exp(.step) {
Exp(.get) { "point_count" }
20
100
30
750
40
})
return clusteredLayer
}
func createUnclusteredLayer(source: String) -> CircleLayer {
var unclusteredLayer = CircleLayer(id: "unclusteredPointLayer", source: source)
// Filter out clusters by checking for point_count.
unclusteredLayer.filter = Exp(.not) {
Exp(.has) { "point_count" }
}
unclusteredLayer.circleColor = .constant(StyleColor(UIColor(red: 0.07, green: 0.71, blue: 0.85, alpha: 1.00)))
unclusteredLayer.circleRadius = .constant(4)
unclusteredLayer.circleStrokeWidth = .constant(1)
unclusteredLayer.circleStrokeColor = .constant(StyleColor(.black))
return unclusteredLayer
}
func createNumberLayer(source: String) -> SymbolLayer {
var numberLayer = SymbolLayer(id: "cluster-count-layer", source: source)
// Check whether the point feature is clustered.
numberLayer.filter = Exp(.has) { "point_count" }
// Display the value for 'point_count' in the text field.
numberLayer.textField = .expression(Exp(.get) { "point_count" })
numberLayer.textSize = .constant(12)
return numberLayer
}
}