Module: ol/source/TileArcGISRest

ol/source/TileArcGISRest


Classes

TileArcGISRest

Type Definitions

Options{Object}

Properties:
Name Type Argument Default Description
attributions AttributionLike <optional>

Attributions.

cacheSize number <optional>

Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.

crossOrigin null | string <optional>

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 <optional>
true

Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.

params Object.<string, *> <optional>

ArcGIS Rest parameters. This field is optional. Service defaults will be used for any fields not specified. FORMAT is PNG32 by default. F is IMAGE by default. TRANSPARENT is true by default. BBOX, SIZE, BBOXSR, and IMAGESR will be set dynamically. Set LAYERS to override the default service layer visibility. See https://developers.arcgis.com/rest/services-reference/export-map.htm for further reference.

hidpi boolean <optional>
true

Use the ol/Map#pixelRatio value when requesting the image from the remote server.

tileGrid TileGrid <optional>

Tile grid. Base this on the resolutions, tilesize and extent supported by the server. If this is not defined, a default grid will be used: if there is a projection extent, the grid will be based on that; if not, a grid based on a global extent with origin at 0,0 will be used.

projection ProjectionLike <optional>

Projection. Default is the view projection. The projection code must contain a numeric end portion separated by : or the entire code must form a valid ArcGIS SpatialReference definition.

reprojectionErrorThreshold number <optional>
0.5

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.

tileLoadFunction LoadFunction <optional>

Optional function to load a tile given a URL. The default is

function(imageTile, src) {
  imageTile.getImage().src = src;
};
url string <optional>

ArcGIS Rest service URL for a Map Service or Image Service. The url should include /MapServer or /ImageServer.

wrapX boolean <optional>
true

Whether to wrap the world horizontally.

transition number <optional>

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.

urls Array.<string> <optional>

ArcGIS Rest service urls. Use this instead of url when the ArcGIS Service supports multiple urls for export requests.

zDirection number | NearestDirectionFunction <optional>
0

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.