Classes
Type Definitions
-
Options{Object}
-
Properties:
Name Type Argument Default Description extent
module:ol/extent~Extent <optional>
Extent for the tile grid. No tiles outside this extent will be requested by
module:ol/source/Tile~TileSource
sources. When noorigin
ororigins
are configured, theorigin
will be set to the top-left corner of the extent.minZoom
number <optional>
0 Minimum zoom.
origin
module:ol/coordinate~Coordinate <optional>
The tile grid origin, i.e. where the
x
andy
axes meet ([z, 0, 0]
). Tile coordinates increase left to right and downwards. If not specified,extent
ororigins
must be provided.origins
Array.<module:ol/coordinate~Coordinate> <optional>
Tile grid origins, i.e. where the
x
andy
axes meet ([z, 0, 0]
), for each zoom level. If given, the array length should match the length of theresolutions
array, i.e. each resolution can have a different origin. Tile coordinates increase left to right and downwards. If not specified,extent
ororigin
must be provided.resolutions
Array.<number> Resolutions. The array index of each resolution needs to match the zoom level. This means that even if a
minZoom
is configured, the resolutions array will have a length ofmaxZoom + 1
.sizes
Array.<module:ol/size~Size> <optional>
Number of tile rows and columns of the grid for each zoom level. If specified the values define each zoom level's extent together with the
origin
ororigins
. A gridextent
can be configured in addition, and will further limit the extent for which tile requests are made by sources. If the bottom-left corner of an extent is used asorigin
ororigins
, then they
value must be negative because OpenLayers tile coordinates use the top left as the origin.tileSize
number | module:ol/size~Size <optional>
Tile size. Default is
[256, 256]
.tileSizes
Array.<(number|module:ol/size~Size)> <optional>
Tile sizes. If given, the array length should match the length of the
resolutions
array, i.e. each resolution can have a different tile size.