ol-tile-layer

ol-tile-layer can render images from sources that provide pre-rendered, tiled images in grids organized by zoom levels. It should be used together with tiled source components like ol-source-xyz, ol-source-wmts, ol-source-osm, ol-source-bingmaps

• Demo
• Setup
  • Plugin usage
  • Explicit import
• Usage
• Properties
  • className
  • opacity
  • visible
  • extent
  • zIndex
  • minResolution
  • maxResolution
  • minZoom
  • maxZoom
  • preload

Demo

Setup

Plugin usage

This component is part of the Layers 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 Layers plugin

import { createApp } from "vue";
import App from "./App.vue";

import {
  Map,
  Layers,
  Sources,
} from "vue3-openlayers";

const app = createApp(App);
// ...
app.use(Layers); 
// ...

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 Layers.

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-tile-layer>	<Layers.OlTileLayer>

Example below shows how to use ol-layer-tile component together with ol-source-wmts and with ol-source-osm.

TileLayerDemo.vue

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

    <ol-tile-layer>
      <ol-source-osm />
    </ol-tile-layer>

    <ol-tile-layer>
      <ol-source-wmts
        :attributions="attribution"
        :url="url"
        :matrixSet="matrixSet"
        :format="format"
        :layer="layerName"
        :styles="styleName"
      ></ol-source-wmts>
    </ol-tile-layer>
  </ol-map>
</template>

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

const center = ref([-11158582, 4813697]);
const zoom = ref(4);
const url = ref("https://mrdata.usgs.gov/mapcache/wmts");
const layerName = ref("sgmc2");
const matrixSet = ref("GoogleMapsCompatible");
const format = ref("image/png");
const styleName = ref("default");
const attribution = ref(
  'Tiles © <a href="https://services.arcgisonline.com/arcgis/rest/services/Demographics/USA_Population_Density/MapServer/">ArcGIS</a>',
);
</script>

Properties

className

• Type: string
• Default: ol-layer

A CSS class name to set to the layer element.

opacity

• Type: number
• Default: 1

Opacity (0, 1).

visible

• Type: boolean
• Default: true

Visibility.

extent

• Type: Array

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

zIndex

• Type: number

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position.

minResolution

• Type: number

The minimum resolution (inclusive) at which this layer will be visible.

maxResolution

• Type: number

The maximum resolution (exclusive) below which this layer will be visible.

minZoom

• Type: number

The minimum view zoom level (exclusive) above which this layer will be visible.

maxZoom

• Type: number

The maximum view zoom level (inclusive) at which this layer will be visible.

preload

• Type: number
• Default: 0 Low-resolution tiles up to preload level will be load.