类名 MapImageLayer

# new MapImageLayer(options)

影像图层基类

参数

名称 类型 默认值 描述
options Object

构造参数
minScale Number 0

最小显示比例尺，图层在视图中可见的最小比例尺。
maxScale Number 0

最大显示比例尺，图层在视图中可见的最大比例尺。
tokenKey String

token名
tokenValue String

token值

继承关系

成员变量

成员变量概述

名称 类型 描述
allSublayers Collection

所有子图层信息
allSublayers Collection

所有子图层对象
capabilities String

可提供的服务
capabilities Array

可提供的服务
copyright String

版权所有
description String

图层描述
documentInfo String

地图文档信息
documentInfo String

地图文档信息
dynamicProjectionEnabled Boolean

是否开启动态投影
extendProps Object

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

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

图层范围，从服务中读取，仅会请求在该范围内的瓦片
extent Extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片
extent String

图层范围，从服务中读取，仅会请求在该范围内的瓦片
headers String

设置服务请求头
httpMethod FetchMethod

http请求方式
id String

图层id
imageFormat String

图片格式
imageFormat String

图片格式
imageHeight Number

瓦片化显示时，瓦片高度
imageHeight Number

瓦片化显示时，瓦片高度
imageTransparency Boolean

图片中没有数据的地方是否透明
imageTransparency Boolean

图片中没有数据的地方是否透明
imageWidth Number

瓦片化显示时，瓦片宽度
imageWidth Number

瓦片化显示时，瓦片宽度
index Number

图层顺序
loaded Boolean

是否加载完毕
loadStatus String

图层加载状态
mapName String

地图名称
mapName String

地图名称
maxScale Number

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

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

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

渲染模式，分为瓦片渲染'tile'和图像渲染'image'
renderMode String

渲染模式，分为瓦片渲染'tile'和图像渲染'image'
spatialReference SpatialReference

图层坐标系对象
sublayers Collection

子图层对象
title String

图层名称
tokenAttachType String

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

token名
tokenValue String

token值
type String

图层类型
url String

服务基地址
url String

服务基地址
visible Number

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

成员变量详情

Collection

# allSublayers

所有子图层信息

Collection

# readonly allSublayers

所有子图层对象

String

# readonly capabilities

可提供的服务

Array

# readonly capabilities

可提供的服务

String

版权所有

Overrides:
String

# readonly description

图层描述

Overrides:
String

# readonly documentInfo

地图文档信息

String

# readonly documentInfo

地图文档信息

Boolean

# dynamicProjectionEnabled

是否开启动态投影

Object

# extendProps

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

Overrides:
Default Value:
  • {}
Object

# extensionOptions

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

Overrides:
Default Value:
  • {}
String

# readonly extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片

Overrides:
Extent

# readonly extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片

Overrides:
String

# readonly extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片

Overrides:
String

# headers

设置服务请求头

Overrides:
FetchMethod

# httpMethod

http请求方式

Overrides:
String

# readonly id

图层id

Overrides:
String

# imageFormat

图片格式

String

# imageFormat

图片格式

Number

# imageHeight

瓦片化显示时，瓦片高度

Number

# imageHeight

瓦片化显示时，瓦片高度

Boolean

# imageTransparency

图片中没有数据的地方是否透明

Boolean

# imageTransparency

图片中没有数据的地方是否透明

Number

# imageWidth

瓦片化显示时，瓦片宽度

Number

# imageWidth

瓦片化显示时，瓦片宽度

Number

# index

图层顺序

Overrides:
Boolean

# readonly loaded

是否加载完毕

Overrides:
Default Value:
  • false
String

# readonly loadStatus

图层加载状态

Overrides:
Default Value:
  • not-loaded
String

# readonly mapName

地图名称

String

# readonly mapName

地图名称

Number

# maxScale

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

Overrides:
Default Value:
  • 0
Number

# minScale

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

Overrides:
Default Value:
  • 0
Number

# opacity

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

Overrides:
String

# renderMode

渲染模式，分为瓦片渲染'tile'和图像渲染'image'

String

# renderMode

渲染模式，分为瓦片渲染'tile'和图像渲染'image'

SpatialReference

# spatialReference

图层坐标系对象

Overrides:
Collection

# sublayers

子图层对象

String

# title

图层名称

Overrides:
String

# tokenAttachType

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

Overrides:
String

# tokenKey

token名

Overrides:
Default Value:
  • token
String

# tokenValue

token值

Overrides:
String

# readonly type

图层类型

Overrides:
String

# readonly url

