TileLayer

自定义瓦片图层类,用于加载百度坐标系(BD09MC)的自定义瓦片。 与 XYZLayer 的区别:TileLayer 适用于自有瓦片服务且数据已为百度坐标系,无需坐标转换; XYZLayer 适用于第三方标准瓦片服务(XYZ/WMTS/WMS/TMS),内置 EPSG:3857→BD09MC 坐标转换。

构造函数

  • 创建地图图层实例

    参数类型说明
    opts 可选TileLayerOptions可选参数
    属性类型说明
    boundarystring | string图层掩膜边界数据
    cacheSizenumber瓦片缓存数量,移动端默认128,桌面端默认256
    opacitynumber图层透明度,取值范围0 - 1
    retryboolean瓦片加载失败时是否自动重试
    retryTimenumber重试间隔时间,单位毫秒
    showRegionstring瓦片显示区域模式,'inside' 仅显示掩膜内部,'outside' 仅显示掩膜外部
    tileUrlTemplatestring图块URL模板,支持 {X}、{Y}、{Z} 占位符,分别表示横向坐标、纵向坐标和缩放级别。 若未提供此参数,需实现 TileLayer.getTilesUrl() 方法
    transparentPngboolean图层使用的图片是否为包含透明信息的PNG
    zIndexnumber图层的层叠顺序

    返回值 TileLayer

    示例代码1

    const tileLayer = new BMap.TileLayer({
    tileUrlTemplate: 'https://yourhost/tile?x={X}&y={Y}&z={Z}.png',
    transparentPng: true,
    });
    map.addLayer(tileLayer);

方法

  • 设置图层掩膜,在掩膜区域内显示瓦片

    参数类型说明
    boundarystring掩膜边界坐标字符串或字符串数组

    返回值 void

    示例代码1

    tileLayer.addBoundary('北京市');
    
  • 清空图层掩膜

    返回值 void

  • 清除瓦片缓存并强制重新加载

    返回值 void

    示例代码1

    tileLayer.clearCache();
    
  • 返回指定图块坐标和缩放级别的瓦片图片URL。 若在 TileLayerOptions 中提供了 tileUrlTemplate 则可不实现此方法

    参数类型说明
    tileCoordPixel图块坐标
    zoomnumber缩放级别

    返回值 string

    示例代码1

    const tileLayer = new BMap.TileLayer();
    tileLayer.getTilesUrl = function(tileCoord, zoom) {
    return `https://yourhost/tile?x=${tileCoord.x}&y=${tileCoord.y}&z=${zoom}.png`;
    };
  • 隐藏图层

    返回值 void

    示例代码1

    tileLayer.hide();
    
  • 返回图层所用图片是否为包含透明信息的PNG格式

    返回值 boolean

  • 返回图层是否可见

    返回值 boolean

  • 设置图层的叠加顺序

    参数类型说明
    zIndexnumber层级值

    返回值 void

    示例代码1

    tileLayer.setZIndex(5);
    
  • 将图层移至最顶层

    返回值 void

    示例代码1

    tileLayer.setZIndexTop();
    
  • 显示图层

    返回值 void

    示例代码1

    tileLayer.show();