vue3-openlayers

Appearance

ol-swipe-control ​

A Swipe control for OpenLayers.

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
ts
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 UsageExplicit Import
<ol-swipe-control><MapControls.OlSwipeControl>
vue
<template>
  <ol-map ref="map" style="height: 400px" :controls="[]">
    <ol-view
      ref="view"
      :center="center"
      :zoom="zoom"
      :projection="projection"
    />

    <ol-tile-layer ref="stadiaLayer" title="Stamen Watercolor">
      <ol-source-stadia-maps layer="stamen_watercolor" />
    </ol-tile-layer>

    <ol-tile-layer ref="osmLayer" title="OSM">
      <ol-source-osm />
    </ol-tile-layer>

    <ol-swipe-control
      v-if="stadiaLayer && osmLayer"
      :layers="[osmLayer.tileLayer]"
      :right-layers="[stadiaLayer.tileLayer]"
    />
  </ol-map>
</template>

<script setup lang="ts">
import { ref } from "vue";
import type TileLayer from "ol/layer/Tile";
const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(8);
const osmLayer = ref<{ tileLayer: TileLayer } | null>(null);
const stadiaLayer = ref<{ tileLayer: TileLayer } | null>(null);
</script>

Properties ​

layers ​

Layers that should be rendered on the left (or top depending on the orientation) of the slider.

  • Type: Array<Layer>

rightLayers ​

Layers that should be rendered on the right (or bottom depending on the orientation) of the slider.

  • Type: Array<Layer>

className ​

  • Type: String

position ​

  • Type: Number
  • Default: 0.5

orientation ​

  • Type: String
  • Default: vertical