矢量数据图层
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
可选
参数对象,包括以下:
|
参考:
继承
- L.FeatureGroup
成员(属性)
当前图层内的矢量数据数组
是否自动激活编辑(true时,单击后自动激活编辑)
是否可以调整透明度
对象的id标识
是否已添加到地图
是否正在绘制中
是否正在编辑状态
图层内的Graphic矢量数据个数
名称 标识
透明度
对象的pid标识
显示隐藏状态
图层顺序,数字大的在上面。
方法
activateEdit() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 909
激活编辑,绑定相关处理,同 hasEdit=true
返回值:
当前对象本身,可以链式调用
addEventParent(obj) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1369
添加抛出事件到父类,它将接收传播的事件
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
Object |
父类对象 |
返回值:
当前对象本身,可以链式调用
添加Graphic矢量数据
参数名称 | 类型 | 描述信息 |
---|---|---|
graphic |
L.Layer | Object | Array.<L.Layer> |
待添加的矢量数据 或 矢量数据构造参数 |
返回值:
矢量数据
addTo(map) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1133
将图层添加到地图
参数名称 | 类型 | 描述信息 |
---|---|---|
map |
Map |
地图对象 |
返回值:
当前对象本身,可以链式调用
bindContextMenu(contextmenuItems) → Map
layer/graphicLayer/GraphicLayer.js 1276
绑定右键菜单
参数名称 | 类型 | 描述信息 |
---|---|---|
contextmenuItems |
Array.<Object> |
右键菜单数组 |
返回值:
当前对象本身,可以链式调用
bindContextMenu(content) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 560
绑定右键菜单
参数名称 | 类型 | 描述信息 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
content |
Array.<Object> |
右键菜单配置数组,数组中每一项包括:
|
返回值:
当前对象本身,可以链式调用
使用示例:
//在layer上绑定右键菜单
graphicLayer.bindContextMenu([
{
text: "开始编辑对象",
iconCls: "fa fa-edit",
show: function (e) {
let graphic = e.graphic;
if (!graphic || !graphic.editing) {
return false;
}
return !graphic.editing.enabled();
},
callback: function (e) {
let graphic = e.graphic;
if (graphic && graphic.editing) {
graphic.editing.enable();
}
},
},
{
text: "停止编辑对象",
iconCls: "fa fa-edit",
show: function (e) {
let graphic = e.graphic;
if (!graphic || !graphic.editing) {
return false;
}
return graphic.editing.enabled();
},
callback: function (e) {
let graphic = e.graphic;
if (graphic && graphic.editing) {
graphic.editing.disable();
}
},
},
{
text: "删除对象",
iconCls: "fa fa-trash-o",
show: (event) => {
let graphic = event.graphic;
if (!graphic) {
return false;
} else {
return true;
}
},
callback: function (e) {
let graphic = e.graphic;
if (!graphic) {
return;
}
graphicLayer.removeGraphic(graphic);
},
},
]);
bindPopup(content, options) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1152
绑定Popup弹窗配置
参数名称 | 类型 | 描述信息 |
---|---|---|
content |
String | HTMLElement | function | L.Popup |
Popup弹窗内容 |
options |
Map.PopupOptions | Object |
可选
Popup弹窗参数 |
返回值:
当前对象本身,可以链式调用
bindTooltip(content, options) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1209
绑定Tooltip弹窗配置
参数名称 | 类型 | 描述信息 |
---|---|---|
content |
String | HTMLElement | function | L.Tooltip |
Tooltip弹窗内容 |
options |
Map.TooltipOptions | Object |
可选
Tooltip弹窗参数 |
返回值:
当前对象本身,可以链式调用
bringToBack() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1096
将图层置于所有图层之下
返回值:
当前对象本身,可以链式调用
bringToBack() → WfsLayer
layer/graphicLayer/GraphicLayer.js 732
将图层置于所有图层之下
返回值:
当前对象本身,可以链式调用
bringToFront() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1087
将图层置于所有图层之上
返回值:
当前对象本身,可以链式调用
bringToFront() → WfsLayer
layer/graphicLayer/GraphicLayer.js 745
将图层置于所有图层之上
返回值:
当前对象本身,可以链式调用
清除图层内所有矢量数据
返回值:
无
清除正在绘制的对象
返回值:
是否清除了对象
closePopup() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1172
关闭打开的弹窗
返回值:
当前对象本身,可以链式调用
closeTooltip() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1239
关闭打开的弹窗
返回值:
当前对象本身,可以链式调用
销毁当前图层
返回值:
无
disableEdit() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 925
释放编辑,解除绑定相关事件,同 hasEdit=false
返回值:
当前对象本身,可以链式调用
eachGraphic(method, context) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 427
遍历所有矢量数据并将其作为参数传递给回调函数
参数名称 | 类型 | 描述信息 |
---|---|---|
method |
function |
回调方法 |
context |
Object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
endDraw() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 849
完成绘制和编辑,如有未完成的绘制会自动完成。 在移动端需要调用此方法来类似PC端双击结束。
返回值:
当前对象本身,可以链式调用
触发指定类型的事件。
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
type |
String | EventType |
事件类型 |
|
data |
Object |
可选
传输的数据或对象,可在事件回调方法中event对象中获取进行使用 |
|
propagate |
BaseClass | Object |
null
|
可选
将事件传播给父类 (用addEventParent设置) |
返回值:
无
flyTo(options) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 785
执行平滑的飞行动画,移动缩放地图范围至指定的数据范围
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
可选
定位参数,包括:
|
返回值:
当前对象本身,可以链式调用
获取图层矩形边界
返回值:
矩形边界
获取绑定的右键菜单
返回值:
右键菜单数组
获取绑定的右键菜单数组
返回值:
右键菜单数组
根据id取矢量数据对象
参数名称 | 类型 | 描述信息 |
---|---|---|
id |
Number | String |
矢量数据id |
返回值:
矢量数据对象
获取图层内 所有矢量数据
返回值:
矢量数据数组
获取当前绑定在图层上的Popup弹窗对象
返回值:
Popup弹窗对象
获取当前绑定在图层上的Tooltip弹窗对象
返回值:
Tooltip弹窗对象
是否有绑定的右键菜单
返回值:
当前对象本身,可以链式调用
是否包含Graphic矢量数据
参数名称 | 类型 | 描述信息 |
---|---|---|
graphic |
* |
矢量数据 |
返回值:
是否包含
是否存在Popup绑定
返回值:
是否存在Popup绑定
是否绑定了tooltip
返回值:
是否绑定
当前绑定的弹窗是是否打开
返回值:
是否打开弹窗
当前绑定的弹窗是是否打开
返回值:
是否打开弹窗
是否有绑定指定的事件
参数名称 | 类型 | 描述信息 |
---|---|---|
type |
String | EventType |
事件类型 |
propagate |
Object |
可选
是否判断指定的父类 (用addEventParent设置的) |
返回值:
是否存在
loadGeoJSON(geojson, options) → Array.<Marker>|Array.<Polyline>|Array.<Polygon>|Array.<Circle>|Array.<Rectangle>|*
layer/graphicLayer/GraphicLayer.js 663
加载转换GeoJSON格式规范数据为Graphic后加载到图层中。
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
geojson |
String | Object |
GeoJSON格式规范数据 |
||||||||||||||||||||||||||||||||
options |
Object |
可选
加载控制参数,包含:
|
返回值:
转换后的Graphic对象数组
解除绑定指定类型事件监听器
参数名称 | 类型 | 描述信息 |
---|---|---|
types |
String | EventType | Object |
可选
事件类型,Object时删除一组类型/侦听器对。 |
fn |
function |
可选
绑定的监听器回调方法 |
context |
Object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
无
绑定指定类型事件监听器
参数名称 | 类型 | 描述信息 |
---|---|---|
type |
String | EventType | Object |
事件类型,当是Object时可以添加一组类型/侦听器对,例如 {click: onClick, mousemove: onMouseMove} |
fn |
function |
可选
绑定的监听器回调方法 |
context |
Object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
无
绑定一次性执行的指定类型事件监听器 与on类似,监听器只会被触发一次,然后被删除。
参数名称 | 类型 | 描述信息 |
---|---|---|
types |
String | EventType | Object |
可选
事件类型,Object时删除一组类型/侦听器对。 |
fn |
function |
可选
绑定的监听器回调方法 |
context |
Object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
无
openPopup(graphic, latlng) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 760
打开Popup弹窗
参数名称 | 类型 | 描述信息 |
---|---|---|
graphic |
Marker | Polyline | Polygon | * |
矢量数据 |
latlng |
L.LatLng |
可选
指定弹出的位置 |
返回值:
当前对象本身,可以链式调用
openTooltip(latlng) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1229
打开Tooltip弹窗
参数名称 | 类型 | 描述信息 |
---|---|---|
latlng |
L.LatLng |
可选
位置,如果latlng没有设置则在默认的所在位置打开。 |
返回值:
当前对象本身,可以链式调用
remove() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1143
将图层从地图上移除
返回值:
当前对象本身,可以链式调用
removeEventParent(obj) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1379
移除抛出事件到父类
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
Object |
父类对象 |
返回值:
当前对象本身,可以链式调用
removeGraphic(graphic) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 406
移除Graphic矢量数据
参数名称 | 类型 | 描述信息 |
---|---|---|
graphic |
L.Layer |
矢量数据 |
返回值:
当前对象本身,可以链式调用
setOpacity(opacity) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 474
设置覆盖的透明度
参数名称 | 类型 | 描述信息 |
---|---|---|
opacity |
Number |
透明度,取值范围 0-1 |
返回值:
当前对象本身,可以链式调用
setPopupContent(content) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1190
设定绑定在图层上的弹窗的内容
参数名称 | 类型 | 描述信息 |
---|---|---|
content |
String | HTMLElement | L.Popup |
Popup弹窗内容 |
返回值:
当前对象本身,可以链式调用
setTooltipContent(content) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1257
设定绑定在图层上的弹窗的内容
参数名称 | 类型 | 描述信息 |
---|---|---|
content |
String | HTMLElement | L.Tooltip |
Tooltip弹窗内容 |
返回值:
当前对象本身,可以链式调用
setZIndex(zIndex) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1123
调用setZIndex此组中包含的每个图层,传递z-index。
参数名称 | 类型 | 描述信息 |
---|---|---|
zIndex |
Number |
图层顺序值 |
返回值:
当前对象本身,可以链式调用
开始绘制矢量数据,绘制的数据会加载在当前图层。
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Graphic构造参数,包含:
|
返回值:
创建完成的矢量数据对象
startEditing(graphic) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1034
激活编辑指定的矢量数据
参数名称 | 类型 | 描述信息 |
---|---|---|
graphic |
Marker | Polyline | Polygon | Circle | Rectangle | * |
需要激活编辑的矢量数据 |
返回值:
当前对象本身,可以链式调用
停止绘制。 线面对象:未完成的绘制会自动删除,已绘制的会完成在最后一个点位; 点状对象:会结束停留在最后一个点位,未完成的绘制会自动删除 如果需要清除正在绘制的对象,请用 clearDrawing() 方法
返回值:
是否清除了未完成的对象
stopEditing(graphic) → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1055
停止编辑,释放正在编辑的对象。
参数名称 | 类型 | 描述信息 |
---|---|---|
graphic |
Marker | Polyline | Polygon | Circle | Rectangle | * |
可选
需要停止编辑的矢量数据,默认为上一次正在编辑的对象 |
返回值:
当前对象本身,可以链式调用
将图层内的矢量数据转为GeoJSON格式对象
返回值:
返回GeoJSON格式对象(作为GeoJSON GeometryCollection)。
将图层数据导出为GeoJSON格式规范对象。
参数名称 | 类型 | 描述信息 |
---|---|---|
options |
Object |
可选
参数对象: 预留参数 |
返回值:
GeoJSON格式规范对象
将图层转为Json简单对象,用于存储后再传参加载
返回值:
Json简单对象
unbindContextMenu() → Map
layer/graphicLayer/GraphicLayer.js 1295
解除绑定右键菜单
返回值:
当前对象本身,可以链式调用
unbindContextMenu() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 568
解除绑定的右键菜单
返回值:
当前对象本身,可以链式调用
unbindPopup() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1163
解除绑定Popup弹窗配置
返回值:
当前对象本身,可以链式调用
unbindTooltip() → GraphicLayer
layer/graphicLayer/GraphicLayer.js 1220
解除绑定Tooltip弹窗配置
返回值:
当前对象本身,可以链式调用
定义的类型
当前类支持的EventType
事件类型(包括自定义字符串事件名)
属性:
属性名称 | 类型 | 描述信息 |
---|---|---|
layeradd |
String | 添加矢量数据之后触发 |
layerremove |
String | 移除矢量数据之后触发 |
add |
String | 添加到map地图上之后触发 |
remove |
String | 从地图map上移除之后触发 |
click |
String | 当用户单击(or taps)地图时触发 |
dblclick |
String | 当用户双击(or double-taps)地图时触发 |
mousedown |
String | 当用户在图层上按下鼠标按钮时触发 |
mouseover |
String | 当鼠标进入图层时触发 |
mouseout |
String | 当鼠标离开图层时触发 |
popupopen |
String | 当绑定到当前图层的Popup弹窗打开时触发 |
popupclose |
String | 当绑定到当前图层的Popup弹窗关闭时触发 |
tooltipopen |
String | 当Tooltip提示框绑定到这个图层并打开时触发 |
tooltipclose |
String | 当Tooltip提示框绑定到这个图层并关闭时触发 |
drawStart |
String | 开始绘制 标绘事件 |
drawMouseMove |
String | 正在移动鼠标中,绘制过程中鼠标移动了点 标绘事件 |
drawAddPoint |
String | 绘制过程中增加了点 标绘事件 |
drawRemovePoint |
String | 绘制过程中删除了最后一个点 标绘事件 |
drawCreated |
String | 创建完成 标绘事件 |
editStart |
String | 开始编辑 标绘事件 |
editMouseMove |
String | 正在移动鼠标中,正在编辑拖拽修改点中标绘事件 |
editMovePoint |
String | 编辑修改了点标绘事件 |
editRemovePoint |
String | 编辑删除了点 标绘事件 |
editAddPoint |
String | 编辑增加了中间点标绘事件 |
editStyle |
String | 图上编辑修改了相关style属性 标绘事件 |
editStop |
String | 停止编辑 标绘事件 |
使用示例:
//绑定监听事件
graphicLayer.on('popupopen', function (event) {
console.log('触发了事件',event)
});