ol-toggle-control

A simple toggle control The control can be created with an interaction to control its activation.

• Demo
• Setup
  • Plugin usage
  • Explicit import
• Usage
• Properties
  • className
  • title
  • html
  • interaction
  • active
  • disable
  • bar
  • autoActive
  • onToggle

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-toggle-control>	<MapControls.OlToggleControl>

ToggleControlDemo.vue

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

    <ol-tile-layer>
      <ol-source-osm />
    </ol-tile-layer>
    <ol-toggle-control
      html="log"
      :onToggle="($event) => console.log('ol-toggle-control: onToggle', $event)"
    />
  </ol-map>
</template>

<script setup lang="ts">
import { ref } from "vue";
const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(8);
</script>

Properties

className

class of the control

• Type: String

title

title of the control

• Type: String

html

html to insert in the control

• Type: String

interaction

ol.interaction associated with the control

• Type: Object

active

the control is created active

• Type: Boolean
• Default: false

disable

the control is created disabled

• Type: Boolean
• Default: false

bar

a subbar (ol.control.Bar) associated with the control (drawn when active if control is nested in a ol.control.Bar)

• Type: Object

autoActive

the control will activate when shown in an ol.control.Bar

• Type: Boolean
• Default: false

onToggle

callback when control is clicked (or use change:active event)

• Type: Function