mapboxgl 0.7.0

Unofficial Rust binding for mapbox-gl-js
Documentation 
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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365

// Because of https://github.com/rustwasm/wasm-bindgen/issues/3945 we need to allow this lint for now
#![allow(clippy::empty_docs)]

use wasm_bindgen::prelude::*;

#[wasm_bindgen]
extern "C" {
    pub type LngLat;

    #[wasm_bindgen(constructor, js_namespace = mapboxgl)]
    pub fn new(lng: f64, lat: f64) -> LngLat;

    #[wasm_bindgen(method, getter)]
    pub fn lng(this: &LngLat) -> f64;

    #[wasm_bindgen(method, setter)]
    pub fn set_lng(this: &LngLat, v: f64) -> LngLat;

    #[wasm_bindgen(method, getter)]
    pub fn lat(this: &LngLat) -> f64;

    #[wasm_bindgen(method, setter)]
    pub fn set_lat(this: &LngLat, v: f64) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn wrap(this: &LngLat) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn toArray(this: &LngLat) -> Vec<f64>;

    #[wasm_bindgen(method)]
    pub fn toString(this: &LngLat) -> String;

    #[wasm_bindgen(method)]
    pub fn distanceTo(this: &LngLat, lngLat: &LngLat) -> f64;

    #[wasm_bindgen(method)]
    pub fn toBounds(this: &LngLat, radius: f64) -> LngLatBounds;

    // --

    pub type LngLatBounds;

    #[wasm_bindgen(constructor, js_namespace = mapboxgl)]
    pub fn new(sw: LngLat, ne: LngLat) -> LngLatBounds;

    #[wasm_bindgen(method)]
    pub fn setNorthEast(this: &LngLatBounds, ne: LngLat) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn setSouthWest(this: &LngLatBounds, sw: LngLat) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn getCenter(this: &LngLatBounds) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn getSouthWest(this: &LngLatBounds) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn getNorthEast(this: &LngLatBounds) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn getNorthWest(this: &LngLatBounds) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn getSouthEast(this: &LngLatBounds) -> LngLat;

    #[wasm_bindgen(method)]
    pub fn getWest(this: &LngLatBounds) -> f64;

    #[wasm_bindgen(method)]
    pub fn getSouth(this: &LngLatBounds) -> f64;

    #[wasm_bindgen(method)]
    pub fn getEast(this: &LngLatBounds) -> f64;

    #[wasm_bindgen(method)]
    pub fn getNorth(this: &LngLatBounds) -> f64;

    #[wasm_bindgen(method)]
    pub fn isEmpty(this: &LngLatBounds) -> f64;

    #[wasm_bindgen(method)]
    pub fn contains(this: &LngLat) -> bool;

    #[wasm_bindgen(method)]
    pub fn toString(this: &LngLatBounds) -> String;

    // --

    pub type Map;

    #[wasm_bindgen(constructor, js_namespace = mapboxgl)]
    pub fn new(options: JsValue) -> Map;

    #[wasm_bindgen(method)]
    pub fn getBounds(this: &Map) -> LngLatBounds;

    #[wasm_bindgen(method)]
    pub fn getZoom(this: &Map) -> f64;

    #[wasm_bindgen(method)]
    pub fn jumpTo(this: &Map, options: JsValue);

    #[wasm_bindgen(method)]
    pub fn easeTo(this: &Map, options: JsValue);

    #[wasm_bindgen(method)]
    pub fn flyTo(this: &Map, options: JsValue, eventData: JsValue);

    #[wasm_bindgen(method)]
    pub fn on(this: &Map, r#type: String, callback: &Closure<dyn Fn(JsValue)>);

    #[wasm_bindgen(method, js_name=on)]
    pub fn on_layer(
        this: &Map,
        r#type: String,
        layer_id: String,
        callback: &Closure<dyn Fn(JsValue)>,
    );

    #[wasm_bindgen(method)]
    pub fn getContainer(this: &Map) -> web_sys::HtmlElement;

    #[wasm_bindgen(method)]
    pub fn getMinZoom(this: &Map) -> f64;

    #[wasm_bindgen(method)]
    pub fn isMoving(this: &Map) -> bool;

    #[wasm_bindgen(method)]
    pub fn isZooming(this: &Map) -> bool;

    #[wasm_bindgen(method)]
    pub fn isRotating(this: &Map) -> bool;

    #[wasm_bindgen(method)]
    pub fn setStyle(this: &Map, style: JsValue, options: JsValue) -> bool;

    #[wasm_bindgen(method)]
    pub fn getStyle(this: &Map) -> JsValue;

    // Images

    /// Add image resource.
    /// https://docs.mapbox.com/mapbox-gl-js/api/map/#map#addimage
    #[wasm_bindgen(method)]
    pub fn addImage(this: &Map, id: String, image: JsValue, options: JsValue);

    /// Update an existing image in a style.
    /// https://docs.mapbox.com/mapbox-gl-js/api/map/#map#loadimage
    #[wasm_bindgen(method)]
    pub fn updateImage(this: &Map, id: String, image: JsValue) -> bool;

    /// Check whether or not an image with a specific ID exists in the style.
    /// https://docs.mapbox.com/mapbox-gl-js/api/map/#map#updateimage
    #[wasm_bindgen(method)]
    pub fn hasImage(this: &Map, id: String) -> bool;

    /// Remove an image from a style.
    /// https://docs.mapbox.com/mapbox-gl-js/api/map/#map#removeimage
    #[wasm_bindgen(method)]
    pub fn removeImage(this: &Map, id: String);

    /// Load an image from an external URL.
    /// https://docs.mapbox.com/mapbox-gl-js/api/map/#map#loadimage
    #[wasm_bindgen(method)]
    pub fn loadImage(this: &Map, url: String, callback: &Closure<dyn FnMut(JsValue, JsValue)>);

    /// Returns an Array of strings containing the IDs of all images currently available in the
    /// map.
    /// https://docs.mapbox.com/mapbox-gl-js/api/map/#map#listimages
    #[wasm_bindgen(method)]
    pub fn listImages(this: &Map) -> JsValue;

    // Lifecycle
    #[wasm_bindgen(method)]
    pub fn loaded(this: &Map) -> bool;

    #[wasm_bindgen(method)]
    pub fn remove(this: &Map);

    #[wasm_bindgen(method)]
    pub fn triggerRepaint(this: &Map);

    // Querying features
    #[wasm_bindgen(method)]
    pub fn queryRenderedFeatures(map: &Map, geometry: JsValue, options: JsValue) -> JsValue;

    // Sources
    #[wasm_bindgen(method)]
    pub fn addSource(this: &Map, id: String, source: JsValue);

    #[wasm_bindgen(method)]
    pub fn isSourceLoaded(this: &Map, id: String) -> bool;

    #[wasm_bindgen(method)]
    pub fn areTilesLoaded(this: &Map) -> bool;

    #[wasm_bindgen(method)]
    pub fn removeSource(this: &Map, id: String);

    #[wasm_bindgen(method)]
    pub fn getSource(this: &Map, id: String) -> JsValue;

    // Layer
    #[wasm_bindgen(method)]
    pub fn addLayer(this: &Map, value: JsValue, before_id: Option<String>);

    #[wasm_bindgen(method)]
    pub fn getSlot(this: &Map, id: String) -> Option<String>;

    #[wasm_bindgen(method)]
    pub fn setSlot(this: &Map, id: String, slot: String) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn moveLayer(this: &Map, id: String, before_id: Option<String>) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn removeLayer(this: &Map, id: String) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn getLayer(this: &Map, id: String) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn setLayerZoomRange(this: &Map, id: String, min_zoom: f64, max_zoom: f64) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn setFilter(this: &Map, id: String, filter: JsValue, options: JsValue) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn getFilter(this: &Map, id: String) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn setPaintProperty(
        this: &Map,
        id: String,
        name: String,
        value: JsValue,
        options: JsValue,
    ) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn getPaintProperty(this: &Map, id: String, name: String) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn setLayoutProperty(
        this: &Map,
        id: String,
        name: String,
        value: JsValue,
        options: JsValue,
    ) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn getLayoutProperty(this: &Map, id: String, name: String) -> JsValue;

    // Debug Features
    #[wasm_bindgen(method, setter)]
    pub fn set_showTileBoundaries(this: &Map, v: bool) -> Map;

    #[wasm_bindgen(method, getter)]
    pub fn showTileBoundaries(this: &Map) -> bool;

    #[wasm_bindgen(method, setter)]
    pub fn set_showTerrainWireframe(this: &Map, v: bool) -> Map;

    #[wasm_bindgen(method, getter)]
    pub fn showTerrainWireframe(this: &Map) -> bool;

    #[wasm_bindgen(method, setter)]
    pub fn set_showPadding(this: &Map, v: bool) -> Map;

    #[wasm_bindgen(method, getter)]
    pub fn showPadding(this: &Map) -> bool;

    #[wasm_bindgen(method, setter)]
    pub fn set_showCollisionBoxes(this: &Map, v: bool) -> Map;

    #[wasm_bindgen(method, getter)]
    pub fn showCollisionBoxes(this: &Map) -> bool;

    #[wasm_bindgen(method, structural, indexing_getter)]
    pub fn get_handler(this: &Map, name: &str) -> JsValue;

    #[wasm_bindgen(method, structural, indexing_setter)]
    pub fn set_handler(this: &Map, name: &str, handler: BoxZoomHandler) -> JsValue;

    #[wasm_bindgen(method)]
    pub fn panTo(this: &Map, lngLat: &LngLat, options: JsValue, eventData: JsValue);

    // Camera
    #[wasm_bindgen(method)]
    pub fn getCenter(this: &Map) -> LngLat;

    // --

    pub type BoxZoomHandler;

    #[wasm_bindgen(constructor, js_namespace = mapboxgl)]
    pub fn BoxZoomHandler_new(map: &Map, options: JsValue) -> BoxZoomHandler;

    #[wasm_bindgen(method, js_name=enable)]
    pub fn BoxZoomHandler_enable(this: &BoxZoomHandler);

    #[wasm_bindgen(method, js_name=disable)]
    pub fn BoxZoomHandler_disable(this: &BoxZoomHandler);

    #[wasm_bindgen(method, js_name=isEnabled)]
    pub fn BoxZoomHandler_isEnabled(this: &BoxZoomHandler) -> bool;

    #[wasm_bindgen(method, js_name=isActive)]
    pub fn BoxZoomHandler_isActive(this: &BoxZoomHandler) -> bool;

    #[wasm_bindgen(method, js_name=disableRotation)]
    pub fn BoxZoomHandler_disableRotation(this: &BoxZoomHandler);

    #[wasm_bindgen(method, js_name=enableRotation)]
    pub fn BoxZoomHandler_enableRotation(this: &BoxZoomHandler);

    // --

    pub type Marker;

    #[wasm_bindgen(constructor, js_namespace = mapboxgl)]
    pub fn maker_new(options: JsValue) -> Marker;

    #[wasm_bindgen(method)]
    pub fn setLngLat(this: &Marker, lngLat: &LngLat);

    #[wasm_bindgen(method)]
    pub fn addTo(this: &Marker, map: &Map);

    #[wasm_bindgen(method)]
    pub fn remove(this: &Marker);

    #[wasm_bindgen(method, js_name=on)]
    pub fn Marker_on(this: &Marker, r#type: String, callback: &Closure<dyn Fn(JsValue)>);

    #[wasm_bindgen(method)]
    pub fn getLngLat(this: &Marker) -> LngLat;

    // --

    pub type Popup;

    #[wasm_bindgen(constructor, js_namespace = mapboxgl)]
    pub fn Popup_new(options: JsValue) -> Popup;

    #[wasm_bindgen(method, js_name=setHTML)]
    pub fn Popup_setHTML(this: &Popup, html: String);

    #[wasm_bindgen(method, js_name=setLngLat)]
    pub fn Popup_setLngLat(this: &Popup, lngLat: &LngLat);

    #[wasm_bindgen(method, js_name=addTo)]
    pub fn Popup_addTo(this: &Popup, map: &Map);

    // --

    pub type GeoJSONSource;

    #[wasm_bindgen(method, js_name=setData)]
    pub fn GeoJSONSource_setData(this: &GeoJSONSource, data: &JsValue);
}