OpenLayers 3 API Documentation

Class: XYZ

ol.tilegrid.XYZ

Set the grid pattern for sources accessing XYZ tiled-image servers.

new ol.tilegrid.XYZ(options) experimental

src/ol/tilegrid/xyztilegrid.js, line 26
Name Type Description
options

XYZ options.

Name Type Description
extent ol.Extent | undefined experimental

Extent for the tile grid. The origin for an XYZ tile grid is the top-left corner of the extent. The zero level of the grid is defined by the resolution at which one tile fits in the provided extent. If not provided, the extent of the EPSG:3857 projection is used.
maxZoom number | undefined experimental

Maximum zoom. The default is ol.DEFAULT_MAX_ZOOM. This determines the number of levels in the grid set. For example, a maxZoom of 21 means there are 22 levels in the grid set.
minZoom number | undefined experimental

Minimum zoom. Default is 0.
tileSize number | undefined experimental

Tile size in pixels. Default is 256. (Only square tiles are supported.)

Extends

Methods

getMaxZoom(){number} inherited experimental

src/ol/tilegrid/tilegrid.js, line 155
Returns:
Max zoom.

getMinZoom(){number} inherited experimental

src/ol/tilegrid/tilegrid.js, line 164
Returns:
Min zoom.

getOrigin(z){ol.Coordinate} inherited

src/ol/tilegrid/tilegrid.js, line 174
Name Type Description
z number

Z.
Returns:
Origin.

getResolution(z){number} inherited

src/ol/tilegrid/tilegrid.js, line 190
Name Type Description
z number

Z.
Returns:
Resolution.

getResolutions(){Array.<number>} inherited

src/ol/tilegrid/tilegrid.js, line 200
Returns:
Resolutions.

getTileCoordForCoordAndResolution(coordinate, resolution, opt_tileCoord){ol.TileCoord} inherited experimental

src/ol/tilegrid/tilegrid.js, line 320

Get the tile coordinate for the given map coordinate and resolution. This method considers that coordinates that intersect tile boundaries should be assigned the higher tile coordinate.

Name Type Description
coordinate ol.Coordinate

Coordinate.
resolution number

Resolution.
tileCoord ol.TileCoord

Destination ol.TileCoord object.
Returns:
Tile coordinate.

getTileCoordForCoordAndZ(coordinate, z, opt_tileCoord){ol.TileCoord} inherited experimental

src/ol/tilegrid/tilegrid.js, line 367
Name Type Description
coordinate ol.Coordinate

Coordinate.
z number

Z.
tileCoord ol.TileCoord

Destination ol.TileCoord object.
Returns:
Tile coordinate.

getTileSize(z){number} inherited

src/ol/tilegrid/tilegrid.js, line 410
Name Type Description
z number

Z.
Returns:
Tile size.