Scale Bar Plugin

Displays the current map scale. The scale bar automatically updates as the user zooms in and out.

Usage

Copy
import createScaleBarPlugin from '@defra/interactive-map/plugins/scale-bar'

const scaleBarPlugin = createScaleBarPlugin({
  units: 'metric'
})

const interactiveMap = new InteractiveMap({
  plugins: [scaleBarPlugin]
})

Options

Options are passed to the factory function when creating the plugin.

units

Type:

'metric' | 'imperial'

Default:

'metric'

The unit system used to display the scale.

Copy
createScaleBarPlugin({ units: 'imperial' })

Methods

This plugin does not expose any public methods.

Events

This plugin does not emit any custom events.