类名 LabelClass

# new LabelClass(options)

注记样式，参考示例：[创建注记样式对象]

参数

名称 类型 默认值 描述
options Object

构造参数
symbol MapGISTextSymbol | TextSymbol

文本符号样式
renderMode String

注记渲染方式,1.canvas 2.label 3.ground(测试)
groundScale Number 20

渲染模式为ground时，设置像素与实际单位米之间的比例关系。测试接口。假设groundScale为10，2020px的像素范围贴地时会被渲染为200200m的注记。
deconflictionStrategy String

注记避让策略，可选1.'static'默认避让策略 2.'none' 无避让策略
maxScale Number

注记显示的最大比例尺（比例尺的分母，该值越小，比例尺越大）。默认值为undefined，undefined表示用户未设置。maxScale的值应该始终小于minScale的值,单位为米,不支持渲染类型renderMode为ground的模式。
minScale Number

注记显示的最小比例尺（比例尺的分母，该值越大，比例尺越小）。默认值为undefined，undefined表示用户未设置。minScale的值应该始终大于maxScale的值,单位为米,不支持渲染类型renderMode为ground的模式。
elevationInfo ElevationInfo

高程描述信息
labelPlacement String

布局位置，描述注记和几何之间的关系,此设置会覆盖符号symbol内关于文字布局样式的定义。针对于点类型可选项1.above-left 2.above-center 3.above-right 4.center-left 5.center-center 6.center-right 7.below-left 8.below-center 9.below-right 针对于线类型 1.'on-line' 压线 2.'above-line' 线上 3.'under-line' 线下 针对于区类型1.'parallel' 平行 2.'outside' 区外 3.'bottom' 底部 4.'skeleton' 骨架线
currentAttributeName String

当前属性字段,属于临时接口,后续可能会扩充字段表达式，拟废弃，推荐使用labelExpression接口
labelExpression String

label字段表达式,例如设置值为"$feature.n",表示以feature上的n字段的字段值作为文本显示。
repeatLabel Boolean true

是否重复注记，限制线几何类型使用
repeatLabelDistance Number 6000

重复步长，限制线几何类型使用，单位为米
repeatStartRate Number 0.3

开始步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
repeatEndRate Number 0.7

结束步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
lineLabelSpread Number 'auto-spread'

线注记分布方式 1.'auto-spread' 字母集中，汉字分散 2.'centralization-spread'集中 3.'decentralize-spread' 分散。限制线几何使用。
labelPositionAlong Number 'middle'

线文字与线关系，仅集中注记时生效。1.'start' 线头 2.'middle' 线中点 3.'end' 线尾，限制线使用。
skeletonLineStartRate Number 0.4

骨架线开始步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
skeletonLineEndRate Number 0.6

骨架线结束步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
extensionOptions Object {}

样式的扩展参数，可以通过该属性传入引擎原生图元的样式参数。可以参考cesium上Label、BillBoard、GroundPrimitive相关api进行设置。

支持如下方法：
[1、转换为json对象]
[2、克隆并返回一个新的LabelClass对象]
[3、将JSON里的数据导入，并返回一个新的LabelClass对象]

示例

初始化注记样式

const labelClass = new zondy.LabelClass({
  // 指定文本符号样式
  symbol: new zondy.symbol.TextSymbol({
    // 文字颜色
    color: new Color(252, 100, 22, 1),
    // 文字样式
    font: new zondy.symbol.Font({
      // 字体
      family: "微软雅黑",
      // 文字大小，单位像素
      size: 30,
      // 文字是否为斜体，正常模式
      style: "normal",
      // 文字粗细
      weight: "normal"
    })
  })
})

成员变量

成员变量概述

名称 类型 描述
currentAttributeName String

当前属性字段,属于临时接口,后续可能会扩充字段表达式,后续拟废弃接口
deconflictionStrategy String

避让策略，可选1.'static'默认避让策略 2.'none' 无避让策略
elevationInfo ElevationInfo

高程描述信息
extensionOptions Object

样式的扩展参数，可以通过该属性传入引擎原生图元的样式参数。可以参考cesium上Label、BillBoard、GroundPrimitive相关api进行设置。
groundScale Number

渲染模式为ground时，设置像素与实际单位米之间的比例关系。测试接口。假设groundScale为10，2020px的逻辑范围贴地时会被渲染为200200m的注记。
labelExpression String

label字段表达式
labelPlacement String

布局位置，描述注记和几何之间的关系。针对于点类型可选项1.above-left 2.above-center 3.above-right 4.center-left 5.center-center 6.center-right 7.below-left 8.below-center 9.below-right 针对于线类型 1.'on-line' 压线 2.'above-line' 线上 3.'under-line' 线下 针对于区类型1.'parallel' 平行 2.'outside' 区外 3.'bottom' 底部 4.'skeleton' 骨架线
labelPositionAlong String

