MapGIS Client for JavaScript API

new OverlayLayer(options)

document/layer/overLay/OverlayLayer.js, line 6

覆盖物图层

Name	Type	Description
`options`	Object	构造参数

Extends

Layer

Members

autoAddTo2DBoolean

是否自动添加到二维引擎的地图对象。

该属性主要用于部分第三方引擎：图层的加载与添加由应用侧自行控制，而不是框架自动添加。

Default Value:

autoAddTo3DBoolean

是否自动添加到三维引擎的场景对象。

该属性主要用于部分第三方引擎：图层的加载与添加由应用侧自行控制，而不是框架自动添加。

Default Value:

capabilitiesObject

图层支持能力。

capabilities 通常由两部分组成：

client：客户端（渲染引擎）侧能力描述（如是否可加载、属性是否可读写等）
server：服务端能力描述（不同服务类型可扩展）

基类默认认为：所有引擎均支持加载该图层；服务端能力为空。

copyrightString

descriptionString

图层描述

extendPropsObject

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

Default Value:

extensionOptionsObject

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

Default Value:

extentExtent null

图层的范围。从元信息或数据中获取，默认为null表示取不到范围。

forceRefreshDebounceDelayNumber

强制刷新防抖延迟（毫秒）。

某些引擎实现会将刷新请求做合并/防抖处理，该参数用于控制防抖窗口。

Default Value:

headersObject

设置服务请求头

httpMethodFetchMethod

http请求方式

idString

图层id

loadErrorObject

请求失败后的错误信息，toJSON方法不会导出该属性

Default Value:

loadStatusString

图层加载状态

Default Value:

loadedBoolean

是否加载完毕

Default Value:

maxScaleNumber

最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。maxScale应该始终小于minScale。

Default Value:

minScaleNumber

最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。minScale应该始终大于maxScale。

Default Value:

opacityNumber

图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。

spatialReferenceSpatialReference null

图层坐标系对象

titleString

图层名称

tokenAttachTypeTokenAttachType

token附加类型。默认 post 请求优先附加到 body，get 请求优先附加到 url 末尾。

tokenKeyString

token名

Default Value:

tokenValueString

token值

typeLayerType

图层类型

visibleBoolean

图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件

Events

inherited layer-update document/layer/baseLayer/Layer.js, line 126

图层属性更新事件。

当调用 refresh()、setProperty() 或图层内部主动触发更新时，会向 Map/View 分发该事件。该事件主要用于渲染层同步图层状态。

Properties:

Name Type Description

event

LayerViewUpdateEvent

事件对象

Properties

Name	Type	Default	Description
`type`	String	'layer-update'	可选事件类型
`layer`	Layer		可选图层对象
`updateContent`	Array.<Object>		可选更新详情

Example

Create Layer instance

// ES5 import style
const { Layer } = zondy

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

inherited layerview-created document/layer/baseLayer/Layer.js, line 52

图层在视图中创建完毕事件。

当图层被添加到 View，并且该引擎对应的图层视图对象创建成功后触发。

Properties:

Name Type Description

event

Object

事件对象

Properties

Name	Type	Default	Description
`type`	String	'layerview-created'	可选事件类型
`message`	String	null	可选描述信息
`layer`	Layer	null	可选图层对象
`layerView`	*	null	可选图层视图对象（不同引擎类型不同）
`sourceTarget`	*	null	可选事件发起对象
`target`	*	null	可选事件接收对象（通常为 View/Map）

Example

layer.on('layerview-created', (event) => {
  console.log('图层视图创建完毕', event.layer, event.layerView)
})

inherited layerview-remove document/layer/baseLayer/Layer.js, line 71

图层从视图中移除事件。

当图层从 View 移除，并且对应的图层视图对象已释放后触发。

Properties:

Name Type Description

event

Object

事件对象

Properties

Name	Type	Default	Description
`type`	String	'layerview-remove'	可选事件类型
`message`	String	null	可选描述信息
`layer`	Layer	null	可选图层对象
`layerView`	*	null	可选图层视图对象
`sourceTarget`	*	null	可选事件发起对象
`target`	*	null	可选事件接收对象（通常为 View/Map）

Example

layer.on('layerview-remove', (event) => {
  console.log('图层视图已移除', event.layer)
})

inherited layerview-scale-visible document/layer/baseLayer/Layer.js, line 109

图层比例尺显示/隐藏状态更新事件。

该事件由 View 层在比例尺变化导致图层显示状态（因 minScale/maxScale 约束）变化时触发。当前仅支持非组图层以及场景子图层。

Properties:

Name Type Description

event

Object

事件对象

Properties

Name	Type	Default	Description
`type`	String	'layerview-scale-visible'	可选事件类型
`target`	*		可选事件接收对象
`sourceTarget`	*		可选事件发起对象

Example

layer.on('layerview-scale-visible', (event) => {
  console.log('比例尺可见性变更', event)
})

inherited layerview-update document/layer/baseLayer/Layer.js, line 90

图层视图更新事件。

