Class: TerrainCacheLayer

// ES5引入方式
const { TerrainCacheLayer } = zondy.layer

// ES6引入方式
import { TerrainCacheLayer } from "@mapgis/webclient-common"
// 初始化地形图层对象

terrainCacheLayer = new TerrainCacheLayer({
  url: 'http://10.10.130.72:8200/3DData/TerrainCache/HubeiTerrain/'
});

Extends

• Layer

Members

autoAddTo2DBoolean

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

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

Default Value:

true

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(){TerrainCacheLayer}

document/layer/TerrainCacheLayer.js, line 214

克隆当前地形缓存图层。

会基于当前实例的序列化结果创建新的图层对象。

Returns:

Type	Description
TerrainCacheLayer	克隆后的地形缓存图层对象。

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	图层是否加载成功

load(){Promise.<TerrainCacheLayer>}

document/layer/TerrainCacheLayer.js, line 139

加载地形服务元信息。

调用后会请求地形服务配置，并在成功后补充图层范围、标题和加载状态等运行时信息。

Returns:

Type	Description
Promise.<TerrainCacheLayer>	Promise 对象，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/TerrainCacheLayer.js, line 180

导出为 JSON 配置。

返回结果包含地形服务地址和法向量请求配置，可用于持久化或克隆图层。

Returns:

Type	Description
Object	图层配置对象。

TerrainCacheLayer.fromJSON(json){TerrainCacheLayer}

document/layer/TerrainCacheLayer.js, line 197

通过 JSON 配置创建一个地形缓存图层实例。

适用于从持久化配置恢复图层对象；返回实例会被直接标记为已加载状态。

Name	Type	Default	Description
json	Object	{}	可选 图层配置对象。

Returns:

Type	Description
TerrainCacheLayer	新的地形缓存图层对象。

TerrainCacheLayer.fromServerUrl(url){TerrainCacheLayer}

document/layer/TerrainCacheLayer.js, line 227

通过服务地址快速创建一个地形缓存图层。

适用于仅已知服务地址、后续再补充其他配置的场景。

Name	Type	Description
url	String	服务基地址。

Returns:

Type	Description
TerrainCacheLayer	新的地形缓存图层对象。