Class: SubLayer

SubLayer

new SubLayer(options)

document/layer/baseLayer/SubLayer.js, line 7

子图层基类。

子图层用于描述“图层内部的可配置单元”，常见于：

  • 地图出图类图层（MapImage/WMS 等）的服务端图层树
  • 三维场景服务的子节点（模型、地形、图层组等）

与 Layer 不同，SubLayer 不直接挂载到 Map.layers，其生命周期通常由父图层管理。

Name Type Default Description
options Object {} 可选

构造参数

Name Type Default Description
type String 可选

子图层类型（通常由具体子类写入）。
id String getGUID() 可选

子图层 id。不传入则生成随机 id。
layer Layer | null null 可选

父图层对象（所有子图层共享同一个父图层）。
sublayers Collection.<SubLayer> | Array.<Object> | null null 可选

子图层集合或子图层配置数组。
title String | null null 可选

子图层名称。
visible Boolean true 可选

子图层可见性。
extensionOptions Object {} 可选

额外初始化参数（可传入引擎原生构造参数）。
extendProps Object {} 可选

扩展属性容器（用于挂载当前子图层未显式支持的业务字段）。
copyright String 可选

版权信息。
description String 可选

子图层描述。
parent SubLayer | Layer | null null 可选

父级子图层或父图层对象（用于构建树结构）。
spatialReference SpatialReference | Object | null null 可选

空间参考系。
extent Extent | Object | null null 可选

子图层范围。
minScale Number 0 可选

最小显示比例尺（最缩小）。minScale 应始终大于 maxScale。
maxScale Number 0 可选

最大显示比例尺（最放大）。maxScale 应始终小于 minScale。
capabilities Object 可选

子图层支持能力（客户端/服务端）。
Example

Create SubLayer instance

// ES5 import style
const { SubLayer } = zondy

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

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。

parentSubLayer Layer null

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

spatialReferenceSpatialReference

空间参考系

sublayersCollection.<SubLayer> null

子图层集合。

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

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

titleString

图层名称

typeSubLayerType

图层类型

visibleBoolean

子图层显示或隐藏。

注意：基类仅维护属性值，不主动分发图层更新事件。

Methods

clone(){SubLayer}

document/layer/baseLayer/SubLayer.js, line 333

克隆当前子图层。

Returns:
Type Description
SubLayer 克隆后的新实例

inherited fire(type, data, propagate){Object}

base/Evented.js, line 523

激发指定类型的事件

Name Type Description
type string 可选

事件类型
data Object 可选

待传递的数据
propagate Boolean 可选

是否传播到父级
Returns:
Type Description
Object 当前实例

inherited off(types, fn, context){Object}

base/Evented.js, line 337

移除事件
示例如下:
[1、移除一个事件的指定回调函数]
[2、移除一个事件的所有回调函数]
[3、移除多个事件的同一个指定的回调函数]
[4、移除多个指定事件的回调函数]
[5、删除时指定上下文 - types类型为字符串]
[6、删除时指定上下文 - types类型为对象]

Name Type Description
types string 可选

移除指定事件类型上绑定的回调函数
当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function 可选

事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
context Object 可选

事件回调函数的this关键字将指向的对象
Returns:
Type Description
Object 当前实例
Examples

移除一个事件的指定回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction)

移除一个事件的所有回调函数

// 一个事件的回调函数1
const clickFunction1 = function (event) {
  console.log("点击事件1:", event)
}

// 一个事件的回调函数2
const clickFunction2 = function (event) {
  console.log("点击事件2:", event)
}

// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
// 不指定回调函数，则移除该事件上的所有绑定的回调函数
view.off('click')

移除多个事件的同一个指定的回调函数

// 多个事件的同一个回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}
// 调用MapView或SceneView的off方法移除多个事件的同一个指定的回调函数
view.off('click double-click', eventFunction)

移除多个指定事件的回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
})

删除时指定上下文 - types类型为字符串

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction, view)
// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
view.off('click', undefined, view)

删除时指定上下文 - types类型为对象

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
}, view)

inherited on(types, fn, context){Object}

base/Evented.js, line 240

注册一个新的监听事件;
示例如下：
[1、注册一个事件]
[2、一次注册多个事件 - 同一个回调函数]
[3、一次注册多个事件 - 分别指回调应函数]
[4、当types为字符串时 - 指定上下文]
[5、当types为对象时 - 指定上下文]

Name Type Default Description
types String | Object null 可选

事件类型
当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function null 可选

事件回调函数
context Object null 可选

事件回调函数的this关键字将指向的对象
Returns:
Type Description
Object 当前实例
Examples

注册一个事件

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的on方法注册一个点击事件
view.on('click', clickFunction)

一次注册多个事件 - 同一个回调函数

// 初始化一个事件回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 多个事件类型使用同一个回调函数
view.on('click right-click-down', eventFunction)

一次注册多个事件 - 分别指回调应函数

// 初始化一个左键点击事件回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}

// 初始化一个右键按下事件回调函数
const rightClickFunction = function (event) {
  console.log("right-click-down事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 每一个事件类型，使用单独的回调函数
// 注意使用此种方式，一种类型的事件仅能指定一个回调函数
view.on({
  "click": clickFunction,
  "right-click-down": rightClickFunction
})

指定上下文 - types类型为字符串

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on('click', clickFunction, view)

指定上下文 - types类型为对象

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on({
  "click": clickFunction,
  "right-click-down": clickFunction
}, view)

inherited once(types, fn, context){Object}

base/Evented.js, line 592

事件监听，仅触发一次

Name Type Description
types string 可选

将侦听器函数（fn）添加到对象的特定事件类型中。您还可以传递几个空格分隔的类型（例如“click dblclick”），也可以传入例如 {click: onClick, mousemove: onMouseMove}。
fn function 可选

侦听器函数
context Object 可选

指定侦听器的上下文（this关键字将指向的对象）
Returns:
Type Description
Object 当前实例

toJSON(){Object}

document/layer/baseLayer/SubLayer.js, line 301

导出为 JSON 配置。

注意：layer、parent 等运行时引用不会被导出。

Returns:
Type Description
Object JSON 配置对象

SubLayer.fromJSON(json){SubLayer}

document/layer/baseLayer/SubLayer.js, line 343

通过 JSON 配置创建/恢复实例。

该方法会根据 json.type 由 createSublayer 选择具体子类。

Name Type Description
json Object

JSON 配置对象
Returns:
Type Description
SubLayer 新的子图层实例