ol-scaleline-control

A Scale Line control for OpenLayers.

• Demo
• Setup
  • Plugin usage
  • Explicit import
• Usage
• Properties
  • className
  • minWidth
  • render
  • target
  • units
  • bar
  • steps
  • text
  • dpi

Demo

Setup

Plugin usage

This component is part of the MapControls plugin. If not installed globally, you need to import and use the plugin in your main.ts or use the explicit component import (see section below).

Import and use the MapControls plugin

import { createApp } from "vue";
import App from "./App.vue";

import {
  Map,
  Layers,
  Sources,
  MapControls,
} from "vue3-openlayers";

const app = createApp(App);
// ...
app.use(MapControls); 
// ...

Explicit import

If you don't want to install a plugin, you can import the component explicitly. It's available as a child of the named export MapControls.

NOTE

The following documentation refers to the plugin usage. Please make sure to adopt the component names, when you decided to use explicit component imports (e. g. <ol-map> becomes <Map.OlMap> etc.).

Usage

Plugin Usage	Explicit Import
<ol-scaleline-control>	<MapControls.OlScalelineControl>

ScalelineControlDemo.vue

<template>
  <ol-map style="height: 400px" :controls="[]">
    <ol-view :center="center" :zoom="zoom" :projection="projection" />

    <ol-tile-layer>
      <ol-source-osm />
    </ol-tile-layer>
    <ol-scaleline-control />
  </ol-map>
</template>

<script setup>
import { ref } from "vue";
const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(8);
</script>

Properties

className

• Type: String
• Default: ol-scale-line

minWidth

• Type: Number
• Default: 64

render

• Type: Function

target

• Type: HTMLElement

units

• Type: String
• Default: metric

bar

• Type: Boolean
• Default: false

steps

• Type: Number
• Default: 4

text

• Type: Boolean
• Default: false

dpi

• Type: Number
• Default: undefined