Classes
Type Definitions
-
Options{Object}
-
Properties:
Name Type Description attributions
AttributionLike | undefined Attributions.
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 acrossOrigin
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.
params
Object.<string, *> | undefined ArcGIS Rest parameters. This field is optional. Service defaults will be used for any fields not specified.
FORMAT
isPNG32
by default.F
isIMAGE
by default.TRANSPARENT
istrue
by default.BBOX
,SIZE
,BBOXSR
, andIMAGESR
will be set dynamically. SetLAYERS
to override the default service layer visibility. See https://developers.arcgis.com/rest/services-reference/export-map.htm for further reference.hidpi
boolean
(defaults to true)Use the
ol/Map#pixelRatio
value when requesting the image from the remote server.tileGrid
TileGrid | undefined 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 | undefined 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
(defaults to 0.5)Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
tileLoadFunction
LoadFunction | undefined Optional function to load a tile given a URL. The default is
function(imageTile, src) { imageTile.getImage().src = src; };
url
string | undefined ArcGIS Rest service URL for a Map Service or Image Service. The url should include /MapServer or /ImageServer.
wrapX
boolean
(defaults to true)Whether to wrap the world horizontally.
transition
number | undefined Duration of the opacity transition for rendering. To disable the opacity transition, pass
transition: 0
.urls
Array.<string> | undefined ArcGIS Rest service urls. Use this instead of
url
when the ArcGIS Service supports multiple urls for export requests.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
.