vue3-openlayers

Appearance

ol-source-tile-json ​

Layer source for tile data in TileJSON format.

Usage ​

vue
<template>
  <ol-map style="height: 400px">
    <ol-view ref="view" :center="center" :zoom="zoom" />
    <ol-layer-group :opacity="0.4">
      <ol-tile-layer>
        <ol-source-osm />
      </ol-tile-layer>
      <ol-tile-layer>
        <ol-source-tile-json :url="url" crossOrigin="anonymous" />
      </ol-tile-layer>
    </ol-layer-group>
  </ol-map>
</template>

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

const url = "https://a.tile.openstreetmap.org/4/6/6.png";
const center = ref([37.4057, 8.81566]);
const zoom = ref(4);
</script>
<template>
  <ol-map style="height: 400px">
    <ol-view ref="view" :center="center" :zoom="zoom" />
    <ol-layer-group :opacity="0.4">
      <ol-tile-layer>
        <ol-source-osm />
      </ol-tile-layer>
      <ol-tile-layer>
        <ol-source-tile-json :url="url" crossOrigin="anonymous" />
      </ol-tile-layer>
    </ol-layer-group>
  </ol-map>
</template>

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

const url = "https://a.tile.openstreetmap.org/4/6/6.png";
const center = ref([37.4057, 8.81566]);
const zoom = ref(4);
</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-tile-json :url="url" crossOrigin="anonymous" @error="handleEvent" />
<ol-source-tile-json :url="url" crossOrigin="anonymous" @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-tile-json :url="url" crossOrigin="anonymous" ref="sourceRef" />
  <!-- ... -->
</template>

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

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

onMounted(() => {
  const source: TileJSON = sourceRef.value?.source;
  // call your method on `source`
});
</script>
<template>
  <!-- ... -->
  <ol-source-tile-json :url="url" crossOrigin="anonymous" ref="sourceRef" />
  <!-- ... -->
</template>

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

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

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