RasterTileLayerOptions

RasterTileLayer构造函数配置参数

interface RasterTileLayerOptions {
    boundary?: string | string[];
    bounds?: number[];
    boundsInWGS84?: boolean;
    cacheSize?: number;
    height?: number;
    maxZoom?: number;
    minZoom?: number;
    opacity?: number;
    projection?: string;
    retry?: boolean;
    retryTime?: number;
    showRegion?: "inside" | "outside";
    spanLevel?: number;
    subdomains?: string[];
    tileLoadFunction?: (tile: HTMLImageElement, url: string) => void;
    url: string | ((x: number, y: number, z: number) => string);
    useThumbData?: boolean;
    zIndex?: number;
}

属性

#boundary?: string | string[]

设置图层掩膜，只在掩膜范围内显示瓦片

#bounds?: number[]

加载范围限定，格式为[minX, minY, maxX, maxY]，范围外的瓦片不请求

#boundsInWGS84?: boolean

bounds是否为WGS84经纬度坐标。设置为true时bounds值应为经纬度，默认值：false

#cacheSize?: number

瓦片缓存数量，默认值：256

#height?: number

瓦片高度，默认值：0

#maxZoom?: number

设置图层显示的最大缩放等级

#minZoom?: number

设置图层显示的最小缩放等级

#opacity?: number

图层透明度，取值范围0 - 1，默认值：1

#projection?: string

投影坐标系，仅支持 'EPSG:3857' 或 'BD09MC'，默认值：'EPSG:3857'

#retry?: boolean

瓦片加载失败时是否重试，默认值：false

#retryTime?: number

重试间隔时间（毫秒）默认值：600

#showRegion?: "inside" | "outside"

图层显示区域模式，配合boundary使用，默认值：'inside'

#spanLevel?: number

数据级与地图级的差值，默认值：0

#subdomains?: string[]

子域名数组，配合URL模板中的{s}占位符轮询使用

示例代码1

['a', 'b', 'c']

#tileLoadFunction?: (tile: HTMLImageElement, url: string) => void

自定义瓦片加载函数

#url: string | ((x: number, y: number, z: number) => string)

瓦片地址模板或回调函数（必填）。模板支持占位符：{x}列号、{y}行号、{z}级别、{s}子域名、{-y}或{reverseY}为TMS翻转的y值。回调函数签名：(x: number, y: number, z: number) => string

示例代码1：模板形式

'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'

示例代码2：回调形式

function(x, y, z) { return 'https://yourhost/' + z + '/' + x + '/' + y + '.png'; }

#useThumbData?: boolean

缩放图层时，是否使用跨级别瓦片复用（防止缩放过渡时闪白）默认值：true

#zIndex?: number

图层层叠顺序