Module: ol/source/TileImage

Classes

TileImage

Type Definitions

Options{Object}

Properties:

Name	Type	Description
attributions	AttributionLike | undefined	Attributions.
attributionsCollapsible	boolean (defaults to true)	Attributions are collapsible.
cacheSize	number | undefined	Deprecated. Use the cacheSize option on the layer instead.
crossOrigin	null | string | 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.
interpolate	boolean (defaults to true)	Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
projection	ProjectionLike | undefined	Projection. Default is the view projection.
reprojectionErrorThreshold	number (defaults to 0.5)	Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
state	State | undefined	Source state.
tileClass	Class<ImageTile> | undefined	Class used to instantiate image tiles. Default is ImageTile.
tileGrid	TileGrid | undefined	Tile grid.
tileLoadFunction	LoadFunction | undefined	Optional function to load a tile given a URL. The default is function(imageTile, src) { imageTile.getImage().src = src; };
tilePixelRatio	number (defaults to 1)	The pixel ratio used by the tile service. 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.
tileUrlFunction	UrlFunction | undefined	Deprecated. Use an ImageTile source and provide a function for the url option instead.
url	string | undefined	URL template. Must include {x}, {y} or {-y}, and {z} placeholders. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the urls option.
urls	Array.<string> | undefined	An array of URL templates.
wrapX	boolean | undefined	Whether to wrap the world horizontally. The default, is to request out-of-bounds tiles from the server. When set to false, only one world will be rendered. When set to true, tiles will be requested for one world only, but they will be wrapped horizontally to render multiple worlds.
transition	number | undefined	Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
key	string | undefined	Optional tile key for proper cache fetching
zDirection	number | NearestDirectionFunction (defaults to 0)	Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.