vue3-openlayers

Appearance

ol-layer-group ​

A Collection of layers that are handled together.

Demo ​

Setup ​

Plugin usage ​

This component is part of the Layers 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 Layers plugin
ts
import { createApp } from "vue";
import App from "./App.vue";

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

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

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 Layers.

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-group><Layers.OlLayerGroup>

The example below shows how you can apply common styles / behavior on multiple layers.

vue
<template>
  <form>
    <fieldset>
      <label for="opacity">Layer Opacity</label>
      <input
        type="range"
        id="opacity"
        min="0"
        max="1"
        step="0.1"
        v-model.number="opacity"
      />
      <span class="description">{{ opacity }}</span>
    </fieldset>
  </form>

  <ol-map style="height: 400px">
    <ol-view ref="view" :center="center" :zoom="zoom" />
    <ol-layer-group :opacity="opacity">
      <ol-tile-layer>
        <ol-source-tile-wms
          url="https://ahocevar.com/geoserver/wms"
          :extent="[-13884991, 2870341, -7455066, 6338219]"
          layers="topp:states"
          serverType="geoserver"
          :transition="0"
          :params="{}"
        />
      </ol-tile-layer>
      <ol-tile-layer>
        <ol-source-tile-json
          url="https://maps.gnosis.earth/ogcapi/collections/NaturalEarth:raster:HYP_HR_SR_OB_DR/map/tiles/WebMercatorQuad?f=tilejson"
          crossOrigin="anonymous"
        />
      </ol-tile-layer>
    </ol-layer-group>
  </ol-map>
</template>

<script setup lang="ts">
import { ref } from "vue";

const zoom = ref(4);
const center = ref([-10997148, 4569099]);
const opacity = ref(0.4);
</script>

Properties ​

Props from OpenLayers ​

Properties are passed-trough from OpenLayers directly. Their types and default values can be checked-out in the official OpenLayers docs. Only some properties deviate caused by reserved keywords from Vue / HTML. This deviating props are described in the section below.

Deviating Properties ​

title ​

  • Type: String

You can add a title to the group. This is relevant if you want the group for example to appear in the ol-layerswitcher-control.

openInLayerSwitcher ​

  • Type: Boolean

Setting this property, will result in expanded layers within the group in ol-layerswitcher-control.

Events ​

You have access to all Events from the underlying source. Check out the official OpenLayers docs to see the available events tht will be fired.

html
<ol-layer-group :opacity="0.2" @error="handleEvent">
  <!-- ... -->
</ol-layer-group>

Methods ​

You have access to all Methods from the underlying source. Check out the official OpenLayers docs to see the available methods.

To access the source, you can use a ref() as shown below:

vue
<template>
  <!-- ... -->
  <ol-layer-group :opacity="0.2" ref="layerGroupRef">
    <!-- ... -->
  </ol-layer-group>
  <!-- ... -->
</template>

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

const layerGroupRef = ref<{ layerGroup: LayerGroup }>(null);

onMounted(() => {
  const layerGroup: LayerGroup = sourceRef.layerGroup;
  // call your method on `layerGroup`
});
</script>