Module: ol/source/arcgisRest

Functions

createLoader(options){ImageObjectPromiseLoader}

source/arcgisRest.js, line 90

import {createLoader} from 'ol/source/arcgisRest';

Creates a loader for ArcGIS Rest images.

Name	Type	Description
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.
hidpi	boolean (defaults to true)	Use the ol/Map#pixelRatio value when requesting the image from the remote server.
params	Object.<string, *> | undefined	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.
projection	ProjectionLike | undefined	Projection. Default is 'EPSG:3857'. The projection code must contain a numeric end portion separated by : or the entire code must form a valid ArcGIS SpatialReference definition.
ratio	number (defaults to 1.5)	Ratio. 1 means image requests are the size of the map viewport, 2 means twice the size of the map viewport, and so on.
url	string	ArcGIS Rest service URL for a Map Service or Image Service. The url should include /MapServer or /ImageServer.
load	function | undefined	Function to perform loading of the image. Receives the created HTMLImageElement and the desired src as argument and returns a promise resolving to the loaded or decoded image. Default is decode.

Returns:

ArcGIS Rest image.

Type Definitions

LoaderOptions{Object}

Properties:

Name	Type	Description
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.
hidpi	boolean (defaults to true)	Use the ol/Map#pixelRatio value when requesting the image from the remote server.
params	Object.<string, *> | undefined	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.
projection	ProjectionLike | undefined	Projection. Default is 'EPSG:3857'. The projection code must contain a numeric end portion separated by : or the entire code must form a valid ArcGIS SpatialReference definition.
ratio	number (defaults to 1.5)	Ratio. 1 means image requests are the size of the map viewport, 2 means twice the size of the map viewport, and so on.
url	string	ArcGIS Rest service URL for a Map Service or Image Service. The url should include /MapServer or /ImageServer.
load	function | undefined	Function to perform loading of the image. Receives the created HTMLImageElement and the desired src as argument and returns a promise resolving to the loaded or decoded image. Default is decode.