ImageLayer
查阅Leaflet API

new mars2d.layer.ImageLayer(options)
layer/tileLayer/ImageLayer.js 30

单张图片 图层

参数名称 类型 描述信息
options Object

参数对象，包括以下：

参数名称 类型 默认值 描述信息
url String

图片url地址
subdomains String | Array.<String> 可选

URL模板中用于 {s} 占位符的子域。 如果此参数是单个字符串，则字符串中的每个字符都是一个子域。如果是 一个数组，数组中的每个元素都是一个子域。
rectangle Object 可选

瓦片数据的矩形区域范围

参数名称 类型 描述信息
xmin Number

最小经度值, -180 至 180
xmax Number

最大纬度值, -180 至 180
ymin Number

最小纬度值, -90 至 90
ymax Number

最大纬度值, -90 至 90
bbox Array.<Number> 可选

bbox规范的瓦片数据的矩形区域范围,与rectangle二选一即可。
bounds L.LatLngBounds 可选

leaflet原生写法，同rectangle或bbox
opacity Number 1 可选

瓦片的不透明度。
interactive Boolean false 可选

如果true，当点击或悬停时，图像叠加层将发出鼠标事件mouse events 。
crossOrigin Boolean false 可选

如果为true，则所有图块将其crossOrigin属性设置为“*”。如果要访问像素数据，则需要这样做。
zIndex Number 可选

css的叠加顺序
id String | Number createGuid() 可选

图层id标识
pid String | Number -1 可选

图层父级的id，一般图层管理中使用
name String '' 可选

图层名称
show Boolean true 可选

图层是否显示
pane String 'tilePane' 可选

指定图层添加到地图的哪个pane的DIV中，用于控制不同层级显示的，优先级高于zIndex。
参考:

继承

  • L.ImageOverlay

成员(属性)

readonly hasOpacity : boolean
layer/tileLayer/ImageLayer.js 202

是否可以调整透明度

readonly hasZIndex : Boolean
layer/tileLayer/ImageLayer.js 167

是否可以调整图层顺序（在同类型图层间）

id : String|Number
layer/tileLayer/ImageLayer.js 104

对象的id标识

readonly isAdded : Boolean
layer/tileLayer/ImageLayer.js 82

是否已添加到地图

name : String
layer/tileLayer/ImageLayer.js 117

名称 标识

opacity : Number
layer/tileLayer/ImageLayer.js 188

透明度

pid : String|Number
layer/tileLayer/ImageLayer.js 91

对象的pid标识

show : Boolean
layer/tileLayer/ImageLayer.js 130

显示隐藏状态

url : String
layer/tileLayer/ImageLayer.js 152

图层服务地址

zIndex : Number
layer/tileLayer/ImageLayer.js 175

图层顺序，数字大的在上面。

方法

addEventParent(obj) → ImageLayer
layer/tileLayer/ImageLayer.js 541

添加抛出事件到父类，它将接收传播的事件

参数名称 类型 描述信息
obj Object

父类对象
返回值:

当前对象本身,可以链式调用

addTo(map) → ImageLayer
layer/tileLayer/ImageLayer.js 295

将图层添加到地图

参数名称 类型 描述信息
map Map

地图对象
返回值:

当前对象本身，可以链式调用

bindContextMenu(contextmenuItems) → Map
layer/tileLayer/ImageLayer.js 448

绑定右键菜单

参数名称 类型 描述信息
contextmenuItems Array.<Object>

右键菜单数组
返回值:

当前对象本身，可以链式调用

bindPopup(content, options) → ImageLayer
layer/tileLayer/ImageLayer.js 314

绑定Popup弹窗配置

参数名称 类型 描述信息
content String | HTMLElement | function | L.Popup

Popup弹窗内容
options Map.PopupOptions | Object 可选

Popup弹窗参数
返回值:

当前对象本身，可以链式调用

bindTooltip(content, options) → ImageLayer
layer/tileLayer/ImageLayer.js 381

绑定Tooltip弹窗配置

参数名称 类型 描述信息
content String | HTMLElement | function | L.Tooltip

Tooltip弹窗内容
options Map.TooltipOptions | Object 可选

Tooltip弹窗参数
返回值:

当前对象本身，可以链式调用

bringToBack() → ImageLayer
layer/tileLayer/ImageLayer.js 257

将图层置于所有图层之下

返回值:

当前对象本身,可以链式调用

bringToFront() → ImageLayer
layer/tileLayer/ImageLayer.js 248

将图层置于所有图层之上

返回值:

当前对象本身,可以链式调用

closePopup() → ImageLayer
layer/tileLayer/ImageLayer.js 344

关闭打开的弹窗

返回值:

当前对象本身，可以链式调用

closeTooltip() → ImageLayer
layer/tileLayer/ImageLayer.js 411

关闭打开的弹窗

返回值:

当前对象本身，可以链式调用

fire(type, data, propagate) → void
layer/tileLayer/ImageLayer.js 502

触发指定类型的事件。

参数名称 类型 默认值 描述信息
type String | EventType

事件类型
data Object 可选

传输的数据或对象，可在事件回调方法中event对象中获取进行使用
propagate BaseClass | Object null 可选

将事件传播给父类 (用addEventParent设置)
返回值:

无

getBounds() → L.LatLngBounds
layer/tileLayer/ImageLayer.js 286

获取图层矩形边界

返回值:

矩形边界

getContextMenu() → Array.<Object>
layer/tileLayer/ImageLayer.js 458

获取绑定的右键菜单

返回值:

右键菜单数组