服务基地址

String

# readonly url

服务基地址

Number

# visible

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

Overrides:

方法

方法概述

名称 返回值类型 描述
clone FeatureLayer

克隆方法
clone MapImageLayer

克隆方法
destroy *
isLoaded Boolean

判断图层是否加载成功
off Object

移除事件
示例如下:
on Object

注册一个新的监听事件;
示例如下：
refresh

刷新图层
toJSON Object

转换为json对象
toJSON Object

转换为json对象

方法详情

# clone()

克隆方法

Overrides:

图层

FeatureLayer

# clone()

克隆方法

Overrides:

克隆的新图层

MapImageLayer

# destroy()

Overrides:
*

# isLoaded()

判断图层是否加载成功

Overrides:

图层是否加载成功

Boolean

# off(typesopt, fnopt, contextopt)

移除事件
示例如下:
[1、移除一个事件的指定回调函数]
[2、移除一个事件的所有回调函数]
[3、移除多个事件的同一个指定的回调函数]
[4、移除多个指定事件的回调函数]
[5、删除时指定上下文 - types类型为字符串]
[6、删除时指定上下文 - types类型为对象]

参数

名称 类型 描述
types string

移除指定事件类型上绑定的回调函数
当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function

事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
context Object

事件回调函数的this关键字将指向的对象
Overrides:

当前实例

Object
示例

移除一个事件的指定回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction)

移除一个事件的所有回调函数

// 一个事件的回调函数1
const clickFunction1 = function (event) {
  console.log("点击事件1:", event)
}

// 一个事件的回调函数2
const clickFunction2 = function (event) {
  console.log("点击事件2:", event)
}

// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
// 不指定回调函数，则移除该事件上的所有绑定的回调函数
view.off('click')

移除多个事件的同一个指定的回调函数

// 多个事件的同一个回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}
// 调用MapView或SceneView的off方法移除多个事件的同一个指定的回调函数
view.off('click double-click', eventFunction)

移除多个指定事件的回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
})

删除时指定上下文 - types类型为字符串

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction, view)
// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
view.off('click', undefined, view)

删除时指定上下文 - types类型为对象

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
}, view)

# on(typesopt, fnopt, contextopt)

注册一个新的监听事件;
示例如下：
[1、注册一个事件]
[2、一次注册多个事件 - 同一个回调函数]
[3、一次注册多个事件 - 分别指回调应函数]
[4、当types为字符串时 - 指定上下文]
[5、当types为对象时 - 指定上下文]

参数

名称 类型 默认值 描述
types String | Object null

事件类型
当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function null

事件回调函数
context Object null

事件回调函数的this关键字将指向的对象
Overrides:

当前实例

Object
示例

注册一个事件

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的on方法注册一个点击事件
view.on('click', clickFunction)

一次注册多个事件 - 同一个回调函数

// 初始化一个事件回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 多个事件类型使用同一个回调函数
view.on('click right-click-down', eventFunction)

一次注册多个事件 - 分别指回调应函数

// 初始化一个左键点击事件回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}

// 初始化一个右键按下事件回调函数
const rightClickFunction = function (event) {
  console.log("right-click-down事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 每一个事件类型，使用单独的回调函数
// 注意使用此种方式，一种类型的事件仅能指定一个回调函数
view.on({
  "click": clickFunction,
  "right-click-down": rightClickFunction
})

指定上下文 - types类型为字符串

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on('click', clickFunction, view)

指定上下文 - types类型为对象

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on({
  "click": clickFunction,
  "right-click-down": clickFunction
}, view)

# refresh()

刷新图层

Overrides:

# toJSON()

转换为json对象

Overrides:

json对象

Object

# toJSON()

转换为json对象

Overrides:

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

事件接收对象
Overrides:
示例

图层刷新完毕事件

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

事件接收对象
Overrides:
示例

图层加载完毕事件

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

事件接收对象
Overrides:
示例

图层显隐更新完毕事件

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

事件接收对象
Overrides:
示例

图层更新完毕事件

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

事件接收对象
Overrides:
示例

图层透明度更新完毕事件

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

事件接收对象
Overrides:
示例

图层销毁完毕事件

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

事件接收对象
Overrides:
示例

图层顺序更新完毕事件

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);
    }
  }
});

# new MapImageLayer(options)

影像图层基类

参数

名称 类型 默认值 描述
options Object

构造参数
minScale Number 0

最小显示比例尺，图层在视图中可见的最小比例尺。
maxScale Number 0

最大显示比例尺，图层在视图中可见的最大比例尺。
tokenKey String

token名
tokenValue String

token值
url String ''

服务基地址
mapName String ''

地图名称
documentInfo String

服务基地址
renderMode String 'tile'

渲染模式，分为瓦片渲染'tile'和图像渲染'image'
imageWidth Number 'tile'

瓦片化显示时，瓦片宽度
imageHeight Number 'tile'

瓦片化显示时，瓦片高度
imageFormat String 'png'

图片格式
imageTransparency Boolean true

图片中没有数据的地方是否透明
dynamicProjectionEnabled Boolean false

是否开启动态投影

继承关系

成员变量

成员变量概述

名称 类型 描述
allSublayers Collection

所有子图层信息
allSublayers Collection

所有子图层对象
capabilities String

可提供的服务
capabilities Array

可提供的服务
copyright String

版权所有
description String

图层描述
documentInfo String

地图文档信息
documentInfo String

地图文档信息
dynamicProjectionEnabled Boolean

是否开启动态投影
extendProps Object

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

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

图层范围，从服务中读取，仅会请求在该范围内的瓦片
extent Extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片
extent String

图层范围，从服务中读取，仅会请求在该范围内的瓦片
headers String

设置服务请求头
httpMethod FetchMethod

http请求方式
id String

图层id
imageFormat String

图片格式
imageFormat String

图片格式
imageHeight Number

瓦片化显示时，瓦片高度
imageHeight Number

瓦片化显示时，瓦片高度
imageTransparency Boolean

图片中没有数据的地方是否透明
imageTransparency Boolean

图片中没有数据的地方是否透明
imageWidth Number

瓦片化显示时，瓦片宽度
imageWidth Number

瓦片化显示时，瓦片宽度
index Number

图层顺序
loaded Boolean

是否加载完毕
loadStatus String

图层加载状态
mapName String

地图名称
mapName String

地图名称
maxScale Number

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

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

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

渲染模式，分为瓦片渲染'tile'和图像渲染'image'
renderMode String

渲染模式，分为瓦片渲染'tile'和图像渲染'image'
spatialReference SpatialReference

图层坐标系对象
sublayers Collection

子图层对象
title String

图层名称
tokenAttachType String

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

token名
tokenValue String

token值
type String

图层类型
url String

服务基地址
url String

服务基地址
visible Number

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

成员变量详情

Collection

# allSublayers

所有子图层信息

Collection

# readonly allSublayers

所有子图层对象

String

# readonly capabilities

可提供的服务

Array

# readonly capabilities

可提供的服务

String

版权所有

Overrides:
String

# readonly description

图层描述

Overrides:
String

# readonly documentInfo

地图文档信息

String

# readonly documentInfo

地图文档信息

Boolean

# dynamicProjectionEnabled

是否开启动态投影

Object

# extendProps

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

Overrides:
Default Value:
  • {}
Object

# extensionOptions

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

Overrides:
Default Value:
  • {}
String

# readonly extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片

Overrides:
Extent

# readonly extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片

Overrides:
String

# readonly extent

图层范围，从服务中读取，仅会请求在该范围内的瓦片

Overrides:
String

# headers

设置服务请求头

Overrides:
FetchMethod

# httpMethod

http请求方式

Overrides:
String

# readonly id

图层id

Overrides:
String

# imageFormat

图片格式

String

# imageFormat

图片格式

Number

# imageHeight

瓦片化显示时，瓦片高度

Number

# imageHeight

瓦片化显示时，瓦片高度

Boolean

# imageTransparency

图片中没有数据的地方是否透明

Boolean

# imageTransparency

图片中没有数据的地方是否透明

Number

# imageWidth

瓦片化显示时，瓦片宽度

Number

# imageWidth

瓦片化显示时，瓦片宽度

Number

# index

图层顺序

Overrides:
Boolean

# readonly loaded

是否加载完毕

Overrides:
Default Value:
  • false
String

# readonly loadStatus

图层加载状态

Overrides:
Default Value:
  • not-loaded
String

# readonly mapName

地图名称

String

# readonly mapName

地图名称

Number

# maxScale

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

Overrides:
Default Value:
  • 0
Number

# minScale

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

Overrides:
Default Value:
  • 0
Number

# opacity

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

Overrides:
String

# renderMode

渲染模式，分为瓦片渲染'tile'和图像渲染'image'

String

# renderMode

渲染模式，分为瓦片渲染'tile'和图像渲染'image'

SpatialReference

# spatialReference

图层坐标系对象

Overrides:
Collection

# sublayers

子图层对象

