You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
112 lines
4.4 KiB
112 lines
4.4 KiB
|
3 years ago
|
/**
|
||
|
|
* The attribution containing a link to the OpenStreetMap Copyright and License
|
||
|
|
* page.
|
||
|
|
* @const
|
||
|
|
* @type {string}
|
||
|
|
* @api
|
||
|
|
*/
|
||
|
|
export const ATTRIBUTION: string;
|
||
|
|
export default OSM;
|
||
|
|
export type Options = {
|
||
|
|
/**
|
||
|
|
* Attributions.
|
||
|
|
*/
|
||
|
|
attributions?: import("./Source.js").AttributionLike | undefined;
|
||
|
|
/**
|
||
|
|
* Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
|
||
|
|
*/
|
||
|
|
cacheSize?: number | undefined;
|
||
|
|
/**
|
||
|
|
* The `crossOrigin` attribute for loaded images. Note that
|
||
|
|
* you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
|
||
|
|
* See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
|
||
|
|
*/
|
||
|
|
crossOrigin?: string | null | undefined;
|
||
|
|
/**
|
||
|
|
* Use interpolated values when resampling. By default,
|
||
|
|
* linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
|
||
|
|
*/
|
||
|
|
interpolate?: boolean | undefined;
|
||
|
|
/**
|
||
|
|
* Max zoom.
|
||
|
|
*/
|
||
|
|
maxZoom?: number | undefined;
|
||
|
|
/**
|
||
|
|
* Whether the layer is opaque.
|
||
|
|
*/
|
||
|
|
opaque?: boolean | undefined;
|
||
|
|
/**
|
||
|
|
* Maximum allowed reprojection error (in pixels).
|
||
|
|
* Higher values can increase reprojection performance, but decrease precision.
|
||
|
|
*/
|
||
|
|
reprojectionErrorThreshold?: number | undefined;
|
||
|
|
/**
|
||
|
|
* Optional function to load a tile given a URL. The default is
|
||
|
|
* ```js
|
||
|
|
* function(imageTile, src) {
|
||
|
|
* imageTile.getImage().src = src;
|
||
|
|
* };
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
tileLoadFunction?: import("../Tile.js").LoadFunction | undefined;
|
||
|
|
/**
|
||
|
|
* Duration of the opacity transition for rendering.
|
||
|
|
* To disable the opacity transition, pass `transition: 0`.
|
||
|
|
*/
|
||
|
|
transition?: number | undefined;
|
||
|
|
/**
|
||
|
|
* URL template.
|
||
|
|
* Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
|
||
|
|
*/
|
||
|
|
url?: string | undefined;
|
||
|
|
/**
|
||
|
|
* Whether to wrap the world horizontally.
|
||
|
|
*/
|
||
|
|
wrapX?: boolean | undefined;
|
||
|
|
/**
|
||
|
|
* Choose whether to use tiles with a higher or lower zoom level when between integer
|
||
|
|
* zoom levels. See {@link module :ol/tilegrid/TileGrid~TileGrid#getZForResolution}.
|
||
|
|
*/
|
||
|
|
zDirection?: number | import("../array.js").NearestDirectionFunction | undefined;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* @typedef {Object} Options
|
||
|
|
* @property {import("./Source.js").AttributionLike} [attributions] Attributions.
|
||
|
|
* @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
|
||
|
|
* @property {null|string} [crossOrigin='anonymous'] The `crossOrigin` attribute for loaded images. Note that
|
||
|
|
* you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
|
||
|
|
* See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
|
||
|
|
* @property {boolean} [interpolate=true] Use interpolated values when resampling. By default,
|
||
|
|
* linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
|
||
|
|
* @property {number} [maxZoom=19] Max zoom.
|
||
|
|
* @property {boolean} [opaque=true] Whether the layer is opaque.
|
||
|
|
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
|
||
|
|
* Higher values can increase reprojection performance, but decrease precision.
|
||
|
|
* @property {import("../Tile.js").LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is
|
||
|
|
* ```js
|
||
|
|
* function(imageTile, src) {
|
||
|
|
* 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://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.
|
||
|
|
* @property {number|import("../array.js").NearestDirectionFunction} [zDirection=0]
|
||
|
|
* Choose whether to use tiles with a higher or lower zoom level when between integer
|
||
|
|
* zoom levels. See {@link module:ol/tilegrid/TileGrid~TileGrid#getZForResolution}.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @classdesc
|
||
|
|
* Layer source for the OpenStreetMap tile server.
|
||
|
|
* @api
|
||
|
|
*/
|
||
|
|
declare class OSM extends XYZ {
|
||
|
|
/**
|
||
|
|
* @param {Options} [options] Open Street Map options.
|
||
|
|
*/
|
||
|
|
constructor(options?: Options | undefined);
|
||
|
|
}
|
||
|
|
import XYZ from "./XYZ.js";
|
||
|
|
//# sourceMappingURL=OSM.d.ts.map
|