Class: MapGISTextSymbol

MapGISTextSymbol

new MapGISTextSymbol(options)

base/symbol/MapGISTextSymbol.js, line 18

MapGIS 文本符号，在 TextSymbol 基础上扩展了背景图、阴影、字距、换行和额外图标能力。 适用于需要更丰富注记样式的场景，例如重点标注、图层标签和专题注记。

Name Type Default Description
options Object {} 可选

构造参数

Name Type Default Description
backgroundPadding Array.<Number> [5,5] 可选

背景内边距，数组顺序为水平和垂直方向。
backgroundImage Image | function | undefined 可选

背景图片样式，优先级高于 backgroundColor；传入 Image 时需确保已加载完成，传入函数时按 canvas 绘制逻辑处理。
textDecorationUnderlineColor String 可选

文字下划线颜色。计划废弃，建议改用 font 中的 decoration 配置。
textDecorationUnderlineWidth Number 可选

文字下划线宽度。计划废弃，建议改用 font 中的 decoration 配置。
textDecorationThroughlineColor String 可选

文字删除线颜色。计划废弃，建议改用 font 中的 decoration 配置。
textDecorationThroughlineWidth Number 可选

文字删除线宽度。计划废弃，建议改用 font 中的 decoration 配置。
textShadowOffsetX Number 0 可选

文字阴影横轴偏移, 单位像素, textShadowOffsetX正值表示阴影相对于文字向右偏移
textShadowOffsetY Number 0 可选

文字阴影纵轴偏移, 单位像素, textShadowOffsetY正值表示阴影相对于文字向上偏移
textShadowBlur Number 1 可选

文字阴影模糊度，数值越大阴影越柔和。
textShadowColor String 可选

文字阴影颜色。
letterSpacing Number 0 可选

文字间距，单位像素。
lineMaxNum Number 3 可选

文字最大行数，超过后按换行或截断逻辑处理。
textWraps Boolean false 可选

是否启用自动换行。
textExtraIcon Image 可选

文字额外图标，用于给注记增加状态或分类提示。
textExtraIconAnchor String 'left' 可选

文字额外图标方位，可选 left、right、top 或 bottom。
textExtraIconSize Number 14 可选

文字额外图标大小，单位像素。
Example

创建文本样式

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

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

Extends

Members

angleNumber

文字角度

backgroundColorColor

文字背景颜色

backgroundImagefunction Image

文字背景颜色

backgroundPaddingArray.<Number>

文字背景内边距

borderLineColorColor

文字外边框颜色

borderLineSizeNumber

文字外边框线宽

colorColor

文字颜色

extensionOptionsObject

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

Default Value:
{}

fontFont

文字字体

haloColorColor

光晕颜色

haloSizeNumber

光晕大小

horizontalAlignmentHorizontalAlignment

水平对齐

idString

符号id

kerningBoolean

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

letterSpacingNumber

文字间距

lineHeightNumber

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

lineMaxNumNumber

文字最大行数

lineWidthNumber

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

rotatedBoolean

是否旋转

textString

显示的内容

textDecorationThroughlineColorColor

文字删除线颜色，计划废弃接口，推荐使用font属性中文字装饰元素属性decoration

textDecorationThroughlineWidthNumber

文字删除线宽度，计划废弃接口，推荐使用font属性中文字装饰元素属性decoration

textDecorationUnderlineColorColor

文字下划线颜色，计划废弃接口，推荐使用font属性中文字装饰元素属性decoration

textDecorationUnderlineWidthNumber

文字下划线宽度，计划废弃接口，推荐使用font属性中文字装饰元素属性decoration

textExtraIconImage

文字额外图标，用于给注记增加状态或分类提示

textExtraIconAnchorString

图标方位 "left" "right" "top" "bottom"

textExtraIconSizeNumber

图标大小

textShadowBlurNumber

文字阴影模糊度。一个非负浮点数，指定阴影模糊的级别，其中 0 表示没有模糊，数字越大表示模糊程度越高。这个值不对应于像素数量，并且不受当前变换矩阵的影响

textShadowColorColor

文字阴影颜色

textShadowOffsetXNumber

文字阴影横轴偏移, 单位像素, textShadowOffsetX正值表示阴影相对于文字向右偏移

textShadowOffsetYNumber

文字阴影纵轴偏移, 单位像素, textShadowOffsetY正值表示阴影相对于文字向上偏移

textWrapsBoolean

是否换行

typeString

符号类型

verticalAlignmentVerticalAlignment

垂直对齐

xoffsetNumber

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

yoffsetNumber

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

Methods

clone(){MapGISTextSymbol}

base/symbol/MapGISTextSymbol.js, line 188

克隆当前实例并返回一个新的 MapGISTextSymbol 对象。

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

toJSON(){Object}

base/symbol/MapGISTextSymbol.js, line 196

导出为 JSON 对象。

Returns:
Type Description
Object JSON对象

MapGISTextSymbol.fromJSON(json){MapGISTextSymbol}

base/symbol/MapGISTextSymbol.js, line 179

将 JSON 配置恢复为新的 MapGISTextSymbol 对象。

Name Type Description
json Object

用于恢复实例的 JSON 配置
Returns:
Type Description
MapGISTextSymbol 新的 MapGISTextSymbol 对象