OpenLayers v5.3.2 API - Class: ImageArcGISRest

new ImageArcGISRest(opt_options)

source/ImageArcGISRest.js, line 54

Name Type Description

options

Image ArcGIS Rest Options.

Name	Type	Default	Description
`attributions`	module:ol/source/Source~AttributionLike		Attributions.
`crossOrigin`	null \| string		The `crossOrigin` attribute for loaded images. Note that you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See `href="https://developer.mozilla.org/en-US/docs/Web/HTML/CORS\_enabled\_image`">https://developer.mozilla.org/en-US/docs/Web/HTML/CORS\_enabled\_image} for more detail.
`hidpi`	boolean	true	Use the `ol/Map#pixelRatio` value when requesting the image from the remote server.
`imageLoadFunction`	module:ol/Image~LoadFunction		Optional function to load an image given a URL.
`params`	Object.<string, *>		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 `href="http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Export\_Map/02r3000000v7000000/`">http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Export\_Map/02r3000000v7000000/} for further reference.
`projection`	module:ol/proj~ProjectionLike		Projection.
`ratio`	number	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.
`resolutions`	Array.<number>		Resolutions. If specified, requests will be made for these resolutions only.
`url`	string		ArcGIS Rest service URL for a Map Service or Image Service. The url should include /MapServer or /ImageServer.

Fires:

change (module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased.
imageloadend - Triggered when an image finishes loading.
imageloaderror - Triggered if image loading results in an error.
imageloadstart - Triggered when an image starts loading.
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.

Extends

module:ol/source/Image~ImageSource

Methods

changed() inherited Observable.js, line 36

Increases the revision counter and dispatches a 'change' event.

get(key){*} inherited Object.js, line 119

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getImageLoadFunction(){module:ol/Image~LoadFunction} source/ImageArcGISRest.js, line 213

Return the image load function of the source.

Returns:

The image load function.

getKeys(){Array.<string>} inherited Object.js, line 132

Get a list of object property names.

Returns:

List of property names.

getParams(){Object} source/ImageArcGISRest.js, line 134

Get the user-provided params, i.e. those passed to the constructor through the "params" option, and possibly updated using the updateParams method.

Returns:

Params.

getProjection(){module:ol/proj/Projection~Projection} inherited source/Source.js, line 119

Get the projection of the source.

Returns:

Projection.

getProperties(){Object.<string, *>} inherited Object.js, line 141

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getState(){module:ol/source/State} inherited source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:

State.

getUrl(){string|undefined} source/ImageArcGISRest.js, line 252

Return the URL used for this ArcGIS source.

Returns:

URL.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 60

Listen for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 82

Listen once for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

refresh() inherited source/Source.js, line 151

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited Object.js, line 164

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean	Update without triggering an event.

setAttributions(attributions) inherited source/Source.js, line 162

Set the attributions of the source.

Name	Type	Description
`attributions`	module:ol/source/Source~AttributionLike \| undefined	Attributions. Can be passed as `string`, `Array<string>`, `module:ol/source/Source&tilde;Attribution`, or `undefined`.

setImageLoadFunction(imageLoadFunction) source/ImageArcGISRest.js, line 261

Set the image load function of the source.

Name	Type	Description
`imageLoadFunction`	module:ol/Image~LoadFunction	Image load function.

setProperties(values, opt_silent) inherited Object.js, line 183

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
`values`	Object.<string, *>	Values.
`silent`	boolean	Update without triggering an event.

setUrl(url) source/ImageArcGISRest.js, line 272

Set the URL to use for requests.

Name	Type	Description
`url`	string \| undefined	URL.

un(type, listener) inherited Observable.js, line 101

Unlisten for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

unset(key, opt_silent) inherited Object.js, line 195

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean	Unset without triggering an event.

updateParams(params) source/ImageArcGISRest.js, line 285

Update the user-provided params.

Name	Type	Description
`params`	Object	Params.