Class: TextSymbol3DLayer

TextSymbol3DLayer

new TextSymbol3DLayer(options)

base/symbol/symbol3DLayer/TextSymbol3DLayer.js, line 11

支持如下方法：
[1、通过json数据构造一个TextSymbol3DLayer对象]
[2、导出为JSON对象]
[3、克隆并返回一个新的TextSymbol3DLayer对象]

三维注记符号图层，定义如何在三维场景中显示文字，不支持二维视图
示例如下：
[1、创建一个三维注记符号图层对象]

Name Type Description
options Object

构造参数

Name Type Default Description
text String null 可选

文字内容
font Font new Font() 可选

字体
size Number 9 可选

文字大小，在字体中设置文字大小无效
material ColorMaterial new ColorMaterial() 可选

文字材质目前支持的材质有：
ColorMaterial: 纯色材质，通过设置纯色材质来设置文字颜色
background Color new Color() 可选

文字背景颜色
halo TextHalo new TextHalo() 可选

文字光晕样式
horizontalAlignment HorizontalAlignment HorizontalAlignment.center 可选

文字水平对齐方式
verticalAlignment VerticalAlignment VerticalAlignment.baseline 可选

文字垂直对齐方式
lineHeight Number 1 可选

文字行高
Example

创建一个三维注记符号图层对象

// ES5引入方式
const { Color } = zondy
const { TextSymbol3DLayer, ColorMaterial } = zondy.symbol
// ES6引入方式
import { TextSymbol3DLayer, ColorMaterial, Color } from "@mapgis/webclient-common"

// 创建一个三维注记符号图层对象
const symbol = new TextSymbol3DLayer({
  // 文字内容
  text: '你的文字内容',
  // 文字大小
  size: 40,
  // 文字颜色
  material: new ColorMaterial({
    color: new Color(255, 1, 1, 1)
  })
})

Extends

Members

backgroundColor

背景颜色

backgroundFont

字体

colorColor

颜色

extensionOptionsObject

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

Default Value:
{}

haloTextHalo

文字光晕样式

horizontalAlignmentHorizontalAlignment

文字水平对齐方式

idString

符号id

lineHeightNumber

文字行高

materialColorMaterial

材质

sizeNumber

文字大小

textString

文字内容

typeSymbol3DLayerType

三维符号图层类型

verticalAlignmentVerticalAlignment

文字垂直对齐方式

Methods

TextSymbol3DLayer.fromJSON(json){TextSymbol3DLayer}

base/symbol/symbol3DLayer/TextSymbol3DLayer.js, line 127
通过json数据构造一个TextSymbol3DLayer对象
Name Type Description
json Object

json数据
Returns:
Type Description
TextSymbol3DLayer 新的TextSymbol3DLayer对象

clone(){TextSymbol3DLayer}

base/symbol/symbol3DLayer/TextSymbol3DLayer.js, line 155
克隆并返回一个新的TextSymbol3DLayer对象
Returns:
Type Description
TextSymbol3DLayer 新的TextSymbol3DLayer对象

toJSON(){Object}

base/symbol/symbol3DLayer/TextSymbol3DLayer.js, line 136

导出为JSON对象

Returns:
Type Description
Object JSON对像