区域掩膜覆盖物,用一个多边形区域控制底图、3D 楼块和底图 POI 只在区域内或区域外显示, 被遮住的部分露出地图背景色。掩膜只作用于底图内容,不影响 Marker、Polyline 等覆盖物。

同一地图上的多个掩膜共用一套显示配置,以最后添加的为准; 移除其中任意一个,地图上的掩膜效果会全部关闭。

构造函数

  • 创建区域掩膜。创建后需要调用 map.addOverlay() 添加到地图上才生效, 调用 map.removeOverlay() 移除

    参数类型说明
    pathPoint[]掩膜区域的边界坐标数组(BD09 经纬度),首尾不闭合时会自动闭合
    opts 可选MapMaskOptions可选参数
    属性类型说明
    enableMassClearboolean是否在调用 map.clearOverlays() 时清除此覆盖物
    isBuildingMaskboolean是否对 3D 楼块生效
    isMapMaskboolean是否对底图生效,被遮住的部分露出地图背景色
    isPoiMaskboolean是否对底图 POI 标注生效
    showRegion"inside" | "outside"显示区域。'inside' 表示只显示掩膜区域内的内容,'outside' 表示只显示掩膜区域外的内容

    返回值 MapMask

    示例代码1

    // 只显示区域内的底图、楼块和 POI
    const mask = new BMap.MapMask([
    new BMap.Point(116.38, 39.90),
    new BMap.Point(116.42, 39.90),
    new BMap.Point(116.42, 39.93),
    new BMap.Point(116.38, 39.93),
    ], {
    showRegion: 'inside',
    isMapMask: true,
    isBuildingMask: true,
    isPoiMask: true,
    });
    map.addOverlay(mask);

    示例代码2

    // 挖掉区域内的底图,只显示区域外
    const mask = new BMap.MapMask(path, { showRegion: 'outside', isMapMask: true });
    map.addOverlay(mask);
    // 取消掩膜
    map.removeOverlay(mask);

方法

  • 析构方法,当确定覆盖物被移除后不再使用时,可显式调用此方法以降低内存使用

    返回值 void

  • 抽象生命周期方法,当地图状态发生变化时调用,对覆盖物进行绘制。

    仅在自定义覆盖物时需要实现此方法。内置覆盖物已在内部实现,用户无需调用也无需重写。

    返回值 void

  • 获取当前覆盖物所在的地图对象

    返回值 Map

  • 隐藏覆盖物。对于自定义覆盖物,此方法会自动将initialize方法返回的HTML元素样式的display属性设置为none

    返回值 void

  • 抽象生命周期方法,用于初始化覆盖物,当调用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() {}
    }
  • 判断覆盖物是否可见

    返回值 boolean

  • 显示覆盖物。对于自定义覆盖物,此方法会自动将initialize方法返回的HTML元素样式的display属性设置为空

    返回值 void