symbol

View source
用 MapboxLayer 的 symbol 类型渲染文字与图标标注,layout 读取要素属性。

简介

MapboxLayertype="symbol" 渲染文字/图标标注:text-field['get', ...] 读取属性,text-size / text-offset 等 layout 控制排布(图标需先经 useMapboxImage 注册)。

symbol 由通用组件 MapboxLayer 承载,完整 Props 与事件见其文档。

用法

按属性渲染文字标注,带描边便于深浅底图阅读:

<script setup lang="ts">
import type { FeatureCollection } from 'geojson'

const data: FeatureCollection = {
  type: 'FeatureCollection',
  features: [
    {
      type: 'Feature',
      properties: { name: '天安门' },
      geometry: { type: 'Point', coordinates: [116.397, 39.908] }
    },
    {
      type: 'Feature',
      properties: { name: '国贸' },
      geometry: { type: 'Point', coordinates: [116.461, 39.909] }
    },
    {
      type: 'Feature',
      properties: { name: '中关村' },
      geometry: { type: 'Point', coordinates: [116.316, 39.983] }
    }
  ]
}
</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.39, 39.93], zoom: 11 }"
    >
      <!-- text-field 读取属性渲染文字标注,无需注册图标 -->
      <MapboxLayer
        layer-id="labels"
        type="symbol"
        :source="{ type: 'geojson', data }"
        :layout="{
          'text-field': ['get', 'name'],
          'text-size': 14,
          'text-offset': [0, 0.6],
          'text-anchor': 'top'
        }"
        :paint="{ 'text-color': '#1f2937', 'text-halo-color': '#fff', 'text-halo-width': 1.5 }"
      />
    </MapboxMap>
  </div>
</template>

API

Props

Prop Default Type
layerIdstring

图层 id,全局唯一

type"symbol" | "fill" | "line" | "circle" | "heatmap" | "fill-extrusion" | "building" | "raster" | "raster-particle" | "hillshade" | "model" | "background" | "sky" | "slot" | "clip"

图层类型,决定渲染方式与可用的 paint / layout 属性

sourcestring | mapboxgl.VectorSourceSpecification | mapboxgl.RasterSourceSpecification | mapboxgl.RasterDEMSourceSpecification | mapboxgl.RasterArraySourceSpecification | mapboxgl.GeoJSONSourceSpecification | mapboxgl.VideoSourceSpecification | mapboxgl.ImageSourceSpecification | mapboxgl.ModelSourceSpecification

source id 字符串引用,或内联 source 对象(自动创建匿名源并随图层卸载)

sourceLayerstring

矢量瓦片源内的子图层名(source-layer),消费矢量源时必填

paintPropBag

绘制样式属性,响应式变更经 setPaintProperty 增量下发

layoutPropBag

布局属性,响应式变更经 setLayoutProperty 增量下发

filtermapboxgl.ExpressionSpecification | ["has", string] | ["!has", string] | ["==", string, string | number | boolean] | ["!=", string, string | number | boolean] | [">", string, string | number | boolean] | [">=", string, string | number | boolean] | ["<", string, string | number | boolean] | ["<=", string, string | number | boolean] | (string | mapboxgl.FilterSpecification)[]

过滤表达式,仅渲染匹配的要素

minzoom0number

最小缩放级别,低于此级别不渲染

maxzoom24number

最大缩放级别,高于此级别不渲染

beforeIdstring

插入到该 id 图层之前;省略则追加到图层栈顶部

Changelog

No recent changes
Copyright © 2026 - 2026 YiXuan - MIT License