getPopup() → L.Popup
layer/tileLayer/ImageLayer.js 372

获取当前绑定在图层上的Popup弹窗对象

返回值:

Popup弹窗对象

getTooltip() → L.Tooltip
layer/tileLayer/ImageLayer.js 439

获取当前绑定在图层上的Tooltip弹窗对象

返回值:

Tooltip弹窗对象

isPopupOpen() → boolean
layer/tileLayer/ImageLayer.js 353

当前绑定的弹窗是是否打开

返回值:

是否打开弹窗

isTooltipOpen() → boolean
layer/tileLayer/ImageLayer.js 420

当前绑定的弹窗是是否打开

返回值:

是否打开弹窗

listens(type, propagate) → Boolean
layer/tileLayer/ImageLayer.js 529

是否有绑定指定的事件

参数名称 类型 描述信息
type String | EventType

事件类型
propagate Object 可选

是否判断指定的父类 (用addEventParent设置的)
返回值:

是否存在

off(types, fn, context) → void
layer/tileLayer/ImageLayer.js 489

解除绑定指定类型事件监听器

参数名称 类型 描述信息
types String | EventType | Object 可选

事件类型，Object时删除一组类型/侦听器对。
fn function 可选

绑定的监听器回调方法
context Object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

无

on(type, fn, context) → void
layer/tileLayer/ImageLayer.js 476

绑定指定类型事件监听器

参数名称 类型 描述信息
type String | EventType | Object

事件类型，当是Object时可以添加一组类型/侦听器对，例如 {click: onClick, mousemove: onMouseMove}
fn function 可选

绑定的监听器回调方法
context Object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

无

once(types, fn, context) → void
layer/tileLayer/ImageLayer.js 515

绑定一次性执行的指定类型事件监听器 与on类似，监听器只会被触发一次，然后被删除。

参数名称 类型 描述信息
types String | EventType | Object 可选

事件类型，Object时删除一组类型/侦听器对。
fn function 可选

绑定的监听器回调方法
context Object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

无

openPopup(latlng) → ImageLayer
layer/tileLayer/ImageLayer.js 334

打开Popup弹窗

参数名称 类型 描述信息
latlng L.LatLng 可选

位置,如果latlng没有设置则在默认的所在位置打开。
返回值:

当前对象本身，可以链式调用

openTooltip(latlng) → ImageLayer
layer/tileLayer/ImageLayer.js 401

打开Tooltip弹窗

参数名称 类型 描述信息
latlng L.LatLng 可选

位置,如果latlng没有设置则在默认的所在位置打开。
返回值:

当前对象本身，可以链式调用

remove() → ImageLayer
layer/tileLayer/ImageLayer.js 305

将图层从地图上移除

返回值:

当前对象本身，可以链式调用

removeEventParent(obj) → ImageLayer
layer/tileLayer/ImageLayer.js 551

移除抛出事件到父类

参数名称 类型 描述信息
obj Object

父类对象
返回值:

当前对象本身,可以链式调用

setBounds(bounds) → ImageLayer
layer/tileLayer/ImageLayer.js 276

设置图层矩形边界

参数名称 类型 描述信息
bounds L.LatLngBounds

矩形边界
返回值:

当前对象本身,可以链式调用

setOpacity(opacity) → ImageLayer
layer/tileLayer/ImageLayer.js 266

设置覆盖的透明度

参数名称 类型 描述信息
opacity Number

透明度，取值范围 0-1
返回值:

当前对象本身,可以链式调用

setPopupContent(content) → ImageLayer
layer/tileLayer/ImageLayer.js 362

设定绑定在图层上的弹窗的内容

参数名称 类型 描述信息
content String | HTMLElement | L.Popup

Popup弹窗内容
返回值:

当前对象本身，可以链式调用

setTooltipContent(content) → ImageLayer
layer/tileLayer/ImageLayer.js 429

设定绑定在图层上的弹窗的内容

参数名称 类型 描述信息
content String | HTMLElement | L.Tooltip

Tooltip弹窗内容
返回值:

当前对象本身，可以链式调用

unbindContextMenu() → Map
layer/tileLayer/ImageLayer.js 467

解除绑定右键菜单

返回值:

当前对象本身，可以链式调用

unbindPopup() → ImageLayer
layer/tileLayer/ImageLayer.js 325

解除绑定Popup弹窗配置

返回值:

当前对象本身，可以链式调用

unbindTooltip() → ImageLayer
layer/tileLayer/ImageLayer.js 392

解除绑定Tooltip弹窗配置

返回值:

当前对象本身，可以链式调用

定义的类型

mars2d.layer.ImageLayer.EventType
layer/tileLayer/ImageLayer.js 5

当前类支持的EventType事件类型（包括自定义字符串事件名）

属性:
属性名称 类型 描述信息
click String

当用户单击（or taps）地图时触发
dblclick String

当用户双击（or double-taps）地图时触发
mousedown String

当用户在图层上按下鼠标按钮时触发
mouseover String

当鼠标进入图层时触发
mouseout String

当鼠标离开图层时触发
add String

在图层添加到地图上之后触发
remove String

在图层从地图上移除之后触发
popupopen String

当绑定到当前图层的Popup弹窗打开时触发
popupclose String

当绑定到当前图层的Popup弹窗关闭时触发
tooltipopen String

当Tooltip提示框绑定到这个图层并打开时触发
tooltipclose String

当Tooltip提示框绑定到这个图层并关闭时触发
使用示例:
//绑定监听事件
imageLayer.on('click', function (event) {
  console.log('触发了事件',event)
});
参考: