类名 TextSymbol

# new TextSymbol(options)

文本符号,支持点几何对象,参考示例:[创建文本样式]

[ES5引入方式]:
zondy.symbol.TextSymbol()
[ES6引入方式]:
import { TextSymbol } from "@mapgis/webclient-common"

参数:

名称 类型 默认值 描述
options Object

构造参数

angle Number 0

文字的旋转角度,单位度,0~360度,顺时针旋转,需要开启rotated选项

backgroundColor Color

背景颜色

borderLineColor Color

边界颜色

borderLineSize Number

边界宽度

color Color New zondy.Color(0,0,0)

颜色

font Font

字体样式

haloColor Color

光晕颜色

haloSize Number

光晕大小

horizontalAlignment HorizontalAlignment 'center'

水平方向,可选"left"|"right"|"center"

kerning Boolean true

是否调整文本字符串中字符之间的间距,二维暂时不支持

lineHeight Number 1.1

行高,最小设置为1.1

lineWidth Number 192

行宽

rotated Boolean false

是否旋转

text String

默认显示内容

verticalAlignment VerticalAlignment 'baseline'

垂直对齐,可选"baseline"|"top"|"middle"|"bottom"

xoffset Number 0

x偏移

yoffset Number 0

y偏移

支持如下方法:
1、克隆并返回新的符号对象
2、导出一个JSON对像
[3、将JSON里的数据导入,并返回一个新的TextSymbol对象]

示例

创建文本样式

// ES5引入方式
const { TextSymbol } = zondy.symbol
const { TextSymbol, 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"
  }
})

继承关系

成员变量

Number

# angle

文字角度

Color

# backgroundColor

文字背景颜色

Color

# borderLineColor

文字外边框颜色

Number

# borderLineSize

文字外边框线宽

Color

# color

文字颜色

Overrides:
Object

# extensionOptions

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

Inherited From:
Default Value:
  • {}
String

# font

文字字体

Color

# haloColor

光晕颜色

Number

# haloSize

光晕大小

HorizontalAlignment

# horizontalAlignment

水平方向

String

# readonly id

符号id

Inherited From:
Boolean

# kerning

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

Number

# lineHeight

行高

Number

# lineWidth

行宽

Boolean

# rotated

是否旋转

String

# text

显示的内容

String

# type

符号类型

Overrides:
VerticalAlignment

# verticalAlignment

垂直对齐

Number

# xoffset

x偏移

Number

# yoffset

y偏移

方法

# static fromJSON(jsonopt)

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

参数:

名称 类型 描述
json Object

新的TextSymbol对象

新的TextSymbol对象

TextSymbol

# clone()

克隆并返回新的符号对象

Overrides:

克隆后的新符号对象

TextSymbol

# toJSON()

导出为JSON对象

Overrides:

JSON对像

Object
构造函数
成员变量
方法
事件