1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
import XCTest
import Mapbox
import UIKit
/**
Test cases that ensure the inline examples in the project documentation
compile.
There is a run script build phase for the dynamic & static iOS targets
that invokes `/platform/ios/scrips/add-examples-to-docs.js`. This script
will pull example code out of this test file and replace the corresponding
placeholder comment in the built header files.
Adding examples:
1. Add a test case below
2. Wrap the code you'd like to appear in the documentation within the
following comment blocks:
`/*---BEGIN EXAMPLE: ExampleToken---*/`
...
`/*---END EXAMPLE---*/`
3. Insert a comment `<!--EXAMPLE: ExampleToken-->` inside the header file
where you'd like the example code to be inserted
*/
class MGLDocumentationExampleTests: XCTestCase {
var mapView: MGLMapView!
override func setUp() {
super.setUp()
self.mapView = MGLMapView(frame: CGRect(x: 0, y: 0, width: 256, height: 256))
}
override func tearDown() {
self.mapView = nil
super.tearDown()
}
// MGLShapeSource
func testMGLShapeSourceExample() {
/*---BEGIN EXAMPLE: MGLShapeSource---*/
var coordinates: [CLLocationCoordinate2D] = [
CLLocationCoordinate2D(latitude: 37.77, longitude: -122.42),
CLLocationCoordinate2D(latitude: 38.91, longitude: -77.04),
]
let polyline = MGLPolylineFeature(coordinates: &coordinates, count: UInt(coordinates.count))
let shape = MGLShapeCollectionFeature(shapes: [polyline])
let source = MGLShapeSource(identifier: "lines", shape: shape, options: nil)
mapView.style.addSource(source)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.source(withIdentifier: "lines"))
}
// MGLRasterSource
func testMGLRasterSourceExample() {
/*---BEGIN EXAMPLE: MGLRasterSource---*/
let source = MGLRasterSource(identifier: "clouds", tileURLTemplates: ["https://example.com/raster-tiles/{z}/{x}/{y}.png"], options: [
.minimumZoomLevel: 9,
.maximumZoomLevel: 16,
.tileSize: 512,
.attributionInfos: [
MGLAttributionInfo(title: NSAttributedString(string: "© Mapbox"), url: URL(string: "http://mapbox.com"))
]
])
mapView.style.addSource(source)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.source(withIdentifier: "clouds"))
}
// MGLVectorSource
func testMGLVectorSource() {
/*---BEGIN EXAMPLE: MGLVectorSource---*/
let source = MGLVectorSource(identifier: "pois", tileURLTemplates: ["https://example.com/vector-tiles/{z}/{x}/{y}.mvt"], options: [
.minimumZoomLevel: 9,
.maximumZoomLevel: 16,
.attributionInfos: [
MGLAttributionInfo(title: NSAttributedString(string: "© Mapbox"), url: URL(string: "http://mapbox.com"))
]
])
mapView.style.addSource(source)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.source(withIdentifier: "pois"))
}
// MGLCircleStyleLayer
func testMGLCircleStyleLayerExample() {
let population = MGLVectorSource(identifier: "population", configurationURL: URL(string: "https://example.com/style.json")!)
mapView.style.addSource(population)
/*---BEGIN EXAMPLE: MGLCircleStyleLayer---*/
let layer = MGLCircleStyleLayer(identifier: "circles", source: population)
layer.sourceLayerIdentifier = "population"
layer.circleColor = MGLStyleValue(rawValue: UIColor.green)
layer.circleRadius = MGLStyleValue(interpolationBase: 1.75, stops: [
12: MGLStyleValue(rawValue: 2),
22: MGLStyleValue(rawValue: 180)
])
layer.circleOpacity = MGLStyleValue(rawValue: 0.7)
layer.predicate = NSPredicate(format: "%K == %@", "marital-status", "married")
mapView.style.addLayer(layer)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.layer(withIdentifier: "circles"))
}
// MGLLineStyleLayer
func testMGLLineStyleLayerExample() {
let trails = MGLVectorSource(identifier: "trails", configurationURL: URL(string: "https://example.com/style.json")!)
mapView.style.addSource(trails)
/*---BEGIN EXAMPLE: MGLLineStyleLayer---*/
let layer = MGLLineStyleLayer(identifier: "trails-path", source: trails)
layer.sourceLayerIdentifier = "trails"
layer.lineWidth = MGLStyleValue(interpolationBase: 1.5, stops: [
14: MGLStyleValue(rawValue: 2),
18: MGLStyleValue(rawValue: 20),
])
layer.lineColor = MGLStyleValue(rawValue: UIColor.brown)
layer.lineCap = MGLStyleValue(rawValue: NSValue(mglLineCap: .round))
layer.predicate = NSPredicate(format: "%K == %@", "trail-type", "mountain-biking")
mapView.style.addLayer(layer)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.layer(withIdentifier: "trails-path"))
}
// MGLFillStyleLayer
func testMGLFillStyleLayerExample() {
let parks = MGLVectorSource(identifier: "parks", configurationURL: URL(string: "https://example.com/style.json")!)
mapView.style.addSource(parks)
/*---BEGIN EXAMPLE: MGLFillStyleLayer---*/
let layer = MGLFillStyleLayer(identifier: "parks", source: parks)
layer.sourceLayerIdentifier = "parks"
layer.fillColor = MGLStyleValue(rawValue: UIColor.green)
layer.predicate = NSPredicate(format: "type == %@", "national-park")
mapView.style.addLayer(layer)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.layer(withIdentifier: "parks"))
}
// MGLSymbolStyleLayer
func testMGLSymbolStyleLayerExample() {
let pois = MGLVectorSource(identifier: "pois", configurationURL: URL(string: "https://example.com/style.json")!)
mapView.style.addSource(pois)
/*---BEGIN EXAMPLE: MGLSymbolStyleLayer---*/
let layer = MGLSymbolStyleLayer(identifier: "coffeeshops", source: pois)
layer.sourceLayerIdentifier = "pois"
layer.iconImageName = MGLStyleValue(rawValue: "coffee")
layer.iconScale = MGLStyleValue(rawValue: 0.5)
layer.textField = MGLStyleValue(rawValue: "{name}")
layer.textTranslate = MGLStyleValue(rawValue: NSValue(cgVector: CGVector(dx: 10, dy: 0)))
layer.textJustification = MGLStyleValue(rawValue: NSValue(mglTextJustification: .left))
layer.textAnchor = MGLStyleValue(rawValue: NSValue(mglTextAnchor: .left))
layer.predicate = NSPredicate(format: "%K == %@", "venue-type", "coffee")
mapView.style.addLayer(layer)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.layer(withIdentifier: "coffeeshops"))
}
// MGLRasterStyleLayer
func testMGLRasterStyleLayer() {
let source = MGLRasterSource(identifier: "clouds", tileURLTemplates: ["https://example.com/raster-tiles/{z}/{x}/{y}.png"], options: [
.minimumZoomLevel: 9,
.maximumZoomLevel: 16,
.tileSize: 512,
.attributionInfos: [
MGLAttributionInfo(title: NSAttributedString(string: "© Mapbox"), url: URL(string: "http://mapbox.com"))
]
])
mapView.style.addSource(source)
/*---BEGIN EXAMPLE: MGLRasterStyleLayer---*/
let layer = MGLRasterStyleLayer(identifier: "clouds", source: source)
layer.rasterOpacity = MGLStyleValue(rawValue: 0.5)
mapView.style.addLayer(layer)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.layer(withIdentifier: "clouds"))
}
// MGLVectorStyleLayer.predicate
func testMGLVectorStyleLayer() {
let terrain = MGLVectorSource(identifier: "terrain", configurationURL: URL(string: "https://example.com/style.json")!)
mapView.style.addSource(terrain)
/*---BEGIN EXAMPLE: MGLVectorStyleLayer.predicate---*/
/**
To create a filter with the logic `(index == 10 || index == 5) && ele >= 200`,
you could create a predicate using `NSCompoundPredicate` along these lines:
*/
let layer = MGLLineStyleLayer(identifier: "contour", source: terrain)
layer.sourceLayerIdentifier = "contours"
layer.predicate = NSPredicate(format: "(index == 10 || index == 5) && ele >= 1500.0")
mapView.style.addLayer(layer)
/*---END EXAMPLE---*/
XCTAssertNotNil(mapView.style.layer(withIdentifier: "contour"))
}
}
|
