RasterTileLayer

栅格瓦片图层,用于加载XYZ/TMS类标准瓦片服务。 支持通过URL模板或回调函数指定瓦片地址,支持子域名轮询、TMS翻转、 范围裁剪、跨级别复用等能力。

构造函数

  • 创建栅格瓦片图层实例

    参数类型说明
    optionsRasterTileLayerOptions栅格瓦片图层配置选项
    属性类型说明
    boundarystring | string[]设置图层掩膜,只在掩膜范围内显示瓦片
    boundsnumber[]加载范围限定,格式为[minX, minY, maxX, maxY],范围外的瓦片不请求
    boundsInWGS84booleanbounds是否为WGS84经纬度坐标。设置为true时bounds值应为经纬度
    cacheSizenumber瓦片缓存数量
    heightnumber瓦片高度
    maxZoomnumber设置图层显示的最大缩放等级
    minZoomnumber设置图层显示的最小缩放等级
    opacitynumber图层透明度,取值范围0 - 1
    projectionstring投影坐标系,仅支持 'EPSG:3857' 或 'BD09MC'
    retryboolean瓦片加载失败时是否重试
    retryTimenumber重试间隔时间(毫秒)
    showRegion"inside" | "outside"图层显示区域模式,配合boundary使用
    spanLevelnumber数据级与地图级的差值
    subdomainsstring[]子域名数组,配合URL模板中的{s}占位符轮询使用
    tileLoadFunctionFunction自定义瓦片加载函数
    urlFunction瓦片地址模板或回调函数(必填)。 模板支持占位符:{x}列号、{y}行号、{z}级别、{s}子域名、{-y}或{reverseY}为TMS翻转的y值。 回调函数签名:(x: number, y: number, z: number) => string
    useThumbDataboolean缩放图层时,是否使用跨级别瓦片复用(防止缩放过渡时闪白)
    zIndexnumber图层层叠顺序

    返回值 RasterTileLayer

    示例代码1:加载OpenStreetMap瓦片

    const rasterLayer = new BMap.RasterTileLayer({
    url: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
    subdomains: ['a', 'b', 'c'],
    maxZoom: 19
    });
    map.addLayer(rasterLayer);

    示例代码2:加载TMS服务(y轴翻转)

    const tmsLayer = new BMap.RasterTileLayer({
    url: 'https://yourhost/tms/{z}/{x}/{-y}.png',
    minZoom: 1,
    maxZoom: 18
    });
    map.addLayer(tmsLayer);

    示例代码3:使用回调函数动态生成瓦片地址

    const layer = new BMap.RasterTileLayer({
    url: function(x, y, z) {
    return 'https://yourhost/tiles/' + z + '/' + x + '/' + y + '.png?token=xxx';
    }
    });
    map.addLayer(layer);

    示例代码4:限定加载范围

    const layer = new BMap.RasterTileLayer({
    url: 'https://yourhost/{z}/{x}/{y}.png',
    bounds: [115.5, 39.0, 117.5, 41.0],
    boundsInWGS84: true
    });
    map.addLayer(layer);

方法

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

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

    返回值 void

  • 清空图层掩膜

    返回值 void

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

    返回值 void

  • 设置图层的叠加顺序

    参数类型说明
    zIndexnumber层级值

    返回值 void