ol-source-tile-json
Layer source for tile data in TileJSON format.
Demo
Setup
Plugin usage
This component is part of the Sources
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 Sources
plugin
import { createApp } from "vue";
import App from "./App.vue";
import {
Map,
Layers,
Sources,
} from "vue3-openlayers";
const app = createApp(App);
// ...
app.use(Sources);
// ...
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 Sources
.
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-source-tile-json> | <Sources.OlSourceTileJson> |
<template>
<form>
<fieldset>
<label for="opacity">Layer Opacity</label>
<input
type="range"
id="opacity"
min="0"
max="1"
step="0.1"
v-model.number="opacity"
/>
<span class="description">{{ opacity }}</span>
</fieldset>
</form>
<ol-map style="height: 400px">
<ol-view ref="view" :center="center" :zoom="zoom" />
<ol-layer-group :opacity="opacity">
<ol-tile-layer>
<ol-source-tile-wms
url="https://ahocevar.com/geoserver/wms"
:extent="[-13884991, 2870341, -7455066, 6338219]"
layers="topp:states"
serverType="geoserver"
:transition="0"
:params="{}"
/>
</ol-tile-layer>
<ol-tile-layer>
<ol-source-tile-json
url="https://maps.gnosis.earth/ogcapi/collections/NaturalEarth:raster:HYP_HR_SR_OB_DR/map/tiles/WebMercatorQuad?f=tilejson"
crossOrigin="anonymous"
/>
</ol-tile-layer>
</ol-layer-group>
</ol-map>
</template>
<script setup lang="ts">
import { ref } from "vue";
const zoom = ref(4);
const center = ref([-10997148, 4569099]);
const opacity = ref(0.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.
<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:
<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>