该事件通常由 View 层触发，用于通知外部“渲染层已完成一次图层更新”。 event.updateContent 中会描述本次更新涉及的属性或方法（例如：visible、opacity、refresh）。

Properties:

Name Type Description

event

LayerViewUpdateEvent

事件对象

Properties

Name	Type	Description
`updateContent`	Array.<Object>	可选更新详情数组

Example

layer.on('layerview-update', (event) => {
  const updateContent = event.updateContent || []
  const hasVisibleChange = updateContent.some((c) => c.name === 'visible')
  const hasOpacityChange = updateContent.some((c) => c.name === 'opacity')
  const hasRefresh = updateContent.some((c) => c.name === 'refresh')
  console.log('更新完毕', { hasVisibleChange, hasOpacityChange, hasRefresh })
})

Methods

clone(){OverlayLayer} document/layer/overLay/OverlayLayer.js, line 51

克隆并返回一个新图层

Returns:

Type	Description
OverlayLayer	新的图层对象

inherited destroy(){void} document/layer/baseLayer/Layer.js, line 594

销毁图层。

基类不做具体释放逻辑，子类可根据需要重写（例如：释放请求、解绑引擎对象等）。

Returns:

Type	Description
void

inherited getProperty(path){*} document/layer/baseLayer/Layer.js, line 825

获取属性或属性路径对应的值。

Name	Type	Description
`path`	String	属性路径

Returns:

Type	Description
*	属性值

inherited isLoaded(){Boolean} document/layer/baseLayer/Layer.js, line 530

判断图层是否加载成功

Returns:

Type	Description
Boolean	图层是否加载成功

inherited load(){Promise.<Layer>} document/layer/baseLayer/Layer.js, line 534

图层资源加载。

默认实现会调用内部 _load()，并维护 loadStatus/loaded/loadError 等状态字段。子类通常通过重写 _load() 来实现“请求元数据/初始化参数”的业务逻辑。

Returns:

Type	Description
Promise.<Layer>	加载完成后的图层对象（resolve 为当前实例）

inherited refresh(){void} document/layer/baseLayer/Layer.js, line 743

刷新图层。

该方法会触发 layer-update 事件（若图层已添加到地图且已加载），用于通知渲染层重新拉取/绘制。

Returns:

Type	Description
void

inherited setMap(map){void} document/layer/baseLayer/Layer.js, line 581

设置图层所属的地图/场景管理容器。

该方法通常由 Map 在添加图层时调用，外部一般无需手动调用。

Name	Type	Description
`map`	*	地图/场景管理对象（不同引擎类型不同）

Returns:

Type	Description
void

inherited setProperty(path, value){Boolean} document/layer/baseLayer/Layer.js, line 777

设置属性值或属性路径对应的值。

由于默认仅支持第一级属性响应，此方法提供“属性路径”写入能力。例如：setProperty('tileInfo.startLevel', 3) 可更新 tileInfo.startLevel。

若设置的是多级属性路径，会额外触发一次 layer-update 事件（updateContent.name 为路径字符串）。

Name	Type	Description
`path`	String	属性路径，可以传入单个属性后者一个属性的路径
`value`	*

Returns:

Type	Description
Boolean	是否设置成功

toJSON(){Object} document/layer/overLay/OverlayLayer.js, line 42

将图层转为json对象

Returns:

Type	Description
Object	josn对象

OverlayLayer.fromJSON(json){OverlayLayer} document/layer/overLay/OverlayLayer.js, line 60

通过json构造OverlayLayer对象

Name	Type	Description
`json`	Object	json对象

Returns:

Type	Description
OverlayLayer	OverlayLayer实例

Class: OverlayLayer

new OverlayLayer(options)

Extends

Members

autoAddTo2DBoolean

autoAddTo3DBoolean

capabilitiesObject

copyrightString

descriptionString

extendPropsObject

extensionOptionsObject

extentExtent null

forceRefreshDebounceDelayNumber

headersObject

httpMethodFetchMethod

idString

loadErrorObject

loadStatusString

loadedBoolean

maxScaleNumber

minScaleNumber

opacityNumber

spatialReferenceSpatialReference null

titleString

tokenAttachTypeTokenAttachType

tokenKeyString

tokenValueString

typeLayerType

visibleBoolean

Events

inherited layer-update

Properties:

Properties

Example

inherited layerview-created

Properties:

Properties

Example

inherited layerview-remove

Properties:

Properties

Example

inherited layerview-scale-visible

Properties:

Properties

Example

inherited layerview-update

Properties:

Properties

Example

Methods

clone(){OverlayLayer}

Returns:

inherited destroy(){void}

Returns:

inherited getProperty(path){*}

Returns:

inherited isLoaded(){Boolean}

Returns:

inherited load(){Promise.<Layer>}

Returns:

inherited refresh(){void}

Returns:

inherited setMap(map){void}

Returns:

inherited setProperty(path, value){Boolean}

Returns:

toJSON(){Object}

Returns:

OverlayLayer.fromJSON(json){OverlayLayer}

Returns: