ZoomCharts Documentation

Version: 1.21.1 (2024-11-08)

ZoomCharts.Configuration.GeoChartSettingsBackgroundParams

This type matches L.TileLayerOptions type from the Leaflet library.

Methods

This type does not define any methods.

Properties

attribution: string

e.g. "� CloudMade" � the string used by the attribution control, describes the layer data.

Default value: ''.

continuousWorld: boolean

If set to true, the tile coordinates won't be wrapped by world width (-180 to 180 longitude) or clamped to lie within world height (-90 to 90). Use this if you use Leaflet for maps that don't reflect the real world (e.g. game, indoor or photo maps).

Default value: false.

detectRetina: boolean

If true and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.

Default value: false.

errorTileUrl: string

URL to the tile image to show in place of the tile that failed to load.

Default value: ''.

maxNativeZoom: number

Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than maxNativeZoom will be loaded from maxZoom level and auto-scaled.

Default value: null.

maxZoom: number

Maximum zoom number.

Default value: 18.

minZoom: number

Minimum zoom number.

Default value: 0.

noWrap: boolean

If set to true, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.

Default value: false.

opacity: number

The opacity of the tile layer.

Default value: 1.0.

reuseTiles: boolean

If true, all the tiles that are not visible after panning are placed in a reuse queue from which they will be fetched when new tiles become visible (as opposed to dynamically creating new ones). This will in theory keep memory usage low and eliminate the need for reserving new memory whenever a new tile is needed.

Default value: false.

subdomains: string | Array<string>

Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.

Default value: 'abc'.

tileSize: number

Tile size (width and height in pixels, assuming tiles are square).

Default value: 256.

tms: boolean

If true, inverses Y axis numbering for tiles (turn this on for TMS services).

Default value: false.

unloadInvisibleTiles: boolean

If true, all the tiles that are not visible after panning are removed (for better performance). true by default on mobile WebKit, otherwise false.

updateWhenIdle: boolean

If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false.

zIndex: number

The explicit zIndex of the tile layer. Not set by default.

zoomOffset: number

The zoom number used in tile URLs will be offset with this value.

Default value: 0.

zoomReverse: boolean

If set to true, the zoom number used in tile URLs will be reversed (maxZoom

  • zoom instead of zoom)

Default value: false.

X