mirror of
https://github.com/visgl/react-map-gl.git
synced 2026-01-18 15:54:22 +00:00
46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
# Scale Control
|
|
|
|
|
|
|
|
This is a React equivalent of Mapbox's [ScaleControl](https://docs.mapbox.com/mapbox-gl-js/api/#scalecontrol).
|
|
|
|
```js
|
|
import {Component} from 'react';
|
|
import ReactMapGL, {ScaleControl} from 'react-map-gl';
|
|
|
|
class Map extends Component {
|
|
render() {
|
|
const {viewport, updateViewport} = this.props;
|
|
return (
|
|
<ReactMapGL {...viewport} onViewportChange={updateViewport}>
|
|
<div style={{position: 'absolute', bottom: 100, left: 20}}>
|
|
<ScaleControl maxWidth={100} unit={"metric"}/>
|
|
</div>
|
|
</ReactMapGL>
|
|
);
|
|
}
|
|
}
|
|
```
|
|
|
|
## Properties
|
|
|
|
##### `maxWidth` (Number)
|
|
|
|
- default: `100`
|
|
|
|
The maximum length of the scale control in pixels.
|
|
|
|
##### `unit` (String)
|
|
|
|
- default: `'metric'`
|
|
|
|
Unit of the distance, one of `'imperial'`, `'metric'` or `'nautical'`.
|
|
|
|
## Styling
|
|
|
|
Like its Mapbox counterpart, this control relies on the mapbox-gl stylesheet to work properly. Make sure to add the stylesheet to your page.
|
|
|
|
## Source
|
|
|
|
[scale-control.js](https://github.com/visgl/react-map-gl/tree/6.0-release/src/components/scale-control.js)
|