Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rightpoint/bentomap
Map Clustering for Swift.
https://github.com/rightpoint/bentomap
Last synced: 7 days ago
JSON representation
Map Clustering for Swift.
- Host: GitHub
- URL: https://github.com/rightpoint/bentomap
- Owner: Rightpoint
- License: mit
- Created: 2016-07-06T19:59:15.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2017-02-15T15:12:22.000Z (over 7 years ago)
- Last Synced: 2024-10-25T16:42:25.400Z (18 days ago)
- Language: Swift
- Size: 1.96 MB
- Stars: 182
- Watchers: 8
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# BentoMap
> Map Clustering for Swift
[](https://travis-ci.org/Raizlabs/BentoMap)
[](http://cocoapods.org/pods/BentoMap)
[](http://cocoapods.org/pods/BentoMap)
[](http://cocoapods.org/pods/BentoMap)
[](https://github.com/Carthage/Carthage)
BentoMap is an Swift implementation of [quadtrees][wiki] for map annotation clustering, and storage. It can also allow other 2d coordinate data to conform to a protocol and be added into `BentoBox` containers.
For more information, check out the [Raizlabs Developer Blog][rl]. The Android equivalent, known as "Marker Clustering," is [documented here][mk].
[wiki]: https://en.wikipedia.org/wiki/Quadtree
[rl]: https://www.raizlabs.com/dev/2016/08/introducing-bentomap/
[mk]: https://developers.google.com/maps/documentation/android-api/utility/marker-clustering
## Features
- [x] Store annotation data in QuadTrees
- [x] Fetch annotations in a region, with a clustering threshold
- [x] Protocols for storing other data types
## Requirements
- iOS 9.0+
- Xcode 8.0
## Installation
#### CocoaPods
BentoMap is available through [CocoaPods][cp]. To install it, simply add the following line to your Podfile:
```ruby
pod 'BentoMap'
```
#### Carthage
Create a `Cartfile` that lists the framework and run `carthage update`. Follow the [instructions][carthage] to add `$(SRCROOT)/Carthage/Build/iOS/BentoMap.framework` to an iOS project.
```ogdl
github "Raizlabs/BentoMap"
```
#### Manually
1. Download all of the `.swift` files in `BentoMap/` and `BentoMap/Extensions/` and drop them into your project.
2. Congratulations!
[cp]: http://cocoapods.org/
[carthage]: https://github.com/Carthage/Carthage#if-youre-building-for-ios
## Usage example
To see a full implementation of loading data into a map view, check out the [example project][ex].
### Inserting Data
```swift
import BentoMap
static var sampleData: QuadTree {
var samples = QuadTree(bentoBox: BentoBox(minPoint: MKMapPointForCoordinate(CLLocationCoordinate2D.minCoord), maxPoint: MKMapPointForCoordinate(CLLocationCoordinate2D.maxCoord)), bucketCapacity: 5)
let randomData = (1...5000).map { count in
return QuadTreeNode(originCoordinate: MKMapPointForCoordinate(CLLocationCoordinate2D.randomCoordinate()), content: count)
}
for node in randomData {
samples.insertNode(node)
}
return samples
}
```
### Updating a Map View
```swift
func updateAnnotations(inMapView mapView: MKMapView,
forMapRect root: MKMapRect) {
guard !mapView.frame.isEmpty && !MKMapRectIsEmpty(root) else {
mapView.removeAnnotations(mapView.annotations)
return
}
let zoomScale = Double(mapView.frame.width) / root.size.width
let clusterResults = mapData.clusteredDataWithinMapRect(root,
zoomScale: zoomScale,
cellSize: Double(MapKitViewController.cellSize))
let newAnnotations = clusterResults.map(BaseAnnotation.makeAnnotation)
let oldAnnotations = mapView.annotations.flatMap({ $0 as? BaseAnnotation })
let toRemove = oldAnnotations.filter { annotation in
return !newAnnotations.contains { newAnnotation in
return newAnnotation == annotation
}
}
mapView.removeAnnotations(toRemove)
let toAdd = newAnnotations.filter { annotation in
return !oldAnnotations.contains { oldAnnotation in
return oldAnnotation == annotation
}
}
mapView.addAnnotations(toAdd)
}
```
[ex]: https://github.com/Raizlabs/BentoMap/blob/develop/BentoMapExample/App/MapKitViewController.swift
## Contributing
Issues and pull requests are welcome! Please ensure that you have the latest [SwiftLint][sl] installed before committing and that there are no style warnings generated when building.
Contributors are expected to abide by the [Contributor Covenant Code of Conduct][cc].
[sl]: https://github.com/realm/SwiftLint
[cc]: https://github.com/Raizlabs/BentoMap/blob/develop/CONTRIBUTING.md
## License
BentoMap is available under the MIT license. See the `LICENSE` file for more info.
## Authors
- Michael Skiba: , [@atelierclkwrk][mstw]
- Rob Visentin:
- Matt Buckley: , [@mattthousand][mbtw]
[mstw]: https://twitter.com/atelierclkwrk
[mbtw]: https://twitter.com/mattthousand