Class: WMSSubLayer

WMSSubLayer

new WMSSubLayer(options)

document/layer/ogc/WMSSubLayer.js, line 7

WMS 子图层对象。

用于描述 WMS 图层中的单个子图层配置，包括图层名称、查询能力和坐标系信息。 该对象通常由 WMSLayer 在解析服务能力后构建，也可通过配置对象手动创建后参与图层初始化。

Name Type Default Description
options Object {} 可选

构造参数

Name Type Default Description
name String 可选

图层名称
description String 可选

图层描述
queryable Boolean 可选

是否参与查询
spatialReferences Array.<SpatialReference> [] 可选

图层坐标系列表
spatialReference SpatialReference 可选

图层坐标系
extent Extent 可选

图层范围
Example

初始化 WMS 子图层

// ES5引入方式
const { WMSSubLayer } = zondy

// ES6引入方式
import { WMSSubLayer } from '@mapgis/webclient-common'

const sublayer = new WMSSubLayer({
  name: '行政区',
  queryable: true
})

Extends

Members

capabilitiesObject

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

图层版权信息

descriptionString

子图层描述信息

extendPropsObject

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

Default Value:
{}

extensionOptionsObject

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

Default Value:
{}

extentExtent

子图层范围

idString

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

layerLayer

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

maxScaleNumber

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

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

minScaleNumber

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

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

nameString

图层名称

parentSubLayer Layer null

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

queryableBoolean

是否参与查询

spatialReferenceSpatialReference

空间参考系

spatialReferencesArray.<SpatialReference>

图层坐标系列表

sublayersCollection.<SubLayer> null

子图层集合。

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

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

titleString

图层名称

typeSubLayerType

图层类型

visibleBoolean

子图层显示或隐藏

Methods

clone(){WMSSubLayer}

document/layer/ogc/WMSSubLayer.js, line 124

克隆图层对象

Returns:
Type Description
WMSSubLayer 克隆后的图层对象

toJSON(){Object}

document/layer/ogc/WMSSubLayer.js, line 112

转换为 JSON 对象

Returns:
Type Description
Object JSON 对象

WMSSubLayer.fromJSON(json){WMSSubLayer}

document/layer/ogc/WMSSubLayer.js, line 135

根据 JSON 对象构造图层

Name Type Default Description
json Object {} 可选

子图层配置
Returns:
Type Description
WMSSubLayer 子图层对象