Module type for ol.Size

This commit is contained in:
Frederic Junod
2018-04-19 15:43:37 +02:00
parent 32713ff824
commit 8074848636
4 changed files with 4 additions and 4 deletions

View File

@@ -13,7 +13,7 @@ import ImageSource from '../source/Image.js';
* The function returning the canvas element used by the source
* as an image. The arguments passed to the function are: `{module:ol/extent~Extent}` the
* image extent, `{number}` the image resolution, `{number}` the device pixel
* ratio, `{ol.Size}` the image size, and `{module:ol/proj/Projection~Projection}` the image
* ratio, `{module:ol/size~Size}` the image size, and `{module:ol/proj/Projection~Projection}` the image
* projection. The canvas returned by this function is cached by the source. If
* the value returned by the function is later changed then
* `changed` should be called on the source for the source to

View File

@@ -22,7 +22,7 @@ import ImageSource, {defaultImageLoadFunction} from '../source/Image.js';
* This is the [left, bottom, right, top] map coordinates of your image.
* @property {ol.ImageLoadFunctionType} [imageLoadFunction] Optional function to load an image given a URL.
* @property {module:ol/proj~ProjectionLike} projection Projection.
* @property {ol.Size} [imageSize] Size of the image in pixels. Usually the image size is auto-detected, so this
* @property {module:ol/size~Size} [imageSize] Size of the image in pixels. Usually the image size is auto-detected, so this
* only needs to be set if auto-detection fails for some reason.
* @property {string} url Image URL.
*/

View File

@@ -30,7 +30,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
* For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px
* by 512px images (for retina/hidpi devices) then `tilePixelRatio`
* should be set to `2`.
* @property {number|ol.Size} [tileSize=[256, 256]] The tile size used by the tile service.
* @property {number|module:ol/size~Size} [tileSize=[256, 256]] The tile size used by the tile service.
* @property {ol.TileUrlFunctionType} [tileUrlFunction] Optional function to get
* tile URL given a tile coordinate and the projection.
* Required if url or urls are not provided.

View File

@@ -102,7 +102,7 @@ CustomTile.prototype.getImage = function() {
* A `{?-?}` template pattern, for example `subdomain{a-f}.domain.com`, may be
* used instead of defining each one separately in the `urls` option.
* @property {string} [tierSizeCalculation] Tier size calculation method: `default` or `truncated`.
* @property {ol.Size} [size] Size of the image.
* @property {module:ol/size~Size} [size] Size of the image.
* @property {module:ol/extent~Extent} [extent] Extent for the TileGrid that is created.
* Default sets the TileGrid in the
* fourth quadrant, meaning extent is `[0, -height, width, 0]`. To change the