Skip to content

text渲染插件

为点类型数据绘制文字的渲染插件。icon渲染插件同样支持文字绘制,与之不同的是text渲染插件支持沿线绘制,而icon插件不支持。

  • 沿线文字

沿线文字

配置说明

js
{
  // [必填] 渲染插件对象
  renderPlugin: {
    // [必填] 插件类型,固定为text
    type: "text",
    // [必填] 数据配置
    dataConfig: {
      // [必填] 数据类型,固定为point
      type: "point",
      // [可选] 默认为false
      // 声明是否只包含2D数据。
      // 设为true时,VectorTileLayer会开启瓦片的模板测试(stencil test),
      // 剪切掉超过瓦片范围的数据,消除绘制时瓦片重叠部分的绘制问题
      only2D: true
    },
    // [可选] 默认为null
    // 渲染场景配置
    sceneConfig: {
      // [可选] 默认为 "one"
      // WebGL的blendEquation的src参数,可选的值有:
      // 0, 1, "src color", "one minus src color", "src alpha", "one minus dst color", "dst alpha",
      // "one minus dst alpha", "constant color", "one minus constant color", "constant alpha",
      // "one minus constant alpha", "src alpha saturate"
      blendSrc: "one",
      // [可选] 默认为 "one minus src alpha"
      // WebGL的blendEquation的dst参数,可选的值有:
      // 0, 1, "src color", "one minus src color", "src alpha", "one minus dst color", "dst alpha",
      // "one minus dst alpha", "constant color", "one minus constant color", "constant alpha",
      // "one minus constant alpha", "src alpha saturate"
      blendDst: "one minus src alpha",
      // [可选] 默认为[0, 1]
      // WebGL深度值范围
      depthRange: [0, 1],
      // 【可选],默认为null
      // feature-filter类型,符合条件的数据将不被渲染
      excludes: null
      // [可选] 默认为always,即永远显示
      // WebGL深度测试函数,可选的值有 always, never, <, <=, !=, >, >=
      depthFunc: 'always',
      // [可选] 默认为false
      // 是否开启图标全局定位,即同一数据在不同级别瓦片上,都会保持统一的绘制。
      // 例如如果开启了fading,同一数据出现在新的级别瓦片上,但不会有fading入场。
      uniquePlacement: false,

      // [可选] 默认为false
      // 是否开启碰撞检测(需要图层 options.collision 同时为 true 才生效)
      collision: false,
      // [可选] 默认为false
      // 是否开启碰撞检测的透明度过渡效果
      fading: false,
      // [可选] 默认为 16*14
      // 碰撞检测过渡效果的持续时间
      fadingDuration: 16 * 14,
      // [可选] 默认为600
      // 图标通过碰撞检测,从隐藏到显示的过渡效果的开始延迟
      fadeInDelay: 600,
      // [可选] 默认为100
      // 图标未通过碰撞检测,从显示到隐藏的过渡效果的开始延迟
      fadeOutDelay: 100
    }
  },
  // [可选] 默认为true
  // 数据过滤条件
  filter: true,
  // 样式属性
  symbol: {
    textSize: 14,
    textFill: "rgba(0,0,0,1)",
    textName: "{name}",
    textPlacement: "line",
    mergeOnProperty: "road_name"
  }
}

注:text 插件的 sceneConfig 默认值已按 2026 源码核对:VectorTileLayer 的 style 未设置 sceneConfig 时按 {} 处理,collision / fading 默认均为关闭(collision 还需图层 options.collision: true 才生效);矢量图层(PointLayer)默认注入 ICON_PAINTER_SCENECONFIG(collision: true, fading: false)。旧文档 fading 默认 true 有误,已修正(2026 核对)。

filter 数据过滤条件的具体说明请点击这里

支持的数据类型

动态样式

大部分样式属性都支持 function-type 表达式,支持根据不同zoom级别或数据的属性值设置不同的样式属性。

例如以下示例,能让文字在不同地图级别上由小变大:

json
{
 "textSize": {
    "stops": [[1, 2], [20, 40]]
  }
}

支持的Symbol样式属性

text渲染插件支持text样式属性

除此之外,还支持以下属性:


textBloom

默认值:false

Boolean,是否支持bloom泛光后处理(2026 源码 TextPainter.getBloomSymbol 为 textBloom,旧文档写作 markerBloom 有误)。

本文档已与 @maptalks/gl-layers 2026 源码核对(api-notes-vt-gl.md)