vue3-openlayers

Appearance

ol-layer-switcher-control ​

A control for switching between layers.

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-layer-switcher-control><MapControls.OlLayerSwitcherControl>
vue
<template>
  <ol-map ref="mapRef" style="height: 400px" :controls="[]">
    <ol-view
      ref="view"
      :center="center"
      :zoom="zoom"
      :projection="projection"
    />

    <ol-tile-layer ref="jawgLayer" title="JAWG">
      <ol-source-xyz
        crossOrigin="anonymous"
        url="https://c.tile.jawg.io/jawg-dark/{z}/{x}/{y}.png?access-token=87PWIbRaZAGNmYDjlYsLkeTVJpQeCfl2Y61mcHopxXqSdxXExoTLEv7dwqBwSWuJ"
      />
    </ol-tile-layer>

    <ol-layer-group ref="layerGroup" title="Stadia Maps">
      <ol-tile-layer title="Stamen Watercolor">
        <ol-source-stadia-maps layer="stamen_watercolor" />
      </ol-tile-layer>
      <ol-tile-layer title="Stamen Terrain Labels">
        <ol-source-stadia-maps layer="stamen_terrain_labels" />
      </ol-tile-layer>
    </ol-layer-group>

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

    <ol-layer-switcher-control v-if="layerList.length > 0" />
  </ol-map>
</template>

<script setup lang="ts">
import { ref, onMounted } from "vue";
import type MapRef from "ol/Map";

const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(8);
const layerList = ref([]);
const jawgLayer = ref(null);
const layerGroup = ref(null);
const mapRef = ref<MapRef | null>(null);

onMounted(() => {
  layerList.value.push(jawgLayer.value.tileLayer);
  layerList.value.push(layerGroup.value.layerGroup);
});

onMounted(() => {
  console.log(mapRef.value.map.getLayers().getArray());
});
</script>

Properties ​

Please be sure to also check out the properties from ol-layer-group when you want to show grouped layers.

selection ​

enable layer selection when click on the title

  • Type: boolean

displayInLayerSwitcher ​

function that takes a layer and return a boolean if the layer is displayed in the switcher, default test the displayInLayerSwitcher layer attribute

  • Type: function

show_progress ​

show a progress bar on tile layers

  • Type: boolean
  • Default: false

mouseover ​

show the panel on mouseover

  • Type: boolean
  • Default: false

reordering ​

allow layer reordering

  • Type: boolean
  • Default: true

trash ​

add a trash button to delete the layer

  • Type: boolean
  • Default: false

oninfo ​

callback on click on info button, if none no info button is shown DEPRECATED: use on(info) instead

  • Type: function

extent ​

add an extent button to zoom to the extent of the layer

  • Type: boolean

onextent ​

callback when click on extent, default fits view to extent

  • Type: function

drawDelay ​

delay in ms to redraw the layer (usefull to prevent flickering when manipulating the layers)

  • Type: number

collapsed ​

collapse the layerswitcher at beginning

  • Type: boolean
  • Default: true

layerGroup ​

a layer group to display in the switcher, default display all layers of the map

  • Type: ol.layerGroup

noScroll ​

prevent handle scrolling

  • Type: boolean
  • Default: false

onchangeCheck ​

optional callback on click on checkbox, you can call this method for doing operations after check/uncheck a layer. Layers attributes that control the switcher.

  • allwaysOnTop {boolean} true to force layer stay on top of the others while reordering, default false

  • displayInLayerSwitcher {boolean} display the layer in switcher, default true

  • noSwitcherDelete {boolean} to prevent layer deletion (w. trash option = true), default false

  • Type: function