Class: ImageArcGISRest

ol/source/ImageArcGISRest~ImageArcGISRest 


import ImageArcGISRest from 'ol/source/ImageArcGISRest';

Source for data from ArcGIS Rest services providing single, untiled images. Useful when underlying map service has labels.

If underlying map service is not using labels, take advantage of ol image caching and use module:ol/source/TileArcGISRest data source.

new ImageArcGISRest(opt_options)

source/ImageArcGISRest.js, line 53
Name Type Description
options

Image ArcGIS Rest Options.

Name Type 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 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.
imageLoadFunction module:ol/Image~LoadFunction

Optional function to load an image given a URL.
imageSmoothing boolean (defaults to true)

Enable image smoothing.
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 https://developers.arcgis.com/rest/services-reference/export-map.htm for further reference.
projection module:ol/proj~ProjectionLike

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.
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.
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:

Extends

Methods

changed() inherited

Observable.js, line 70

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

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){module:ol/source/Source~Attribution} inherited

source/Source.js, line 100

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 108
Returns:
Attributions are collapsible.

getImageLoadFunction(){module:ol/Image~LoadFunction}

source/ImageArcGISRest.js, line 228

Return the image load function of the source.

Returns:
The image load function.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getParams(){Object}

source/ImageArcGISRest.js, line 132

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 117

Get the projection of the source.

Returns:
Projection.

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

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 81

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 134

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

Returns:
State.

getUrl(){string|undefined}

source/ImageArcGISRest.js, line 272

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 155

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 167

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 156

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, opt_silent) inherited

Object.js, line 203

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 167

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~Attribution, or undefined.

setImageLoadFunction(imageLoadFunction)

source/ImageArcGISRest.js, line 281

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 223

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 292

Set the URL to use for requests.

Name Type Description
url string | undefined

URL.

un(type, listener) inherited

Observable.js, line 176

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 247

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.

updateParams(params)

source/ImageArcGISRest.js, line 305

Update the user-provided params.

Name Type Description
params Object

Params.