ArcGISTileLayer

类名 ArcGISTileLayer

# new ArcGISTileLayer(options)

ArcGIS瓦片图层，
目前二维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，三维上仅支持4326(包括4490，4214以及4610)以及3857坐标系，会自动读取元信息上的坐标系，不需要用户指定，

[ES5引入方式]：
zondy.layer.ArcGISTileLayer()
[ES6引入方式]：
import { ArcGISTileLayer } from "@mapgis/webclient-common"

针对图层的操作请在图层加载完毕事件中进行
Layer.on('layerview-created', function (result) {
console.log("加载完毕:", result.layer)
});
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作
if(layer.loadStatus === 'loaded') {
// 你的业务逻辑
}

参数:

名称	类型	默认值	描述
`options`	Object		构造参数
`url`	String		服务基地址：https://{ip}:{port}/arcgis/rest/services/{serviceName}/MapServer，参考示例：[ArcGIS的瓦片图层示例] 删除图层方法：[删除图层]
`id`	String		图层id，不给则给一个随机的id
`opacity`	Number	1	图层透明度，0到1之间的值，0为完全透明，1为不透明，参考示例：[设置图层透明度]
`visible`	Boolean	true	图层显示或隐藏，true则显示，false则隐藏，参考示例：[设置图层显示或隐藏]
`spatialReference`	SpatialReference		图层坐标系，默认从服务元信息上读取
`minScale`	Number	0	最小显示比例尺，图层在视图中可见的最小比例尺。
`maxScale`	Number	0	最大显示比例尺，图层在视图中可见的最大比例尺。
`tokenKey`	String	'token'	token名
`tokenValue`	String		token值，只有当tokenValue存在时，才会绑定token

绑定事件:

支持如下方法：

[1、加载图层资源]
[2、根据级数以及行列号获取瓦片的url]
[3、将图层转为json对象]
[4、通过传入的json构造并返回一个新的几何对象]
5、导出为json对象
6、克隆几何对象

示例

ArcGIS的瓦片图层示例

// ES5引入方式
const { ArcGISTileLayer } = zondy.layer
// ES6引入方式
import { ArcGISTileLayer } from "@mapgis/webclient-common"
const arcgisTileLayer = new ArcGISTileLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/Tile/{serviceName}/MapServer'
});

设置图层透明度

// ES5引入方式
const { ArcGISTileLayer } = zondy.layer
// ES6引入方式
import { ArcGISTileLayer } from "@mapgis/webclient-common"
// 初始化时设置
const arcgisTileLayer = new ArcGISTileLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/Tile/{serviceName}/MapServer',
  // 设置图层透明度
  opacity: 1.0
});

// 加载完成后设置
arcgisTileLayer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
arcgisTileLayer.opacity = 0.5
})

设置图层显示或隐藏

// ES5引入方式
const { ArcGISTileLayer } = zondy.layer
// ES6引入方式
import { ArcGISTileLayer } from "@mapgis/webclient-common"
// 初始化时设置
const arcgisTileLayer = new ArcGISTileLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/Tile/{serviceName}/MapServer',
  // 设置图层显示或隐藏
  visible: true
});

// 加载完成后设置
arcgisTileLayer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
  // 设置图层显示或隐藏
  arcgisTileLayer.visible = !arcgisTileLayer.visible
})

删除图层

map.remove(arcgisTileLayer)

图层顺序

// 加载完毕后，更改图层顺序
map.reorder(arcgisTileLayer, '要移动到的index');

继承关系

Layer

成员变量

类型: String

# readonly copyright

Inherited From:

Layer#copyright

类型: String

# readonly description

图层描述

Overrides:

Layer#description

类型: Object

# extendProps

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

Inherited From:

Layer#extendProps

Default Value:

{}

类型: Object

# extensionOptions

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

Inherited From:

Layer#extensionOptions

Default Value:

{}

类型: Extent

# readonly extent

图层范围，从服务元信息中获取

Overrides:

Layer#extent

类型: String

# headers

设置服务请求头

Inherited From:

Layer#headers

类型: FetchMethod

# httpMethod

http请求方式

Inherited From:

Layer#httpMethod

类型: String

# readonly id

图层id

Inherited From:

Layer#id

类型: Number

# index

图层顺序

Inherited From:

Layer#index

类型: Boolean

# readonly loaded

是否加载完毕

Overrides:

Layer#loaded

Default Value:

false

类型: String

# readonly loadStatus

图层加载状态

Overrides:

Layer#loadStatus

Default Value:

not-loaded

类型: String

# mapName

服务名称

类型: Number

# maxScale

最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。

Inherited From:

Layer#maxScale

Default Value:

类型: Number

# minScale

最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。

Inherited From:

Layer#minScale

Default Value:

类型: Number

# opacity

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

Inherited From:

Layer#opacity

类型: SpatialReference

# spatialReference

图层坐标系对象

Overrides:

Layer#spatialReference

类型: String

# title

图层名称

Inherited From:

Layer#title

类型: String

# tokenAttachType

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

Inherited From:

Layer#tokenAttachType

类型: String

# tokenKey

token名

Inherited From:

Layer#tokenKey

Default Value:

token

类型: String

# tokenValue

token值

Inherited From:

Layer#tokenValue

类型: String

# readonly type

图层类型

Overrides:

Layer#type

类型: String

# url

服务基地址

类型: Number

# visible

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

Inherited From:

Layer#visible

方法

# static fromJSON(jsonopt)

通过传入的json构造并返回一个新的ArcGISTileLayer对象

参数:

名称	类型	描述
`json`	Object	JSON对象

返回值:

新的ArcGISTileLayer对象

类型: ArcGISTileLayer

示例

通过传入的json构造并返回一个新的几何对象

// ES5引入方式
const { ArcGISTileLayer } = zondy.layer
// ES6引入方式
import { ArcGISTileLayer } from "@mapgis/webclient-common"
const json = {
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/Tile/{serviceName}/MapServer'
}
const arcgisTileLayer = new ArcGISTileLayer.fromJSON(json)

# clone()

克隆方法

Inherited From:

Layer#clone

返回值:

图层

类型: Layer

# destroy()

Inherited From:

Layer#destroy

返回值:

类型: *

# getTileUrl(level, row, col)

根据级数以及行列号获取瓦片的url

参数:

名称	类型	描述
`level`	Number	瓦片级数
`row`	Number	行号
`col`	Number	列号

返回值:

瓦片请求地址

类型: String

示例

根据级数以及行列号获取瓦片的url

const url = arcgisTileLayer.getTileUrl(0, 1, 2)

# isLoaded()

判断图层是否加载成功

Inherited From:

Layer#isLoaded

返回值:

图层是否加载成功

类型: Boolean

# refresh()

刷新图层

Inherited From:

Layer#refresh

# toJSON()

转换为json对象

Inherited From:

Layer#toJSON

返回值:

json对象

类型: Object

事件

# 图层刷新完毕事件

图层刷新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:

Name	Type	Attributes	Default	Description
`event`	Object			事件对象
`type`	String	<optional>	'layerview-update'	图层更新完毕事件
`message`	String	<optional>	null	更新描述
`updateContent`	Array.<UpdateContent>	<optional>	null	更新详情对象
`layer`	Layer	<optional>	null	地图图层对象
`layerView`	MapView	<optional>	null	图层的视图对象
`sourceTarget`	Layer	<optional>	null	事件发起对象
`target`	Map	<optional>	null	事件接收对象

Inherited From:

Layer#event:图层刷新完毕事件

示例

图层刷新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层刷新完毕事件
    if(updateContent[i].name === 'refresh'){
      console.log("图层刷新完毕事件:", event);
    }
  }
});

# 图层加载完毕事件

图层加载完毕事件

属性:

Name	Type	Attributes	Default	Description
`event`	Object			事件对象
`type`	String	<optional>	'layerview-created'	图层加载完毕事件
`message`	String	<optional>	null	更新描述
`UpdateContent`	Array.<UpdateContent>	<optional>	null	更新详情对象
`layer`	Layer	<optional>	null	地图图层对象
`layerView`	MapView	<optional>	null	图层的视图对象
`sourceTarget`	Layer	<optional>	null	事件发起对象
`target`	Map	<optional>	null	事件接收对象

Inherited From:

Layer#event:图层加载完毕事件

示例

图层加载完毕事件

Layer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
});

# 图层显隐更新完毕事件

图层显隐更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:

Name	Type	Attributes	Default	Description
`event`	Object			事件对象
`type`	String	<optional>	'layerview-update'	图层更新完毕事件
`message`	String	<optional>	null	更新描述
`updateContent`	Array.<UpdateContent>	<optional>	null	更新详情对象
`layer`	Layer	<optional>	null	地图图层对象
`layerView`	MapView	<optional>	null	图层的视图对象
`sourceTarget`	Layer	<optional>	null	事件发起对象
`target`	Map	<optional>	null	事件接收对象

Inherited From:

Layer#event:图层显隐更新完毕事件

示例

图层显隐更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层显隐事件
    if(updateContent[i].name === 'visible'){
      console.log("图层显隐更新事件:", event);
    }
  }
});

# 图层更新完毕事件

图层更新完毕事件

属性:

Name	Type	Attributes	Default	Description
`event`	Object			事件对象
`type`	String	<optional>	'layerview-update'	图层更新完毕事件
`message`	String	<optional>	null	更新描述
`updateContent`	Array.<UpdateContent>	<optional>	null	更新详情对象
`layer`	Layer	<optional>	null	地图图层对象
`layerView`	MapView	<optional>	null	图层的视图对象
`sourceTarget`	Layer	<optional>	null	事件发起对象
`target`	Map	<optional>	null	事件接收对象

Inherited From:

Layer#event:图层更新完毕事件

示例

图层更新完毕事件

Layer.on('layerview-update', function (result) {
  console.log("更新完毕:", result.layer)
});

# 图层透明度更新完毕事件

图层透明度更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:

Name	Type	Attributes	Default	Description
`event`	Object			事件对象
`type`	String	<optional>	'layerview-update'	图层更新完毕事件
`message`	String	<optional>	null	更新描述
`updateContent`	Array.<UpdateContent>	<optional>	null	更新详情对象
`layer`	Layer	<optional>	null	地图图层对象
`layerView`	MapView	<optional>	null	图层的视图对象
`sourceTarget`	Layer	<optional>	null	事件发起对象
`target`	Map	<optional>	null	事件接收对象

Inherited From:

Layer#event:图层透明度更新完毕事件

示例

图层透明度更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层透明度更新事件
    if(updateContent[i].name === 'opacity'){
      console.log("图层透明度更新事件:", event);
    }
  }
});

# 图层销毁完毕事件

图层销毁完毕事件

属性:

Name	Type	Attributes	Default	Description
`event`	Object			事件对象
`type`	String	<optional>	'layerview-remove'	图层销毁完毕事件
`message`	String	<optional>	null	更新描述
`updateContent`	Array.<UpdateContent>	<optional>	null	更新详情对象
`layer`	Layer	<optional>	null	要销毁的地图图层对象
`layerView`	MapView	<optional>	null	图层的视图对象
`sourceTarget`	Layer	<optional>	null	事件发起对象
`target`	Map	<optional>	null	事件接收对象

Inherited From:

Layer#event:图层销毁完毕事件

示例

图层销毁完毕事件

Layer.on('layerview-remove', function (result) {
  console.log("销毁完毕:", result.layer)
});

# 图层顺序更新完毕事件

图层顺序更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:

Name	Type	Attributes	Default	Description
`event`	Object			事件对象
`type`	String	<optional>	'layerview-update'	图层更新完毕事件
`message`	String	<optional>	null	更新描述
`updateContent`	Array.<UpdateContent>	<optional>	null	更新详情对象
`layer`	Layer	<optional>	null	地图图层对象
`layerView`	MapView	<optional>	null	图层的视图对象
`sourceTarget`	Layer	<optional>	null	事件发起对象
`target`	Map	<optional>	null	事件接收对象

Inherited From:

Layer#event:图层顺序更新完毕事件

示例

图层顺序更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层顺序更新完毕事件
    if(updateContent[i].name === 'index'){
      console.log("图层顺序更新完毕事件:", event);
    }
  }
});

构造函数

成员变量

方法

事件

MapGIS Client for JavaScript API

# new ArcGISTileLayer(options)

参数:

支持如下方法：

示例

继承关系

成员变量

# readonly copyright

# readonly description

# extendProps

# extensionOptions

# readonly extent

# headers

# httpMethod

# readonly id

# index

# readonly loaded

# readonly loadStatus

# mapName

# maxScale

# minScale

# opacity

# spatialReference

# title

# tokenAttachType

# tokenKey

# tokenValue

# readonly type

# url

# visible

方法

# static fromJSON(jsonopt)

参数:

示例

# clone()

# destroy()

# getTileUrl(level, row, col)

参数:

示例

# isLoaded()

# refresh()

# toJSON()

事件

# 图层刷新完毕事件

属性:

示例

图层刷新完毕事件

# 图层加载完毕事件

属性:

示例

# 图层显隐更新完毕事件

属性:

示例

图层显隐更新完毕事件

# 图层更新完毕事件

属性:

示例

# 图层透明度更新完毕事件

属性:

示例

图层透明度更新完毕事件

# 图层销毁完毕事件

属性:

示例

# 图层顺序更新完毕事件

属性:

示例

图层顺序更新完毕事件