Skip to main content

ScaleControl

React component that wraps the base library's ScaleControl class.

import * as React from 'react';
import {Map, ScaleControl} from '@vis.gl/react-maplibre';
import 'maplibre-gl/dist/maplibre-gl.css';

function App() {
  return <Map
    initialViewState={{
      longitude: -100,
      latitude: 40,
      zoom: 3.5
    }}
    mapStyle="https://demotiles.maplibre.org/style.json"
  >
    <ScaleControl />
  </Map>;
}

Properties​

Reactive Properties​

maxWidth: string​

Default: 100

The maximum length of the scale control in pixels.

style: CSSProperties​

CSS style override that applies to the control's container.

unit: 'imperial' | 'metric' | 'nautical'​

Default: 'metric'

Unit of the distance.

Other Properties​

The properties in this section are not reactive. They are only used when the component first mounts.

position: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'​

Default: 'top-right'

Placement of the control relative to the map.

Source​

scale-control.ts