OpenLayers 3

Namespace: tilegrid

olx.tilegrid

Type Definitions

olx.tilegrid.TileGridOptions{Object} experimental

Properties:
Name Type Argument Description
extent ol.Extent | undefined <optional>

Extent for the tile grid. No tiles outside this extent will be requested by ol.source.Tile sources. When no origin or origins are configured, the origin will be set to the bottom-left corner of the extent. When no sizes are configured, they will be calculated from the extent.
minZoom number | undefined <optional>

Minimum zoom. Default is 0.
origin ol.Coordinate | undefined <optional>

Origin, i.e. the bottom-left corner of the grid. Default is null.
origins Array.<ol.Coordinate> | undefined <optional>

Origins, i.e. the bottom-left corners of the grid for each zoom level. If given, the array length should match the length of the resolutions array, i.e. each resolution can have a different origin.
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 of maxZoom + 1.
tileSize number | ol.Size | undefined <optional>

Tile size. Default is [256, 256].
tileSizes Array.<(number|ol.Size)> | undefined <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.

olx.tilegrid.WMTSOptions{Object} experimental

Properties:
Name Type Argument Description
extent ol.Extent | undefined <optional>

Extent for the tile grid. No tiles outside this extent will be requested by ol.source.WMTS sources. When no origin or origins are configured, the origin will be calculated from the extent. When no sizes are configured, they will be calculated from the extent.
origin ol.Coordinate | undefined <optional>

Origin, i.e. the top-left corner of the grid.
origins Array.<ol.Coordinate> | undefined <optional>

Origins, i.e. the top-left corners of the grid for each zoom level. The length of this array needs to match the length of the resolutions array.
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 of maxZoom + 1
matrixIds Array.<string>

matrix IDs. The length of this array needs to match the length of the resolutions array.
sizes Array.<ol.Size> | undefined <optional>

Number of tile rows and columns of the grid for each zoom level. The values here are the TileMatrixWidth and TileMatrixHeight advertised in the GetCapabilities response of the WMTS, and define the grid's extent together with the origin. An extent can be configured in addition, and will further limit the extent for which tile requests are made by sources.
tileSize number | ol.Size | undefined <optional>

Tile size.
tileSizes Array.<(number|ol.Size)> | undefined <optional>

Tile sizes. The length of this array needs to match the length of the resolutions array.
widths Array.<number> | undefined <optional>

Number of tile columns that cover the grid's extent for each zoom level. Only required when used with a source that has wrapX set to true, and only when the grid's origin differs from the one of the projection's extent. The array length has to match the length of the resolutions array, i.e. each resolution will have a matching entry here.

olx.tilegrid.XYZOptions{Object} experimental

Properties:
Name Type Argument Description
extent ol.Extent | undefined <optional>

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 <optional>

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 <optional>

Minimum zoom. Default is 0.
tileSize number | ol.Size | undefined <optional>

Tile size in pixels. Default is [256, 256].

olx.tilegrid.ZoomifyOptions{Object} experimental

Properties:
Name Type Description
resolutions Array.<number>

Resolutions.