useLeafletScaleControl

A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems.

Demo

Usage

<script setup lang="ts">
import { ref } from 'vue';
import {
  useLeafletMap,
  useLeafletTileLayer,
  useLeafletDisplayControl,
  useLeafletDisplayLayer,
  useLeafletScaleControl
} from 'vue-use-leaflet';

const el = ref<HTMLElement | null>(null);
const map = useLeafletMap(el);
const tileLayer = useLeafletTileLayer(
  'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'
);
useLeafletDisplayLayer(map, tileLayer);

// create scale control
const scaleControl = useLeafletScaleControl();

// display scale control
useLeafletDisplayControl(map, scaleControl);
</script>

<template>
  <div ref="el" style="height: 250px"></div>
</template>

<script setup lang="ts">
import { ref } from 'vue';
import {
  useLeafletMap,
  useLeafletTileLayer,
  useLeafletDisplayControl,
  useLeafletDisplayLayer,
  useLeafletScaleControl
} from 'vue-use-leaflet';

const el = ref<HTMLElement | null>(null);
const map = useLeafletMap(el);
const tileLayer = useLeafletTileLayer(
  'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'
);
useLeafletDisplayLayer(map, tileLayer);

// create scale control
const scaleControl = useLeafletScaleControl();

// display scale control
useLeafletDisplayControl(map, scaleControl);
</script>

<template>
  <div ref="el" style="height: 250px"></div>
</template>

Type Declarations

export interface UseLeafletScaleControlOptions
  extends Omit<Control.ScaleOptions, 'position'> {
  position?: ControlPosition | string | undefined;
  factory?: (...args: any[]) => Control.Attribution;
  dispose?: boolean;
}
export type UseLeafletScaleControlReturn = Ref<Control.Scale | null>;
export declare function useLeafletScaleControl(
  options?: UseLeafletScaleControlOptions
): UseLeafletScaleControlReturn;

export interface UseLeafletScaleControlOptions
  extends Omit<Control.ScaleOptions, 'position'> {
  position?: ControlPosition | string | undefined;
  factory?: (...args: any[]) => Control.Attribution;
  dispose?: boolean;
}
export type UseLeafletScaleControlReturn = Ref<Control.Scale | null>;
export declare function useLeafletScaleControl(
  options?: UseLeafletScaleControlOptions
): UseLeafletScaleControlReturn;

Source

Source • Demo • Docs