Skip to content

ol-fullscreen-control

A Fullscreen control for OpenLayers.

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
ts
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 UsageExplicit Import
<ol-fullscreen-control><MapControls.OlFullScreenControl>
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-fullscreen-control />
  </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

  • Type: String
  • Default: ol-full-screen

label

  • Type: String
  • Default: \u2922

labelActive

  • Type: String
  • Default: \u00d7

activeClassName

  • Type: String
  • Default: ol-full-screen-true

inactiveClassName

  • Type: String
  • Default: ol-full-screen-false

tipLabel

  • Type: String
  • Default: Toggle full-screen

keys

  • Type: Boolean
  • Default: false

target

  • Type: Object

source

  • Type: Object