Class: IGSSceneLabelSubLayer

IGSSceneLabelSubLayer

new IGSSceneLabelSubLayer(options)

document/layer/igserver/IGSSceneLabelSubLayer.js, line 7

IGS 场景注记子图层。

对应 IGS 场景服务中的注记（Label）类型子图层。 通过 labelingInfo 配置注记符号、布局与绘制方式。

Name Type Default Description
options Object {} 可选

构造参数。

Name Type Default Description
labelingInfo Array.<LabelClass> [] 可选

注记样式数组，仅当该子图层为注记类型时生效。
labelLayer Object | null null 可选

注记关联的服务端图层信息（由服务元信息补充）。
title String 可选

子图层名称。
Example

Create IGSSceneLabelSubLayer instance

// ES5 import style
const { IGSSceneLabelSubLayer } = zondy

// ES6 import style
import { IGSSceneLabelSubLayer } from '@mapgis/webclient-common'

Extends

Members

beginLevelNumber

开始级别

capabilitiesObject

子图层支持能力。子图层支持能力分为客户端能力和服务端能力，其中客户端能力包含cesium、leaflet、mapboxgl引擎能力。默认子图层客户端能力：所有引擎能力都为空；默认子图层服务端能力为空。

图层版权信息

descriptionString

子图层描述信息

elevationScaleNumber null

高程缩放系数（部分数据类型可能返回该属性）。

endLevelNumber

结束级别

extendPropsObject

初始化当前图层对象上不支持的属性，二次开发用户希望挂在图层对像上的属性可以存储到该属性中

Default Value:
{}

extensionOptionsObject

初始化图层的额外参数，可以通过该参数传入引擎原生的构造参数

Default Value:
{}

extentExtent

子图层范围

idString

图层id，不给则生成随机id

labelLayerObject null

注记关联的服务端图层信息。

labelingInfoArray.<LabelClass>

注记图层样式,仅当此图层类型为注记图层时生效

labelingInfoArray.<LabelClass>

注记样式数组。

仅当此子图层类型为注记（Label）时生效。

layerLayer

父图层对象。所有子图层(包含子图层的子图层)拥有同一个父图层对象。toJSON方法不会导出该属性。

layerIndexNumber

子图层的索引

layerNameString null

服务端返回的图层名称（原始名称）。

layerRenderIndexNumber String null

服务端渲染索引（某些场景服务用于区分渲染顺序）。

maxFrameSizeArray.<Number> null

最大网格大小

maxScaleNumber

最大显示比例尺（最放大）。

当视图缩放到超过该比例尺范围时，子图层不可见。 maxScale 应始终小于 minScale。

minScaleNumber

最小显示比例尺（最缩小）。

当视图缩小到超过该比例尺范围时，子图层不可见。 minScale 应始终大于 maxScale。

opacityNumber

子图层透明度。

仅部分子图层类型支持该属性（通常为模型缓存与覆盖物）。

originLayerTypeIGSSceneOriginLayerType

原始图层类型

originPointPoint null

网格划分的原点

parentSubLayer Layer null

父节点对象。toJSON方法不会导出该属性。

renderTypeString

子图层渲染类型

spatialReferenceSpatialReference

空间参考系

sublayersCollection.<SubLayer> null

子图层集合。

  • 传入 Collection 时直接使用；
  • 传入数组时会将数组元素视为子图层配置并递归创建；
  • 传入 null 表示无子图层。

注意：该属性通过 _decorate() 实现类型包装，外部通常以 Collection 的方式访问。

titleString

图层名称

typeSubLayerType

子图层类型

visibleBoolean

子图层可见性。

Methods

clone(){IGSSceneLabelSubLayer}

document/layer/igserver/IGSSceneLabelSubLayer.js, line 115

克隆当前子图层对象。

Returns:
Type Description
IGSSceneLabelSubLayer 克隆后的 IGSSceneLabelSubLayer 实例。

inherited reset()

document/layer/igserver/IGSSceneSubLayer.js, line 226

重置视角到子图层外包盒处。

该方法会通过父级 IGSSceneLayer 派发更新事件，具体视角跳转逻辑由三维渲染端（Cesium 插件）处理。

toJSON(){Object}

document/layer/igserver/IGSSceneLabelSubLayer.js, line 90

导出为 JSON 配置。

Returns:
Type Description
Object 子图层配置对象。

IGSSceneLabelSubLayer.fromJSON(json){IGSSceneLabelSubLayer}

document/layer/igserver/IGSSceneLabelSubLayer.js, line 103

通过 JSON 配置创建 IGSSceneLabelSubLayer 实例。

Name Type Description
json Object

子图层配置对象。
Returns:
Type Description
IGSSceneLabelSubLayer 新的 IGSSceneLabelSubLayer 实例。