ol-map ​

The core component of vue3-openlayers

This is the main container for all other vue3-openlayers components and has one default slot to place them all. Usually you will use it together with ol-view component to setup zoom, center, projection and other view related propeties for the map.

Usage ​

Example of a simple map. See also documentation of ol-view component.

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

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

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

const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(8);
const rotation = ref(0);
</script>

Properties ​

loadTilesWhileAnimating ​

• Type: boolean
• Default: false

When set to true, tiles will be loaded during animations.

loadTilesWhileInteracting ​

• Type: boolean
• Default: false

When set to true, tiles will be loaded while interacting with the map.

moveTolerance ​

• Type: number
• Default: 1

The minimum distance in pixels the cursor must move to be detected as a map move event instead of a click. Increasing this value can make it easier to click on the map.

pixelRatio ​

• Type: number
• Default: 1

The ratio between physical pixels and device-independent pixels (dips) on the device.

Events ​

Pointer events that emits ol.MapBrowserEvent

• click
• dblclick
• singleclick
• pointerdrag
• pointermove

Other events that emit ol.MapEvent

• movestart
• moveend
• postrender
• precompose
• postcompose

Methods ​

focus() ​

Triggers focus on map container.

forEachFeatureAtPixel(pixel, callback, options = {}) ​

• Arguments:
  • pixel {number[]}
  • callback {function(ol.Feature, ?ol.layer.Layer): *} Feature callback. The callback will be called with two arguments: OpenLayers feature at the pixel and layer of the feature (will be null for unmanaged layers). To stop detection, callback functions can return a truthy value.
  • [options] {Object | undefined}
    • layerFilter {function(ol.layer.Layer): boolean} Layer filter function.
    • hitTolerance {number | undefined} Hit-detection tolerance in pixels. Default is 0.
• Returns: * Truthy value returned from the callback.

Detect features that intersect a pixel on the viewport, and execute a callback with each intersecting feature. Layers included in the detection can be configured through the layerFilter option in options.

getCoordinateFromPixel(pixel) ​

• Arguments:
  • pixel {number[]}
• Returns: number[] Coordinates of the pixel in map view projection.

Get the coordinate for a given pixel.

refresh() ​

• Returns: {Promise<void>}

Updates map size and re-renders map.

render() ​

• Returns: {Promise<void>}

Request a map rendering (at the next animation frame).

updateSize() ​

Updates map size.