ol-toggle-control

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

Usage

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