Interface TiledBackgroundOptions

Options for a tiled background.

interface TiledBackgroundOptions {
    height?: number;
    img?: HTMLImageElement;
    maxZoom?: number;
    onBackgroundReady?: OnBackgroundReadyCallback;
    panDebounceTimeout?: number;
    tileSize?: Size;
    tiling?: "absolute" | "logarithmic";
    type: string;
    url?: string;
    urlGenerator?: ((z: number, x: number, y: number) => string);
    visible?: boolean;
    width?: number;
    zoomDebounceTimeout?: number;
}

Hierarchy (view full)

Properties

height? img? maxZoom? onBackgroundReady? panDebounceTimeout? tileSize? tiling? type url? urlGenerator? visible? width? zoomDebounceTimeout?

Properties

Optionalheight

height?: number

Required for tiled backgrounds. Indicates the height of the full image.

Optionalimg

img?: HTMLImageElement

For simple backgrounds, the image to use. Optional; you can also supply a url.

OptionalmaxZoom

maxZoom?: number

Required for tiled backgrounds. Indicates the maximum zoom level. Zoom starts at 0 - fully zoomed out - and increases in integer values from there. Each successive zoom level is twice the zoom of the previous level, meaning two times as many tiles in each direction.

OptionalonBackgroundReady

onBackgroundReady?: OnBackgroundReadyCallback

Optional function to call when the image has loaded (or otherwise claims to be ready)

OptionalpanDebounceTimeout

panDebounceTimeout?: number

For tiled backgrounds, how long to wait after a pan before reloading tiles.

OptionaltileSize

tileSize?: Size

For tiled backgrounds, provides the width and height of tiles. Every tile is assumed to have these dimensions, even if the tile has whitespace in it. You must supply this if you set type to BackgroundTypes.tiled`.

Optionaltiling

tiling?: "absolute" | "logarithmic"

Default is TilingStrategies.logarithmic. See notes for TilingStrategies enum.

type

type: string

Type of background to render.

Optionalurl

url?: string

URL for the background. When type is set to BackgroundTypes.simple you can supply either this, or an Image. When type is set to BackgroundTypes.tiled, you can supply this, or you can supply a urlGenerator function instead. If you supply url and no urlGenerator, the url you supply is treated as a template for the url for any given tile, and is expected to contain {z}, {x} and {y} placeholders. The form of the URL can be anything you like as long as it has the placeholders for z, x and y. For instance:

http://foo.com/{z}/{x}/{y} https://bar.com?zoom={z}&x={x}&y={y}

etc

OptionalurlGenerator

urlGenerator?: ((z: number, x: number, y: number) => string)

For tiled backgrounds, an optional function you can supply to generate the URL for a given tile. See url for an explanation of the default syntax for urls when using a tiled background.

Optionalvisible

visible?: boolean

Whether or not the background should initially be visible. Defaults to true.

Optionalwidth

width?: number

Required for tiled backgrounds. Indicates the width of the full image.

OptionalzoomDebounceTimeout

zoomDebounceTimeout?: number

For tiled backgrounds, how long to wait after a zoom before reloading tiles.

Settings

Member Visibility

On This Page

Properties
Version :