Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukasmartinelli/mapbox-gl-inspect
Inspection plugin for Mapbox GL JS
https://github.com/lukasmartinelli/mapbox-gl-inspect
Last synced: 28 days ago
JSON representation
Inspection plugin for Mapbox GL JS
- Host: GitHub
- URL: https://github.com/lukasmartinelli/mapbox-gl-inspect
- Owner: lukasmartinelli
- License: bsd-3-clause
- Created: 2017-01-04T21:14:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-08T10:54:24.000Z (over 4 years ago)
- Last Synced: 2024-10-28T12:39:16.512Z (about 2 months ago)
- Language: JavaScript
- Homepage: http://mapbox-gl-inspect.lukasmartinelli.ch/
- Size: 308 KB
- Stars: 142
- Watchers: 12
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vector-tiles - mapbox-gl-inspect - Plugin for Mapbox GL JS to view the view and inspect VT features. (Applications / Command line tools)
README
# Mapbox GL Inspect [](https://travis-ci.org/lukasmartinelli/mapbox-gl-inspect)
Add an inspect control to [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) to view all features
of the vector sources and allows hovering over features to see their properties.
**Requires [mapbox-gl-js](https://github.com/mapbox/mapbox-gl-js) (version 0.29.0 – 0.31.x).**
## Usage
**mapbox-gl-inspect** is a [Mapbox GL JS plugin](https://www.mapbox.com/blog/build-mapbox-gl-js-plugins/) that you can easily add on top of your map. Check `index.html` for a complete example.
Make sure to include the CSS and JS files.
**When using a CDN**
```html
```
**When using modules**
```js
require('mapbox-gl-inspect/dist/mapbox-gl-inspect.css');
var mapboxgl = require('mapbox-gl');
var MapboxInspect = require('mapbox-gl-inspect');
// Pass an initialized popup to Mapbox GL
map.addControl(new MapboxInspect({
popup: new mapboxgl.Popup({
closeButton: false,
closeOnClick: false
})
}));
```
### Add Inspect Control
Add the inspect control to your map.
```javascript
map.addControl(new MapboxInspect());
```
### Show Inspection Map
Switch to the inspection map by default.
```javascript
map.addControl(new MapboxInspect({
showInspectMap: true
}));
```
### Show only Inspection Mode
Switch to the inspection map by default and hide the inspect button to switch back to the normal map. Check [`examples/inspect-only.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/inspect-only.html).
```javascript
map.addControl(new MapboxInspect({
showInspectMap: true,
showInspectButton: false
}));
```
### Disable Popup
Disable the feature Popup in inspection mode and in map mode. Check [`examples/no-popup.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/no-popup.html).
```javascript
map.addControl(new MapboxInspect({
showInspectMapPopup: false,
showMapPopup: false
}));
```
### Custom Popup Function
You can also control the Popup output. Check [`examples/custom-popup.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/custom-popup.html).
```javascript
map.addControl(new MapboxInspect({
renderPopup: function(features) {
return '
' + features.length + '
';
}
}));
```
### Custom Color Function
You are able to control the generated colors and background of the inspection style.
Check [`examples/custom-color-1.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/custom-color-1.html) and [`examples/custom-color-2.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/custom-color-2.html).
```javascript
var colors = ['#FC49A3', '#CC66FF', '#66CCFF', '#66FFCC'];
map.addControl(new MapboxInspect({
backgroundColor: '#000',
assignLayerColor: function(layerId, alpha) {
var randomNumber = parseInt(Math.random() * colors.length);
return colors[randomNumber];
}
}));
```
### Show just Popup but no Inspect Style
You can also hide the inspect button and enable the popup on the map if just want the popup hovering feature in your normal map but no inspect style.
Check [`examples/no-inspect-style.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/no-inspect-style.html).
```js
map.addControl(new MapboxInspect({
showInspectButton: false,
showMapPopup: true
}));
```
### Show Popup only for certain Features
You can pass a `queryParameters` object structured like the parameters object documented for [`map.queryRenderedFeatures`](https://www.mapbox.com/mapbox-gl-js/api/#Map#queryRenderedFeatures).
This let's you show the inspect popup for only certain layers.
Check [`examples/query-params.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/query-params.html).
```js
map.addControl(new MapboxInspect({
queryParameters: {
layers: ['composite_road_line']
}
}));
```
You can also use this feature to do custom layer [filtering](https://www.mapbox.com/mapbox-gl-style-spec/#types-filter).
```js
map.addControl(new MapboxInspect({
queryParameters: {
filter: ['>', 'height', 10]
}
}));
```
### Less Fidly Popup
If inspecting features is too fiddly for thin lines you can optionally set a custom pixel buffer around the pointer when querying for features to make inspection a bit more forgiving.
Check [`examples/less-fidly.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/less-fidly.html).
```js
map.addControl(new MapboxInspect({
selectThreshold: 50
});
```
### Show Popup only on Click not on Hovering
Do not show the inspect popup when hovering over the map but only when clicking on the map.
Check [`examples/popup-on-click.html`](http://mapbox-gl-inspect.lukasmartinelli.ch/examples/popup-on-click.html).
```js
map.addControl(new MapboxInspect({
showMapPopup: true,
showMapPopupOnHover: false,
showInspectMapPopupOnHover: false
});
```
## Develop
Run the linter and watch for changes to rebuild with browserify.
```
npm install
npm run test
npm run watch
```
Create a minified standalone build.
```
npm install
npm run build
```