Skip to content

ol-geolocation

HTML5 Geolocation wrapper

ol-geoloc provides HTML5 Geolocation capabilities as a Vue component. The Geolocation API is used to locate a user's position. You can place it to the default slot of ol-map component.

Demo

Setup

Plugin usage

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

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

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

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

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-geolocation><Map.OlGeoLocation>
vue
<template>
  <ol-map
    :loadTilesWhileAnimating="true"
    :loadTilesWhileInteracting="true"
    style="height: 400px"
    ref="map"
  >
    <ol-view
      ref="view"
      :center="center"
      :zoom="zoom"
      :projection="projection"
    />

    <ol-tile-layer>
      <ol-source-osm />
    </ol-tile-layer>

    <ol-geolocation :projection="projection" @change:position="geoLocChange">
      <template>
        <ol-vector-layer :zIndex="2">
          <ol-source-vector>
            <ol-feature ref="positionFeature">
              <ol-geom-point :coordinates="position"></ol-geom-point>
              <ol-style>
                <ol-style-icon :src="hereIcon" :scale="0.1"></ol-style-icon>
              </ol-style>
            </ol-feature>
          </ol-source-vector>
        </ol-vector-layer>
      </template>
    </ol-geolocation>
  </ol-map>
</template>

<script setup lang="ts">
import hereIcon from "@/assets/here.png";
import { ref } from "vue";
import type { View } from "ol";
import type { ObjectEvent } from "ol/Object";

const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(12);
const view = ref<View>();
const map = ref(null);
const position = ref([]);

const geoLocChange = (event: ObjectEvent) => {
  console.log("AAAAA", event);
  position.value = event.target.getPosition();
  view.value?.setCenter(event.target?.getPosition());
};
</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

None.

Events

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

html
<ol-geolocation :projection="projection" @change:position="geoLocChange" />

Methods

You have access to all Methods from the underlying OpenLayers Geolocation API. 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-geolocation :projection="projection" ref="geoLocRef" />
  <!-- ... -->
</template>

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

const geoLocRef = ref<{ geoLoc: Geolocation }>(null);

onMounted(() => {
  const geoLocation: Geolocation = geoLocRef.value?.geoLoc;
  // call your method on `geoLocation`
});
</script>