ol-context-menu-control

A contextmenu extension for OpenLayers.

Right click on the map to open the contextmenu.

• Demo
• Setup
  • Plugin usage
  • Explicit import
• Usage
• Properties
  • Props from OpenLayers
  • Deviating Properties
• Events
• Methods

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-context-menu-control>	<MapControls.OlContextMenuControl>

Add context menu to map

ContextMenuDemo.vue

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

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

    <ol-context-menu-control
      :items="contextMenuItems"
      @beforeopen="log('beforeopen', $event)"
      @open="log('open', $event)"
      @close="log('close', $event)"
      @add-menu-entry="log('add-menu-entry', $event)"
    />

    <ol-vector-layer>
      <ol-source-vector ref="markers"> </ol-source-vector>
      <ol-style>
        <ol-style-icon :src="marker" :scale="0.1"></ol-style-icon>
      </ol-style>
    </ol-vector-layer>
  </ol-map>
</template>

<script setup lang="ts">
import type { ContextMenuEvent, Item } from "ol-contextmenu";
import { ref } from "vue";
import { Feature, type View } from "ol";
import { Point } from "ol/geom";
import type VectorSource from "ol/source/Vector";

import marker from "@/assets/marker.png";

const contextMenuItems = ref<Item[]>([]);
const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(8);
const markers = ref<{ source: VectorSource } | null>(null);
const view = ref<View | null>(null);

contextMenuItems.value = [
  {
    text: "Center map here",
    classname: "some-style-class", // add some CSS rules
    callback: (val) => {
      view.value?.setCenter(val.coordinate);
    }, // `center` is your callback function
  },
  {
    text: "Add a Marker",
    classname: "some-style-class", // you can add this icon with a CSS class
    // instead of `icon` property (see next line)
    icon: marker, // this can be relative or absolute
    callback: (val) => {
      console.log(val);
      const feature = new Feature({
        geometry: new Point(val.coordinate),
      });
      markers.value?.source.addFeature(feature);
    },
  },
  "-", // this is a separator
];

function log(type: string, event: ContextMenuEvent) {
  console.log(type, event);
}
</script>

Properties

Props from OpenLayers

Properties are passed-trough from ol-contextmenu directly. Their types and default values can be checked-out in the official 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 control. Check out the official docs to see the available events tht will be fired.

<ol-videorecorder-control @error="handleEvent" />

Methods

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

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

<template>
  <!-- ... -->
  <ol-videorecorder-control ref="controlRef" @error="handleEvent" />
  <!-- ... -->
</template>

<script setup lang="ts">
import { ref, onMounted } from "vue";
import type ContextMenu from "ol-contextmenu";

const controlRef = ref<{ control: ContextMenu }>(null);

onMounted(() => {
  const contextmenu: ContextMenu = controlRef.value?.control;
  // call your method on `contextmenu`
});
</script>