Class: ImageryLayer2

ImageryLayer2

ImageryLayer2 球面坐标系下加载网络图层服务 目前支持WMTS、WMS、MVT和TMS
一般通过api.ImageryLayer2调用其方法


new ImageryLayer2()

protected

See:

Extends

Methods


addBySchemaParams(data, fn)

根据图层服务的自定义参数添加一个或多个球面网络地图服务,如WMTS/WMS/MVT/TMS服务等网络图层服务
注意:如果服务类型是0(WMS)或者2(MVT) ,只需传入extent请求范围参数。

Parameters:
Name Type Description
data object | array

球面网络图层服务的对象,可以是Object类型或Array类型,对于每一个图层服务对象,支持以下属性:

  • id (string) 必选,球面网络图层服务字符串类型的ID

  • type (number) 必选,球面网络图层服务类型,0:WMTS 1:WMS 2:MVT 3:TMS

  • resourceURL (string) 必选,申请球面OGC服务资源瓦片或者mvt的style文件的URL地址,如果服务type是MVT类型,resourceURL可以是style文件的内容,此时需要将bResourceURL设置为true

  • epsg (string) 可选,球面服务的坐标系类型

  • alpha (number) 可选,球面网络图层的透明度,取值范围:[0,1]

  • bResourceURL (boolean) 可选,是否是MVT类型资源url,默认值:false

  • bConvertSRGB (boolean) 可选,球面网络图层服务加载时颜色效果是否开启RGB模式转换为SRGB,默认值:true

  • topLeftCornerX (number) 可选,图片的切片的左上角x坐标

  • topLeftCornerY (number) 可选,图片的切片的左上角y坐标

  • tileWidth (number) 可选,瓦片的像素宽度,取值示例:256

  • tileHeight (number) 可选,瓦片的像素高度,取值示例:256

  • extent (array) 可选,图层服务请求的有效范围,取值示例:[xmin, ymin, xmax, ymax],数组内参数依次最小经度值,左下角的经度;最小纬度值,左下角的纬度;最大经度值,左上角的经度;最大纬度值,左上角的纬度

  • minimumLevel (number) 可选,服务的切片的最小层级,默认值:0

  • maximumLevel (number) 可选,服务的切片的最大层级, 最大23

  • scaleDenominator (number) 可选,第0层图像的scaleDenominator值

  • dpi (number) 可选,一个像素代表的实际地面距离,请参考不同GIS平台厂商发布的服务使用的DPI配置值:ArcGIS:90.714 天地图和超图:96

fn function

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


addByUrl(data, fn)

根据图层服务url包含的切片方案xmlPath添加一个或多个球面网络地图服务,如WMTS/WMS/MVT/TMS服务等网络图层服务

Parameters:
Name Type Description
data object | array

球面网络图层服务的对象,可以是Object类型或Array类型,对于每一个图层服务对象,支持以下属性:

  • id (string) 必选,球面网络图层服务字符串类型的ID

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

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

  • type (number) 必选,球面网络图层服务类型,0:WMTS 1:WMS 2:MVT 3:TMS

  • alpha (number) 必选,球面网络图层的透明度,取值范围:[0,1]

  • bConvertSRGB (boolean) 可选,球面网络图层服务加载时颜色效果是否开启RGB模式转换为SRGB,默认值:true

fn function

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


clear(fn)

清除场景中所有的网络图层对象

Parameters:
Name Type Description
fn function

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


delete(ids, fn)

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

Parameters:
Name Type Description
ids string | array

要删除的ImageryLayer2对象的ID或者ID数组(可以删除一个或者多个)

fn function

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


hide(ids, fn)

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

Parameters:
Name Type Description
ids string | array

ImageryLayer2对象的ID或者ID数组

fn function

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


hideAll(fn)

隐藏所有ImageryLayer2图层对象

Parameters:
Name Type Description
fn function

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


setDrawOrder(currentLayerId, targetLayerId, fn)

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

Parameters:
Name Type Description
currentLayerId string

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

targetLayerId string

目标ImageryLayer2图层对象的ID

fn function

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


show(ids, fn)

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

Parameters:
Name Type Description
ids string | array

ImageryLayer2对象的ID或者ID数组

fn function

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


showAll(fn)

显示所有ImageryLayer2图层对象

Parameters:
Name Type Description
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: