Skip to content

ol-webgl-tile-layer

This example uses WebGL to raster tiles on a map.

Usage

vue
<template>
  <ol-map
    :loadTilesWhileAnimating="true"
    :loadTilesWhileInteracting="true"
    style="height: 400px"
  >
    <ol-view
      ref="view"
      :center="center"
      :zoom="zoom"
      :projection="projection"
    />

    <ol-webgl-tile-layer :style="trueColor">
      <ol-source-geo-tiff
        :normalize="false"
        :sources="[
          {
            url: 'https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif',
          },
        ]"
        :wrapX="true"
      />
    </ol-webgl-tile-layer>
  </ol-map>
</template>

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

const center = ref([0, 0]);
const zoom = ref(2);
const projection = ref("EPSG:4326");

const max = 3000;
function normalize(value) {
  return ["/", value, max];
}

const red = normalize(["band", 1]);
const green = normalize(["band", 2]);
const blue = normalize(["band", 3]);

const trueColor = ref({
  color: ["array", red, green, blue, 1],
  gamma: 1.1,
});
</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

visible

The value for visible is set to true by default.

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-webgl-tile-layer @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-webgl-tile-layer ref="layerRef" />
  <!-- ... -->
</template>

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

const layerRef = ref<{ tileLayer: WebGLTileLayer }>(null);

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