Add transition option to OSM and CartoDB sources, document default

This commit is contained in:
Maximilian Krög
2020-11-07 22:31:31 +01:00
parent bdd343e87b
commit 2ebe90f9d3
4 changed files with 10 additions and 4 deletions

View File

@@ -27,6 +27,8 @@ import {assign} from '../obj.js';
* See http://docs.cartodb.com/cartodb-platform/maps-api/named-maps/
* for more detail.
* @property {string} account If using named maps, this will be the name of the template to load.
* @property {number} [transition=250] Duration of the opacity transition for rendering.
* To disable the opacity transition, pass `transition: 0`.
*/
/**
@@ -52,6 +54,7 @@ class CartoDB extends XYZ {
maxZoom: options.maxZoom !== undefined ? options.maxZoom : 18,
minZoom: options.minZoom,
projection: options.projection,
transition: options.transition,
wrapX: options.wrapX,
});

View File

@@ -34,6 +34,8 @@ export const ATTRIBUTION =
* imageTile.getImage().src = src;
* };
* ```
* @property {number} [transition=250] Duration of the opacity transition for rendering.
* To disable the opacity transition, pass `transition: 0`.
* @property {string} [url='https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png'] URL template.
* Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
* @property {boolean} [wrapX=true] Whether to wrap the world horizontally.
@@ -68,16 +70,17 @@ class OSM extends XYZ {
super({
attributions: attributions,
attributionsCollapsible: false,
cacheSize: options.cacheSize,
crossOrigin: crossOrigin,
imageSmoothing: options.imageSmoothing,
opaque: options.opaque !== undefined ? options.opaque : true,
maxZoom: options.maxZoom !== undefined ? options.maxZoom : 19,
opaque: options.opaque !== undefined ? options.opaque : true,
reprojectionErrorThreshold: options.reprojectionErrorThreshold,
tileLoadFunction: options.tileLoadFunction,
transition: options.transition,
url: url,
wrapX: options.wrapX,
attributionsCollapsible: false,
});
}
}

View File

@@ -100,7 +100,7 @@ const ProviderConfig = {
* imageTile.getImage().src = src;
* };
* ```
* @property {number} [transition] Duration of the opacity transition for rendering.
* @property {number} [transition=250] Duration of the opacity transition for rendering.
* To disable the opacity transition, pass `transition: 0`.
* @property {string} [url] URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
* @property {boolean} [wrapX=true] Whether to wrap the world horizontally.

View File

@@ -42,7 +42,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
* may be used instead of defining each one separately in the `urls` option.
* @property {Array<string>} [urls] An array of URL templates.
* @property {boolean} [wrapX=true] Whether to wrap the world horizontally.
* @property {number} [transition] Duration of the opacity transition for rendering.
* @property {number} [transition=250] Duration of the opacity transition for rendering.
* To disable the opacity transition, pass `transition: 0`.
* @property {number} [zDirection=0] Indicate which resolution should be used
* by a renderer if the view resolution does not match any resolution of the tile source.