MapImageLayer

名称	类型	描述
`types`	string	移除指定事件类型上绑定的回调函数当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"；当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
`fn`	function	事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
`context`	Object	事件回调函数的this关键字将指向的对象

Inherited From:

Evented#off

查看源代码 common/base/Evented.js, line 269

返回值:

当前实例

类型: 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关键字将指向的对象

Inherited From:

Evented#on

查看源代码 common/base/Evented.js, line 173

返回值:

当前实例

类型: 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()

刷新图层

Inherited From:

Layer#refresh

查看源代码 common/document/layer/baseLayer/Layer.js, line 416

# toJSON()

转换为json对象

Overrides:

Layer#toJSON

查看源代码 common/document/layer/baseLayer/MapImageLayer.js, line 113

返回值:

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:图层刷新完毕事件

查看源代码 common/document/layer/baseLayer/Layer.js, line 167

示例

图层刷新完毕事件

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:图层加载完毕事件

查看源代码 common/document/layer/baseLayer/Layer.js, line 35

示例

图层加载完毕事件

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:图层显隐更新完毕事件

查看源代码 common/document/layer/baseLayer/Layer.js, line 86

示例

图层显隐更新完毕事件

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:图层更新完毕事件

查看源代码 common/document/layer/baseLayer/Layer.js, line 69

示例

图层更新完毕事件

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:图层透明度更新完毕事件

查看源代码 common/document/layer/baseLayer/Layer.js, line 113

示例

图层透明度更新完毕事件

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:图层销毁完毕事件

查看源代码 common/document/layer/baseLayer/Layer.js, line 52

示例

图层销毁完毕事件

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:图层顺序更新完毕事件

查看源代码 common/document/layer/baseLayer/Layer.js, line 140

示例

图层顺序更新完毕事件

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 MapImageLayer(options)

参数:

继承关系

成员变量

# allSublayers

# readonly capabilities

# readonly copyright

# readonly description

# readonly documentInfo

# extendProps

# readonly extent

# readonly extent

# httpMethod

# readonly id

# imageFormat

# imageHeight

# imageTransparency

# imageWidth

# index

# readonly loaded

# readonly loadStatus

# readonly mapName

# maxScale

# minScale

# opacity

# renderMode

# spatialReference

# title

# tokenKey

# tokenValue

# readonly type

# readonly url

# visible

方法

# clone()

# isLoaded()

# off(typesopt, fnopt, contextopt)

参数:

示例

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

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

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

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

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

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

# on(typesopt, fnopt, contextopt)

参数:

示例

注册一个事件

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

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

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

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

# refresh()

# toJSON()

事件

# 图层刷新完毕事件

属性:

示例

图层刷新完毕事件

# 图层加载完毕事件

属性:

示例

# 图层显隐更新完毕事件

属性:

示例

图层显隐更新完毕事件

# 图层更新完毕事件

属性:

示例

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

属性:

示例

图层透明度更新完毕事件

# 图层销毁完毕事件

属性:

示例

# 图层顺序更新完毕事件

属性: