/
pmtiles.R
341 lines (314 loc) · 7.42 KB
/
pmtiles.R
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
#' Add vector tiles stored as PMTiles in an AWS S3 bucket to a leaflet map.
#'
#' @details
#' These functions can be used to add cloud optimized vector tiles data in
#' the `.pmtiles` format stored in an Amazon Web Services (AWS) S3 bucket to a
#' leaflet map. For instructions on how to create these files, see
#' \url{https://github.com/protomaps/PMTiles}.
#'
#' NOTE: You may not see the tiles rendered in the RStudio viewer pane. Make
#' sure to open the map in a browser.
#'
#' @param map the map to add to.
#' @param url the url to the tiles to be served.
#' @param style styling for the layer. See \link{paintRules} for details.
#' @param layerId the layer id.
#' @param group group name.
#' @param pane the map pane to which the layer should be added. See
#' [leaflet](addMapPane) for details.
#' @param attribution optional attribution character string.
#'
#' @examples
#' ## PMPolygons
#' library(leaflet)
#' library(leafem)
#'
#' url_nzb = "https://vector-tiles-data.s3.eu-central-1.amazonaws.com/nz-building-outlines.pmtiles"
#'
#' leaflet() %>%
#' addTiles() %>%
#' addPMPolygons(
#' url = url_nzb
#' , layerId = "nzbuildings"
#' , group = "nzbuildings"
#' , style = paintRules(
#' layer = "nz-building-outlines"
#' , fillColor = "pink"
#' , stroke = "green"
#' )
#' ) %>%
#' setView(173.50, -40.80, 6)
#'
#' @name addPMPolygons
#' @export addPMPolygons
addPMPolygons = function(
map
, url
, style
, layerId = NULL
, group = NULL
, pane = "overlayPane"
, attribution = NULL
) {
if (length(style) == 0) {
stop(
"need at least one paint rule set to know which layer to visualise"
, call. = FALSE
)
}
map$dependencies <- c(
map$dependencies
, leafletPMTilesDependencies()
, fgbDependencies()
, chromaJsDependencies()
)
leaflet::invokeMethod(
map
, data = leaflet::getMapData(map)
, method = "addPMPolygons"
# , paste0(path_layer, "/", basename(file))
, url
, layerId
, group
, style
, pane
, attribution
)
}
#' Add point data stored as PMTiles
#'
#' @examples
#' ## PMPoints
#' library(leaflet)
#' library(leafem)
#'
#' url_depoints = "https://vector-tiles-data.s3.eu-central-1.amazonaws.com/depoints.pmtiles"
#'
#' leaflet() %>%
#' addTiles() %>%
#' addPMPoints(
#' url = url_depoints
#' , layerId = "depoints"
#' , group = "depoints"
#' , style = paintRules(
#' layer = "depoints"
#' , fillColor = "black"
#' , stroke = "white"
#' , radius = 4
#' )
#' ) %>%
#' setView(10, 51, 6)
#'
#' @describeIn addPMPolygons add points stored as PMTiles
#' @export
addPMPoints = function(
map
, url
, style
, layerId = NULL
, group = NULL
, pane = "overlayPane"
, attribution = NULL
) {
if (length(style) == 0) {
stop(
"need at least one paint rule set to know which layer to visualise"
, call. = FALSE
)
}
map$dependencies <- c(
map$dependencies
, leafletPMTilesDependencies()
, fgbDependencies()
, chromaJsDependencies()
)
leaflet::invokeMethod(
map
, data = leaflet::getMapData(map)
, method = "addPMPoints"
# , paste0(path_layer, "/", basename(file))
, url
, layerId
, group
, style
, pane
, attribution
)
}
#' Add polylines stored as PMTiles
#'
#' @examples
#' ## PMPolylines
#' library(leaflet)
#' library(leafem)
#'
#' url_rivers = "https://vector-tiles-data.s3.eu-central-1.amazonaws.com/rivers_africa.pmtiles"
#'
#' ## NOTE: these will only render until a zoom level of 7!!
#' leaflet() %>%
#' addTiles() %>%
#' addPMPolylines(
#' url = url_rivers
#' , layerId = "rivers"
#' , group = "rivers"
#' , style = paintRules(
#' layer = "rivers_africa"
#' , color = "blue"
#' )
#' ) %>%
#' setView(24, 2.5, 4)
#'
#' @describeIn addPMPolygons add ploylines stored as PMTiles
#' @export
addPMPolylines = function(
map
, url
, style
, layerId = NULL
, group = NULL
, pane = "overlayPane"
, attribution = NULL
) {
if (length(style) == 0) {
stop(
"need at least one paint rule set to know which layer to visualise"
, call. = FALSE
)
}
map$dependencies <- c(
map$dependencies
, leafletPMTilesDependencies()
, fgbDependencies()
, chromaJsDependencies()
)
leaflet::invokeMethod(
map
, data = leaflet::getMapData(map)
, method = "addPMPolylines"
# , paste0(path_layer, "/", basename(file))
, url
, layerId
, group
, style
, pane
, attribution
)
}
#' Styling options for PMTiles
#'
#' @param layer the name of the layer in the PMTiles file to visualise.
#' @param fillColor fill color for polygons
#' @param color line color
#' @param do_stroke logical, whether polygon borders should be drawn
#' @param width line width
#' @param radius point radius
#' @param stroke color point border
#' @param opacity point opacity
#' @param dash either `NULL` (default) for a solid line or a numeric vector
#' of length 2 denoting segment length and spce between segments (in pixels),
#' e.g. `c(5, 3)`
#'
#' @export
paintRules = function(
layer
, fillColor = "#0033ff66"
, color = "#0033ffcc"
, do_stroke = TRUE
, width = 0.5
, radius = 3
, stroke = "#000000"
, opacity = 1
, dash = NULL
) {
if (missing(layer)) {
stop(
"need a layer specification to know what to draw"
, call. = FALSE
)
}
list(
layer = layer
, fillColor = fillColor
, color = color
, do_stroke = do_stroke
, width = width
, radius = radius
, stroke = stroke
, opacity = opacity
, dash = dash
)
}
leafletPMTilesDependencies = function() {
list(
htmltools::htmlDependency(
"PMTiles",
'0.0.1',
system.file("htmlwidgets/lib/protomaps", package = "leafem"),
script = list(
src = c(
"protomap-binding.js"
)
, crossorigin = "anonymous"
)
)
, htmltools::htmlDependency(
"protomaps",
'0.0.1',
system.file("htmlwidgets/lib/protomaps", package = "leafem"),
script = list(
src = c(
"protomaps.min.js"
)
, crossorigin = "anonymous"
)
)
)
}
addMBTiles = function(map, file, layerId = NULL, group = NULL) {
if (!is.null(file)) {
if (!file.exists(file)) {
stop(
sprintf(
"file %s does not seem to exist"
, file
)
, call. = FALSE
)
}
path_layer = tempfile()
dir.create(path_layer)
path_layer = paste0(path_layer, "/", layerId, "_layer.mbtiles")
# path_layer = paste0(path_layer, "/", layerId)
# dir.create(path_layer)
file.copy(file, path_layer, overwrite = TRUE)
# file.copy(file, path_layer, overwrite = TRUE, recursive = TRUE)
}
map$dependencies <- c(
map$dependencies
, leafletMBTilesDependencies()
, fileAttachment(path_layer, layerId)
)
leaflet::invokeMethod(
map
, data = leaflet::getMapData(map)
, method = "addMBTiles"
# , paste0(path_layer, "/", basename(file))
, path_layer
, layerId
, group
)
}
leafletMBTilesDependencies = function() {
list(
htmltools::htmlDependency(
"MBTiles",
'0.0.1',
system.file("htmlwidgets/lib/protomaps", package = "leafem"),
script = c(
"mbtiles-binding.js"
, "Leaflet.TileLayer.MBTiles.js"
, "https://unpkg.com/sql.js@0.3.2/js/sql.js"
)
)
)
}