GroundPoint
构造函数
创建贴地点覆盖物，该覆盖物的大小为墨卡托坐标系下的实际大小，屏幕空间的大小会随着地图的缩放级别变化而变化。
参数 类型 说明 pointPoint地理坐标点 opts可选GroundPointOptions可选参数 属性 类型 说明 anchorSize锚点，以图标左上角为原点 levelnumber尺寸参考的缩放级别 offsetSize偏移量 rotationnumber旋转角度，单位度 scalenumber缩放比例 sizeSize坐标点尺寸，单位像素 urlstring图标地址 返回值 GroundPoint
示例代码1
const groundPoint = new BMap.GroundPoint(
new BMap.Point(116.404, 39.915),
{ url: 'https://jsapi-demo.bj.bcebos.com/images/markers/car.png', size: new BMap.Size(30, 60) }
);
map.addOverlay(groundPoint);
方法
add
- addEventListener<K extends keyof GroundOverlayEventMap>(
event: K,
handler: (e: GroundOverlayEventMap[K]) => void,
): void添加事件监听函数
参数 类型 说明 eventK事件名称 handler(e: GroundOverlayEventMap[K]) => void事件处理函数 返回值 void
disable
- disableMassClear(): void
禁止覆盖物在 map.clearOverlays() 方法中被清除
返回值 void
dispose
- dispose(): void
析构方法，当确定覆盖物被移除后不再使用时，可显式调用此方法以降低内存使用
返回值 void
draw
- draw(): void
抽象生命周期方法，当地图状态发生变化时调用，对覆盖物进行绘制。
仅在自定义覆盖物时需要实现此方法。内置覆盖物已在内部实现，用户无需调用也无需重写。
返回值 void
enable
- enableMassClear(): void
允许覆盖物在 map.clearOverlays() 方法中被清除
返回值 void
get
返回图层显示的矩形区域
返回值 Bounds
get
- getDisplayOnMaxLevel(): number
返回图层显示的最大缩放级别
返回值 number
get
- getDisplayOnMinLevel(): number
返回图层显示的最小缩放级别
返回值 number
get
- getImageURL(): string | HTMLCanvasElement
获取图层内容来源，图片或视频类型的结果为资源地址，Canvas 类型的结果为 Canvas 元素
返回值 string | HTMLCanvasElement
get
返回覆盖物所在的地图实例
返回值 Map
get
- getOpacity(): number
返回图层透明度
返回值 number
hide
- hide(): void
隐藏覆盖物。对于自定义覆盖物，此方法会自动将initialize方法返回的HTML元素样式的display属性设置为none
返回值 void
initialize
抽象生命周期方法，用于初始化覆盖物，当调用map.addOverlay时，API内部将调用此方法。
仅在自定义覆盖物时需要实现此方法，并返回覆盖物对应的HTML元素。 内置覆盖物（
Marker、Polyline、Polygon等）已在内部实现，用户无需调用也无需重写。参数 类型 说明 mapMap返回值 HTMLElement
示例代码1
class MyOverlay extends BMap.Overlay {
initialize(map: BMap.Map) {
const div = document.createElement('div');
div.textContent = '自定义覆盖物';
map.getPanes().markerPane.appendChild(div);
return div;
}
draw() {}
}
is
- isVisible(): boolean
判断覆盖物是否可见
返回值 boolean
remove
- removeEventListener<K extends keyof GroundOverlayEventMap>(
event: K,
handler: (e: GroundOverlayEventMap[K]) => void,
): void移除事件监听函数
参数 类型 说明 eventK事件名称 handler(e: GroundOverlayEventMap[K]) => void事件处理函数 返回值 void
设置锚点位置
参数 类型 说明 anchorSize锚点偏移量 update可选boolean是否立即更新渲染 返回值 this
示例代码1
groundPoint.setAnchor(new BMap.Size(16, 16), true);
set
设置图层显示的矩形区域
参数 类型 说明 boundsBounds矩形区域 返回值 void
示例代码2
groundOverlay.setBounds(new BMap.Bounds(
new BMap.Point(116.380, 39.900),
new BMap.Point(116.430, 39.930)
));
set
- setDisplayOnMaxLevel(level: number): void
设置图层显示的最大缩放级别
参数 类型 说明 levelnumber最大级别 返回值 void
示例代码3
groundOverlay.setDisplayOnMaxLevel(18);
set
- setDisplayOnMinLevel(level: number): void
设置图层显示的最小缩放级别
参数 类型 说明 levelnumber最小级别 返回值 void
示例代码4
groundOverlay.setDisplayOnMinLevel(10);
set
设置图层图片地址
参数 类型 说明 urlstring图片URL bounds可选Bounds可选，同时更新叠加的地理范围 返回值 void
示例代码5
groundOverlay.setImage('https://jsapi-demo.bj.bcebos.com/images/markers/marker_demo_9.png');
set
设置偏移量
参数 类型 说明 offsetSize偏移量 update可选boolean是否立即更新渲染 返回值 this
示例代码1
groundPoint.setOffset(new BMap.Size(5, -5), true);
set
- setOpacity(opacity: number): void
设置图层透明度
参数 类型 说明 opacitynumber透明度，取值范围0 - 1 返回值 void
示例代码6
groundOverlay.setOpacity(0.5);
设置覆盖物的地理坐标点
参数 类型 说明 pointPoint地理坐标 update可选boolean是否立即更新渲染 返回值 this
示例代码1
groundPoint.setPoint(new BMap.Point(116.410, 39.920), true);
设置旋转角度
参数 类型 说明 anglenumber旋转角度，单位度 update可选boolean是否立即更新渲染 返回值 this
示例代码1
groundPoint.setRotation(90, true);
设置缩放比例
参数 类型 说明 scalenumber缩放比例 update可选boolean是否立即更新渲染 返回值 this
示例代码1
groundPoint.setScale(1.5, true);
设置图标尺寸
参数 类型 说明 sizeSize尺寸，单位像素 update可选boolean是否立即更新渲染 返回值 this
示例代码1
groundPoint.setSize(new BMap.Size(48, 48), true);
set
- setZIndex(zIndex: number): void
show
- show(): void
显示覆盖物。对于自定义覆盖物，此方法会自动将initialize方法返回的HTML元素样式的display属性设置为空
返回值 void
贴地点覆盖物，继承 GroundOverlay。