ol-geom-circle

ol-geom-circle can be used inside a ol-feature to draw a single circle.

Demo

Setup

Plugin usage

This component is part of the Geometries 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 Geometries plugin

import { createApp } from "vue";
import App from "./App.vue";

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

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

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

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-geom-circle>`	`<Geometries.OlGeomCircle>`

CircleDemo.vue

vue

<template>
  <form>
    <label for="radius">Radius:</label>
    <input type="number" id="radius" step="0.01" min="0.01" v-model="radius" />
  </form>
  <ol-map
    :loadTilesWhileAnimating="true"
    :loadTilesWhileInteracting="true"
    style="height: 400px"
  >
    <ol-view
      ref="view"
      :center="center"
      :zoom="zoom"
      :projection="projection"
    />

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

    <ol-vector-layer>
      <ol-source-vector>
        <ol-feature>
          <ol-geom-circle :center="[30, 40]" :radius="radius"></ol-geom-circle>
          <ol-style>
            <ol-style-stroke color="red" :width="3"></ol-style-stroke>
            <ol-style-fill color="rgba(255,200,0,0.2)"></ol-style-fill>
          </ol-style>
        </ol-feature>
      </ol-source-vector>
    </ol-vector-layer>
  </ol-map>
</template>

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

const center = ref([30, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(10);
const radius = ref(0.2);
</script>

Properties

center

Type: number[] This circle's center coordinates in units of the map's projection.

radius

Type: Number This circle's radius in units of the map's projection.

ol-geom-circle ​

Demo ​

Setup ​

Plugin usage ​

Explicit import ​

Usage ​

Properties ​

center ​

radius ​