Class: TextSymbol

TextSymbol

new TextSymbol(options)

base/symbol/TextSymbol.js, line 9

点位文本符号，用于为点几何、注记点和标注结果配置字体外观。 支持背景、描边、光晕、对齐、换行、旋转和偏移控制，适合按属性动态渲染文本标签。

Name Type Default Description
options Object {} 可选

构造参数

Name Type Default Description
angle Number 0 可选

文本旋转角度，单位为度。开启 rotated 后生效，默认不旋转。
backgroundColor Color 可选

文本背景颜色。未传入时不显示背景。
borderLineColor Color 可选

文本描边颜色，用于增强浅色底图上的可读性。
borderLineSize Number 可选

文本描边宽度，单位像素。
color Color new zondy.Color(0,0,0) 可选

文字颜色。
font Font 可选

字体样式配置，包含字族、字号、粗细、样式和装饰等信息。
haloColor Color new zondy.Color(0,0,0,1) 可选

光晕颜色，用于提高复杂底图上的可读性。
haloSize Number 0 可选

光晕大小，单位像素，0 表示不显示光晕。
horizontalAlignment HorizontalAlignment 'center' 可选

水平方向对齐方式，可选 left、right 或 center。
kerning Boolean false 可选

是否启用字距调整，用于改善字符间距表现。
lineHeight Number 1.1 可选

行高倍率，默认按字体大小的 1.1 倍计算基线距离。
lineWidth Number 192 可选

自动换行宽度，单位像素，超过该宽度后按多行文本处理。
rotated Boolean false 可选

是否允许文本随 angle 旋转。
text String 可选

默认文本内容。通常用于静态标签或服务端未返回文本字段时的兜底显示。
verticalAlignment VerticalAlignment 'baseline' 可选

垂直方向对齐方式，可选 baseline、top、middle 或 bottom。
xoffset Number 0 可选

X 方向偏移，单位像素，正值表示向右偏移。
yoffset Number 0 可选

Y 方向偏移，单位像素，正值表示向上偏移。
Example

创建文本样式

// ES5引入方式
const { TextSymbol } = zondy.symbol
const { Color } = zondy

// ES6引入方式
import { TextSymbol, Color } from "@mapgis/webclient-common"
const textSymbol = new TextSymbol({
  // 字体颜色
  color: new Color(252, 100, 22, 1),
  // 字体内容，如果是服务端数据，可不填
  text: "默认文字",
  // 字体样式
  font: {
    // 字体
    family: "微软雅黑",
    // 文字大小，单位像素
    size: 30,
    // 文字是否为斜体，正常模式
    style: "normal",
    // 文字粗细
    weight: "normal"
  }
})

Extends

Members

angleNumber

文字角度

backgroundColorColor

文字背景颜色

borderLineColorColor

文字外边框颜色

borderLineSizeNumber

文字外边框线宽

colorColor

文字颜色

extensionOptionsObject

符号的额外构造参数，该构造参数是地图引擎的额外构造参数，在此设置了之后，会覆盖该符号转换好地图引擎的构造参数

Default Value:
{}

fontFont

文字字体

haloColorColor

光晕颜色

haloSizeNumber

光晕大小

horizontalAlignmentHorizontalAlignment

水平对齐

idString

符号id

kerningBoolean

是否调整文本字符串中字符之间的间距

lineHeightNumber

行高，默认设置为1.1倍的字体size，表示上下文本间基线距离

lineWidthNumber

行宽，单位为像素，默认是192px，超过这个长度会自动换行

rotatedBoolean

是否旋转

textString

显示的内容

typeString

符号类型

verticalAlignmentVerticalAlignment

垂直对齐

xoffsetNumber

文字的x轴偏移，单位像素, xoffset正值表示文字相对于锚点向右偏移

yoffsetNumber

文字的y轴偏移，单位像素, yoffset正值表示文字相对于锚点向上偏移

Methods

clone(){TextSymbol}

base/symbol/TextSymbol.js, line 177

克隆并返回新的符号对象

Returns:
Type Description
TextSymbol 克隆后的新符号对象

toJSON(){Object}

base/symbol/TextSymbol.js, line 185

导出为JSON对象

Returns:
Type Description
Object JSON对像

TextSymbol.fromJSON(json){TextSymbol}

base/symbol/TextSymbol.js, line 168

将JSON里的数据导入，并返回一个新的TextSymbol对象

Name Type Description
json Object 可选

新的TextSymbol对象
Returns:
Type Description
TextSymbol 新的TextSymbol对象