vue3-openlayers

Appearance

ol-source-stadia-maps ​

Layer source for the StadiaMaps tile server.

Usage ​

vue
<template>
  <ol-map
    :loadTilesWhileAnimating="true"
    :loadTilesWhileInteracting="true"
    style="height: 400px"
  >
    <ol-view ref="view" :center="center" :zoom="zoom" />
    <ol-tile-layer>
      <ol-source-stadia-maps layer="stamen_watercolor" />
    </ol-tile-layer>
    <ol-tile-layer>
      <ol-source-stadia-maps layer="stamen_terrain_labels" />
    </ol-tile-layer>
  </ol-map>
</template>

<script setup lang="ts">
import { fromLonLat } from "ol/proj";
import { ref } from "vue";

const zoom = ref(12);
const center = ref(fromLonLat([-122.416667, 37.783333]));
</script>
<template>
  <ol-map
    :loadTilesWhileAnimating="true"
    :loadTilesWhileInteracting="true"
    style="height: 400px"
  >
    <ol-view ref="view" :center="center" :zoom="zoom" />
    <ol-tile-layer>
      <ol-source-stadia-maps layer="stamen_watercolor" />
    </ol-tile-layer>
    <ol-tile-layer>
      <ol-source-stadia-maps layer="stamen_terrain_labels" />
    </ol-tile-layer>
  </ol-map>
</template>

<script setup lang="ts">
import { fromLonLat } from "ol/proj";
import { ref } from "vue";

const zoom = ref(12);
const center = ref(fromLonLat([-122.416667, 37.783333]));
</script>

Properties ​

Props from OpenLayers ​

Properties are passed-trough from OpenLayers directly. Their types and default values can be checked-out in the official OpenLayers docs. Only some properties deviate caused by reserved keywords from Vue / HTML. This deviating props are described in the section below.

Deviating Properties ​

None.

Events ​

You have access to all Events from the underlying source. Check out the official OpenLayers docs to see the available events tht will be fired.

html
<ol-source-stadia-maps layer="stamen_watercolor" @error="handleEvent" />
<ol-source-stadia-maps layer="stamen_watercolor" @error="handleEvent" />

Methods ​

You have access to all Methods from the underlying source. Check out the official OpenLayers docs to see the available methods.

To access the source, you can use a ref() as shown below:

vue
<template>
  <!-- ... -->
  <ol-source-stadia-maps layer="stamen_watercolor" ref="sourceRef" />
  <!-- ... -->
</template>

<script setup lang="ts">
import { ref, onMounted } from "vue";
import type StadiaMaps from "ol/source/StadiaMaps";

const sourceRef = ref<{ source: StadiaMaps }>(null);

onMounted(() => {
  const source: StadiaMaps = sourceRef.value?.source;
  // call your method on `source`
});
</script>
<template>
  <!-- ... -->
  <ol-source-stadia-maps layer="stamen_watercolor" ref="sourceRef" />
  <!-- ... -->
</template>

<script setup lang="ts">
import { ref, onMounted } from "vue";
import type StadiaMaps from "ol/source/StadiaMaps";

const sourceRef = ref<{ source: StadiaMaps }>(null);

onMounted(() => {
  const source: StadiaMaps = sourceRef.value?.source;
  // call your method on `source`
});
</script>