String

# title

图层名称

Overrides:
String

# tokenAttachType

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

Overrides:
String

# tokenKey

token名

Overrides:
Default Value:
  • token
String

# tokenValue

token值

Overrides:
String

# readonly type

图层类型

Overrides:
String

# readonly url

服务基地址

String

# readonly url

服务基地址

Number

# visible

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

Overrides:

方法

方法概述

名称 返回值类型 描述
clone FeatureLayer

克隆方法
clone MapImageLayer

克隆方法
destroy *
isLoaded Boolean

判断图层是否加载成功
off Object

移除事件
示例如下:
on Object

注册一个新的监听事件;
示例如下：
refresh

刷新图层
toJSON Object

转换为json对象
toJSON Object

转换为json对象

方法详情

# clone()

克隆方法

Overrides:

图层

FeatureLayer

# clone()

克隆方法

Overrides:

克隆的新图层

MapImageLayer

# destroy()

Overrides:
*

# isLoaded()

判断图层是否加载成功

Overrides:

图层是否加载成功

Boolean

# off(typesopt, fnopt, contextopt)

移除事件
示例如下:
[1、移除一个事件的指定回调函数]
[2、移除一个事件的所有回调函数]
[3、移除多个事件的同一个指定的回调函数]
[4、移除多个指定事件的回调函数]
[5、删除时指定上下文 - types类型为字符串]
[6、删除时指定上下文 - types类型为对象]

参数

名称 类型 描述
types string

移除指定事件类型上绑定的回调函数
当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function

事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
context Object

事件回调函数的this关键字将指向的对象
Overrides:

当前实例

Object
示例

移除一个事件的指定回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction)

移除一个事件的所有回调函数

// 一个事件的回调函数1
const clickFunction1 = function (event) {
  console.log("点击事件1:", event)
}

// 一个事件的回调函数2
const clickFunction2 = function (event) {
  console.log("点击事件2:", event)
}

// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
// 不指定回调函数，则移除该事件上的所有绑定的回调函数
view.off('click')

移除多个事件的同一个指定的回调函数

// 多个事件的同一个回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}
// 调用MapView或SceneView的off方法移除多个事件的同一个指定的回调函数
view.off('click double-click', eventFunction)

移除多个指定事件的回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
})

删除时指定上下文 - types类型为字符串

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction, view)
// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
view.off('click', undefined, view)

删除时指定上下文 - types类型为对象

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
}, view)

# on(typesopt, fnopt, contextopt)

注册一个新的监听事件;
示例如下：
[1、注册一个事件]
[2、一次注册多个事件 - 同一个回调函数]
[3、一次注册多个事件 - 分别指回调应函数]
[4、当types为字符串时 - 指定上下文]
[5、当types为对象时 - 指定上下文]

参数

名称 类型 默认值 描述
types String | Object null

事件类型
当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function null

事件回调函数
context Object null

事件回调函数的this关键字将指向的对象
Overrides:

当前实例

Object
示例

注册一个事件

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的on方法注册一个点击事件
view.on('click', clickFunction)

一次注册多个事件 - 同一个回调函数

// 初始化一个事件回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 多个事件类型使用同一个回调函数
view.on('click right-click-down', eventFunction)

一次注册多个事件 - 分别指回调应函数

// 初始化一个左键点击事件回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}

// 初始化一个右键按下事件回调函数
const rightClickFunction = function (event) {
  console.log("right-click-down事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 每一个事件类型，使用单独的回调函数
// 注意使用此种方式，一种类型的事件仅能指定一个回调函数
view.on({
  "click": clickFunction,
  "right-click-down": rightClickFunction
})

指定上下文 - types类型为字符串

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on('click', clickFunction, view)

指定上下文 - types类型为对象

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on({
  "click": clickFunction,
  "right-click-down": clickFunction
}, view)

# refresh()

刷新图层

Overrides:

# toJSON()

转换为json对象

Overrides:

json对象

Object

# toJSON()

转换为json对象

Overrides:

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

事件接收对象
Overrides:
示例

图层刷新完毕事件

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

事件接收对象
Overrides:
示例

图层加载完毕事件

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

事件接收对象
Overrides:
示例

图层显隐更新完毕事件

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

事件接收对象
Overrides:
示例

图层更新完毕事件

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

事件接收对象
Overrides:
示例

图层透明度更新完毕事件

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

事件接收对象
Overrides:
示例

图层销毁完毕事件

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

事件接收对象
Overrides:
示例

图层顺序更新完毕事件

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);
    }
  }
});