Skip to main content

Home > @jsplumbtoolkit/browser-ui-plugin-background > TiledBackgroundOptions

TiledBackgroundOptions interface

Signature:

export interface TiledBackgroundOptions extends ImageBackgroundOptions 

Extends: ImageBackgroundOptions

Properties

PropertyModifiersTypeDescription
height?number(Optional) Required for tiled backgrounds. Indicates the height of the full image.
maxZoom?number(Optional) 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.
panDebounceTimeout?number(Optional) For tiled backgrounds, how long to wait after a pan before reloading tiles.
tileSize?Size(Optional) 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`.
tiling?TilingStrategy(Optional) Default is TilingStrategies.logarithmic. See notes for TilingStrategies enum.
urlGenerator?(z: number, x: number, y: number) => string(Optional) 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.
width?number(Optional) Required for tiled backgrounds. Indicates the width of the full image.
zoomDebounceTimeout?number(Optional) For tiled backgrounds, how long to wait after a zoom before reloading tiles.