---
title: "MapboxWmtsLayer"
description: "接入标准 WMTS（KVP）服务为栅格图层，支持子域名展开与自定义鉴权参数。"
seo_title: "MapboxWmtsLayer Component"
seo_description: "Add an OGC WMTS (KVP GetTile) service as a raster layer, with subdomain expansion and custom auth parameters."
canonical_url: "https://mapbox.mhaibaraai.cn/docs/extensions/wmts"
---
# MapboxWmtsLayer

> 接入标准 WMTS（KVP）服务为栅格图层，支持子域名展开与自定义鉴权参数。

## 简介

`MapboxWmtsLayer` 把标准 WMTS（KVP GetTile）服务接入为栅格图层：`url` 与 `layer` 必填，`tileMatrixSet` / `style` / `format` 透传，`url` 含 `{s}` 时配合 `subdomains` 展开多 host，`params` 追加鉴权参数（如 `tk`）。[MapboxTiandituLayer](/docs/extensions/tianditu) 即基于它封装。

## 用法

以天地图影像为例演示 WMTS 接入（`tk` 取自运行时配置）：

```vue [WmtsLayerExample.vue]
<script setup lang="ts">
// 以天地图影像为例演示通用 WMTS（KVP）接入；tk 取自运行时配置，不硬编码
const tk = (useRuntimeConfig().public.mapbox as { tiandituToken?: string }).tiandituToken
const subdomains = ['0', '1', '2', '3', '4', '5', '6', '7']
</script>

<template>
  <div class="h-115 w-full overflow-hidden rounded-(--ui-radius) border border-default">
    <MapboxMap :options="{ style: 'mapbox://styles/mapbox/light-v11', center: [116.397, 39.908], zoom: 10 }">
      <MapboxWmtsLayer
        url="https://t{s}.tianditu.gov.cn/img_w/wmts"
        layer="img"
        :subdomains="subdomains"
        :params="{ tk }"
        attribution="© 天地图"
      />
    </MapboxMap>
  </div>
</template>
```

## API

### Props

```ts
/**
 * Props for the MapboxWmtsLayer component
 */
interface MapboxWmtsLayerProps {
  /**
   * WMTS 服务基础地址；含 {s} 时配合 subdomains 展开
   */
  url: string;
  /**
   * 图层标识 LAYER
   */
  layer: string;
  /**
   * source/layer id
   */
  layerId?: string | undefined;
  /**
   * 瓦片矩阵集
   */
  tileMatrixSet?: string | undefined;
  /**
   * 瓦片格式
   */
  format?: string | undefined;
  /**
   * 子域名列表，替换 url 中的 {s}
   */
  subdomains?: string[] | undefined;
  /**
   * 瓦片尺寸
   */
  tileSize?: number | undefined;
  /**
   * 版权信息
   */
  attribution?: string | undefined;
  /**
   * 透传查询参数（如 { tk }）
   */
  params?: Record<string, string | undefined> | undefined;
  /**
   * 插入到该图层之前
   */
  beforeId?: string | undefined;
}
```

## Changelog

See commit history for [src/runtime/components/extensions/WmtsLayer.vue](https://github.com/mhaibaraai/movk-mapbox/commits/main/src/runtime/components/extensions/WmtsLayer.vue).


## Sitemap

See the full [sitemap](/sitemap.md) for all pages.