线文字与线关系，仅集中注记时生效。1.'start' 线头 2.'middle' 线中点 3.'end' 线尾，限制线使用。
lineLabelSpread String

线注记分布方式 1.'auto-spread' 字母集中，汉字分散 2.'centralization-spread'集中 3.'decentralize-spread' 分散。限制线几何使用。
maxScale Number

注记显示的最大比例尺（比例尺的分母，该值越小，比例尺越大）。默认值为undefined，undefined表示用户未设置。maxScale的值应该始终小于minScale的值,单位为米,不支持渲染类型renderMode为ground的模式。
minScale Number

注记显示的最小比例尺（比例尺的分母，该值越大，比例尺越小）。默认值为undefined，undefined表示用户未设置。minScale的值应该始终大于maxScale的值,单位为米,不支持渲染类型renderMode为ground的模式。
renderMode String

注记渲染方式,1.canvas 2.label 3.ground(测试)
repeatEndRate Number

结束步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
repeatLabel Boolean

是否重复注记，限制线几何类型使用
repeatLabelDistance Number

重复步长，限制线几何类型使用，单位为米
repeatStartRate Number

开始步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
skeletonLineEndRate String

骨架线结束步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
skeletonLineStartRate String

骨架线开始步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。
symbol MapGISTextSymbol | TextSymbol

注记符号样式

成员变量详情

String

# currentAttributeName

当前属性字段,属于临时接口,后续可能会扩充字段表达式,后续拟废弃接口

String

# deconflictionStrategy

避让策略，可选1.'static'默认避让策略 2.'none' 无避让策略

ElevationInfo

# elevationInfo

高程描述信息

Object

# extensionOptions

样式的扩展参数，可以通过该属性传入引擎原生图元的样式参数。可以参考cesium上Label、BillBoard、GroundPrimitive相关api进行设置。

Default Value:
  • {}
Number

# groundScale

渲染模式为ground时，设置像素与实际单位米之间的比例关系。测试接口。假设groundScale为10，2020px的逻辑范围贴地时会被渲染为200200m的注记。

String

# labelExpression

label字段表达式

String

# labelPlacement

布局位置，描述注记和几何之间的关系。针对于点类型可选项1.above-left 2.above-center 3.above-right 4.center-left 5.center-center 6.center-right 7.below-left 8.below-center 9.below-right 针对于线类型 1.'on-line' 压线 2.'above-line' 线上 3.'under-line' 线下 针对于区类型1.'parallel' 平行 2.'outside' 区外 3.'bottom' 底部 4.'skeleton' 骨架线

String

# labelPositionAlong

线文字与线关系，仅集中注记时生效。1.'start' 线头 2.'middle' 线中点 3.'end' 线尾，限制线使用。

String

# lineLabelSpread

线注记分布方式 1.'auto-spread' 字母集中，汉字分散 2.'centralization-spread'集中 3.'decentralize-spread' 分散。限制线几何使用。

Number

# maxScale

注记显示的最大比例尺（比例尺的分母，该值越小，比例尺越大）。默认值为undefined，undefined表示用户未设置。maxScale的值应该始终小于minScale的值,单位为米,不支持渲染类型renderMode为ground的模式。

Number

# minScale

注记显示的最小比例尺（比例尺的分母，该值越大，比例尺越小）。默认值为undefined，undefined表示用户未设置。minScale的值应该始终大于maxScale的值,单位为米,不支持渲染类型renderMode为ground的模式。

String

# renderMode

注记渲染方式,1.canvas 2.label 3.ground(测试)

Number

# repeatEndRate

结束步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。

Boolean

# repeatLabel

是否重复注记，限制线几何类型使用

Number

# repeatLabelDistance

重复步长，限制线几何类型使用，单位为米

Number

# repeatStartRate

开始步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。

String

# skeletonLineEndRate

骨架线结束步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。

String

# skeletonLineStartRate

骨架线开始步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。

MapGISTextSymbol | TextSymbol

# symbol

注记符号样式

方法

方法概述

名称 返回值类型 描述
fromJSON LabelClass

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

克隆并返回一个新的LabelClass对象
toJSON Object

转换为json对象

方法详情

# static fromJSON(jsonopt)

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

参数

名称 类型 描述
json Object

新的LabelClass对象

新的LabelClass对象

LabelClass

# clone()

克隆并返回一个新的LabelClass对象

新的LabelClass对象

LabelClass

# toJSON()

转换为json对象

json对象

Object