DTS二次开发文档

Class: ImageryLayer

ImageryLayer

ImageryLayer 网络图层相关的操作方法，包含WMS、WMTS、MapServer等服务类型
一般通过api.imageryLayer调用其方法

new ImageryLayer()

protected

See:

Extends

Methods

<async> add(data, fn)

添加一个或多个网络地图服务，如WMTS/WMS服务等网络图层服务

Parameters:
Name Type Description
data object | array

图层服务的对象，可以是Object类型或Array类型，对于每一个图层服务对象，支持以下属性：

  • id (string) 必选，图层服务字符串类型的ID

  • url (string) 必选，WMTS/WMS服务的URL地址，例如WMTS GetTile操作的基本URL（用于KVP编码的请求）或tile-URL模板（用于RESTful请求）。 tile-URL模板应包含以下变量:{style}，{TileMatrixSet}，{TileMatrix}，{TileRow}，{TileCol}。如果实际值是硬编码的，或者服务器不需要，则前两个是可选的。 {s}关键字可用于指定子域。

  • xmlPath (string) 可选，获取OGC标准服务的元数据能力文档（Capabilities XML文档）的URL地址，需包含图层、瓦片规则、请求参数等信息，不传则默认从init()方法获取

  • layerName (string) 可选，图层名称，不传则默认从init()方法获取

  • tileMatrixName (string) 可选，如果服务类型是WMTS：tileMatrixName是切片方案，如果服务类型是WMS：tileMatrixName是坐标类型，不传则默认从init()方法获取

  • ogcEPSG (string) 可选，坐标系类型，不传则默认从init()方法获取
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addVTPK(tileLayerId, fn)

给图层服务叠加显示对应VTPK标注

Parameters:
Name Type Description
tileLayerId string

VTPK服务对应图层树上的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

delete(ids, fn)

删除一个或多个ImageryLayer图层对象

Parameters:
Name Type Description
ids string | array

要删除的ImageryLayer对象的ID或者ID数组（可以删除一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

deleteVTPK(tileLayerId, fn)

删除叠加的VTPK标注

Parameters:
Name Type Description
tileLayerId string

VTPK服务对应图层树上的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focus(ids, distance, flyTime, rotation, fn)

自动定位到合适的观察距离

Parameters:
Name Type Description
ids string | array

ImageryLayer图层对象的ID或者ID数组
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

hide(ids, fn)

隐藏一个或多个ImageryLayer图层对象

Parameters:
Name Type Description
ids string | array

ImageryLayer对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

init(option, fn)

添加图层服务前需要先初始化相关参数

Parameters:
Name Type Description
option object

初始化对象，包含图层初始化环境配置和图层范围信息

  • xmlUrl (string) 必选，获取OGC标准服务的元数据能力文档（Capabilities XML文档）的URL地址，需包含图层、瓦片规则、请求参数等信息

  • layerName (string) 必选，图层名称

  • tileMatrixName (string) 必选，如果服务类型是WMTS：tileMatrixName是切片方案，如果服务类型是WMS：tileMatrixName是坐标类型

  • ogcEPSG (string) 必选，坐标系类型

  • cachePath (string) 必选，缓存路径

  • mapMode (boolean) 必选，大地图true，小地图false，默认：小地图false

  • renderMode (number) 必选，渲染模式，取值范围：0：正常（默认值）；1：透明；2：标注；3：贴地
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setDrawBottom(id, fn)

设置ImageryLayer图层置底显示

Parameters:
Name Type Description
id string

置于底部显示的ImageryLayer图层对象的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setDrawOrder(currentLayerId, targetLayerId, fn)

设置两个ImageryLayer图层的绘制顺序，即移动当前ImageryLayer图层到目标ImageryLayer图层的上方位置显示

Parameters:
Name Type Description
currentLayerId string

当前ImageryLayer图层对象的ID，即设置成功后此图层会在目标图层的上方位置显示
targetLayerId string

目标ImageryLayer图层对象的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setDrawTop(id, fn)

设置ImageryLayer图层置顶显示

Parameters:
Name Type Description
id string

置于顶部显示的ImageryLayer图层对象的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setVTPKVisable(tileLayerId, visible, fn)

设置叠加的VTPK标注可见性

Parameters:
Name Type Description
tileLayerId string

VTPK服务对应图层树上的ID
visible boolean

服务可见性，布尔类型
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

show(ids, fn)

显示一个或多个ImageryLayer图层对象

Parameters:
Name Type Description
ids string | array

ImageryLayer对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

updateBegin()

用于批量多次修改对象的属性

在开始修改之前调用updateBegin，然后可以多次调用setXXX方法，最后调用updateEnd提交修改更新数据
注意：
updateBegin不是异步调用，不需要await，也没有回调函数参数

Inherited From:
Overrides:
Example
fdapi.xxx.updateBegin();
for (let i = 0; i < 1000; i++) {
     fdapi.xxx.setColor(i, Color.Yellow);
} 
fdapi.xxx.updateEnd(function () {
     log('update finished!');
});

updateEnd(fn)

用于批量多次修改对象的属性，与updateBegin配套使用
注意：
updateEnd是异步调用，可以用回调函数也可以await

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Inherited From:
Overrides: