ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #10322 from mike-000/patch-6

Browse Source 
Update tile grid option descriptions
This commit is contained in:
Andreas Hocevar
2019-11-21 00:10:27 +01:00
committed by GitHub
parent 32932a7fd3 8865f22020
commit a990b8e0bf
2 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/tilegrid/TileGrid.js
+9 -3
View File
@@ -25,17 +25,23 @@ const tmpTileCoord = [0, 0, 0];
* `origins` are configured, the `origin` will be set to the top-left corner of the extent. * `origins` are configured, the `origin` will be set to the top-left corner of the extent.
* @property {number} [minZoom=0] Minimum zoom. * @property {number} [minZoom=0] Minimum zoom.
* @property {import("../coordinate.js").Coordinate} [origin] The tile grid origin, i.e. where the `x` * @property {import("../coordinate.js").Coordinate} [origin] The tile grid origin, i.e. where the `x`
* and `y` axes meet (`[z, 0, 0]`). Tile coordinates increase left to right and upwards. If not * and `y` axes meet (`[z, 0, 0]`). Tile coordinates increase left to right and downwards. If not
* specified, `extent` or `origins` must be provided. * specified, `extent` or `origins` must be provided.
* @property {Array<import("../coordinate.js").Coordinate>} [origins] Tile grid origins, i.e. where * @property {Array<import("../coordinate.js").Coordinate>} [origins] Tile grid origins, i.e. where
* the `x` and `y` axes meet (`[z, 0, 0]`), for each zoom level. If given, the array length * the `x` and `y` axes meet (`[z, 0, 0]`), 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 * should match the length of the `resolutions` array, i.e. each resolution can have a different
* origin. Tile coordinates increase left to right and upwards. If not specified, `extent` or * origin. Tile coordinates increase left to right and downwards. If not specified, `extent` or
* `origin` must be provided. * `origin` must be provided.
* @property {!Array<number>} resolutions Resolutions. The array index of each resolution needs * @property {!Array<number>} resolutions Resolutions. The array index of each resolution needs
* to match the zoom level. This means that even if a `minZoom` is configured, the resolutions * to match the zoom level. This means that even if a `minZoom` is configured, the resolutions
* array will have a length of `maxZoom + 1`. * array will have a length of `maxZoom + 1`.
* @property {Array<import("../size.js").Size>} [sizes] Sizes. * @property {Array<import("../size.js").Size>} [sizes] 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` or `origins`.
* A grid `extent` 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 as `origin` or `origins`, then the `y` value must be
* negative because OpenLayers tile coordinates use the top left as the origin.
* @property {number|import("../size.js").Size} [tileSize] Tile size. * @property {number|import("../size.js").Size} [tileSize] Tile size.
* Default is `[256, 256]`. * Default is `[256, 256]`.
* @property {Array<import("../size.js").Size>} [tileSizes] Tile sizes. If given, the array length * @property {Array<import("../size.js").Size>} [tileSizes] Tile sizes. If given, the array length
src/ol/tilegrid/WMTS.js
+5 -10
View File
@@ -15,12 +15,12 @@ import TileGrid from './TileGrid.js';
* top-left corner of the extent. * top-left corner of the extent.
* @property {import("../coordinate.js").Coordinate} [origin] The tile grid origin, i.e. * @property {import("../coordinate.js").Coordinate} [origin] The tile grid origin, i.e.
* where the `x` and `y` axes meet (`[z, 0, 0]`). Tile coordinates increase left * where the `x` and `y` axes meet (`[z, 0, 0]`). Tile coordinates increase left
* to right and upwards. If not specified, `extent` or `origins` must be provided. * to right and downwards. If not specified, `extent` or `origins` must be provided.
* @property {Array<import("../coordinate.js").Coordinate>} [origins] Tile grid origins, * @property {Array<import("../coordinate.js").Coordinate>} [origins] Tile grid origins,
* i.e. where the `x` and `y` axes meet (`[z, 0, 0]`), for each zoom level. If * i.e. where the `x` and `y` axes meet (`[z, 0, 0]`), for each zoom level. If
* given, the array length should match the length of the `resolutions` array, i.e. * given, the array length should match the length of the `resolutions` array, i.e.
* each resolution can have a different origin. Tile coordinates increase left to * each resolution can have a different origin. Tile coordinates increase left to
* right and upwards. If not specified, `extent` or `origin` must be provided. * right and downwards. If not specified, `extent` or `origin` must be provided.
* @property {!Array<number>} resolutions Resolutions. The array index of each * @property {!Array<number>} resolutions Resolutions. The array index of each
* resolution needs to match the zoom level. This means that even if a `minZoom` * 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` * is configured, the resolutions array will have a length of `maxZoom + 1`
@@ -29,19 +29,14 @@ import TileGrid from './TileGrid.js';
* @property {Array<import("../size.js").Size>} [sizes] Number of tile rows and columns * @property {Array<import("../size.js").Size>} [sizes] Number of tile rows and columns
* of the grid for each zoom level. The values here are the `TileMatrixWidth` and * of the grid for each zoom level. The values here are the `TileMatrixWidth` and
* `TileMatrixHeight` advertised in the GetCapabilities response of the WMTS, and * `TileMatrixHeight` advertised in the GetCapabilities response of the WMTS, and
* define the grid's extent together with the `origin`. * define each zoom level's extent together with the `origin` or `origins`.
* An `extent` can be configured in addition, and will further limit the extent for * A grid `extent` 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 * which tile requests are made by sources. If the bottom-left corner of
* the `extent` is used as `origin` or `origins`, then the `y` value must be * an extent is used as `origin` or `origins`, then the `y` value must be
* negative because OpenLayers tile coordinates use the top left as the origin. * negative because OpenLayers tile coordinates use the top left as the origin.
* @property {number|import("../size.js").Size} [tileSize] Tile size. * @property {number|import("../size.js").Size} [tileSize] Tile size.
* @property {Array<import("../size.js").Size>} [tileSizes] Tile sizes. The length of * @property {Array<import("../size.js").Size>} [tileSizes] Tile sizes. The length of
* this array needs to match the length of the `resolutions` array. * this array needs to match the length of the `resolutions` array.
* @property {Array<number>} [widths] 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.
*/ */