OpenLayers 3 API Documentation

Class: TileGrid

ol.tilegrid.TileGrid

Base class for setting the grid pattern for sources accessing tiled-image servers.

new ol.tilegrid.TileGrid(options)

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

Tile grid options.

Name Type Description
minZoom number | undefined experimental

Minimum zoom. Default is 0.
origin ol.Coordinate | undefined

Origin. Default is null.
origins Array.<ol.Coordinate> | undefined

Origins. If given, the array should match the resolutions array, i.e. each resolution can have a different origin.
resolutions Array.<number>

Resolutions.
tileSize number | undefined

Tile size. Default is 256. (Only square tiles are supported.)
tileSizes Array.<number> | undefined

Tile sizes. If given, the array should match the resolutions array, i.e. each resolution can have a different tile size.

Subclasses

Methods

getMaxZoom(){number} experimental

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

getMinZoom(){number} experimental

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

getOrigin(z){ol.Coordinate}

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

Z.
Returns:
Origin.

getResolution(z){number}

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

Z.
Returns:
Resolution.

getResolutions(){Array.<number>}

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

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

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

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} experimental

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

Coordinate.
z number

Z.
tileCoord ol.TileCoord

Destination ol.TileCoord object.
Returns:
Tile coordinate.

getTileSize(z){number}

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

Z.
Returns:
Tile size.