OpenLayers v4.0.1 API - Class: ImageArcGISRest

# Class: ImageArcGISRest

This documentation is for OpenLayers v4.0.1. The latest is v.

## 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 `ol.source.TileArcGISRest` data source.

#### new ol.source.ImageArcGISRest(opt_options)

src/ol/source/imagearcgisrest.js, line 29

  Name | Type | Description
  --- | --- | ---

  `options`

  Image ArcGIS Rest Options.

  Name | Type | Description
  --- | --- | ---
  `attributions` | Array.<ol.Attribution> | undefined | Attributions.
  `crossOrigin` | null | string | undefined | 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 https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
  `hidpi` | boolean | undefined | Use the `ol.Map#pixelRatio` value when requesting the image from the remote server. Default is `true`.
  `logo` | string | olx.LogoOptions | undefined | Logo.
  `imageLoadFunction` | ol.ImageLoadFunctionType | undefined | Optional function to load an image given a URL.
  `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 http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Export_Map/02r3000000v7000000/ for further reference.
  `projection` | ol.ProjectionLike | Projection.
  `ratio` | number | undefined | Ratio. `1` means image requests are the size of the map viewport, `2` means twice the size of the map viewport, and so on. Default is `1.5`.
  `resolutions` | Array.<number> | undefined | Resolutions. If specified, requests will be made for these resolutions only.
  `url` | string | undefined | ArcGIS Rest service URL for a Map Service or Image Service. The url should include /MapServer or /ImageServer.

  ##### Fires:

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

### Extends

- ol.source.Image

### Methods

#### changed() inherited

src/ol/observable.js, line 58

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

#### dispatchEvent(event) inherited

src/ol/observable.js, line 75

  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` | Object | ol.events.Event | string | Event object.

#### get(key){*} inherited

src/ol/object.js, line 101

  Gets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.

  ##### Returns:

  Value.

#### getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 113

  Get the attributions of the source.

  ##### Returns:

  Attributions.

#### getImageLoadFunction(){ol.ImageLoadFunctionType}

src/ol/source/imagearcgisrest.js, line 189

  Return the image load function of the source.

  ##### Returns:

  The image load function.

#### getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

  Get a list of object property names.

  ##### Returns:

  List of property names.

#### getLogo(){string|olx.LogoOptions|undefined} inherited

src/ol/source/source.js, line 123

  Get the logo of the source.

  ##### Returns:

  Logo.

#### getParams(){Object}

src/ol/source/imagearcgisrest.js, line 108

  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(){ol.proj.Projection} inherited

src/ol/source/source.js, line 133

  Get the projection of the source.

  ##### Returns:

  Projection.

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

src/ol/object.js, line 125

  Get an object of all property names and values.

  ##### Returns:

  Object.

#### getRevision(){number} inherited

src/ol/observable.js, line 84

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

  ##### Returns:

  Revision.

#### getState(){ol.source.State} inherited

src/ol/source/source.js, line 150

  Get the state of the source, see `ol.source.State` for possible states.

  ##### Returns:

  State.

#### getUrl(){string|undefined}

src/ol/source/imagearcgisrest.js, line 230

  Return the URL used for this ArcGIS source.

  ##### Returns:

  URL.

#### on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

  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.
  `this` | Object | The object to use as `this` in `listener`.

  ##### 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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

  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.
  `this` | Object | The object to use as `this` in `listener`.

  ##### 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

src/ol/source/source.js, line 167

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

#### set(key, value, opt_silent) inherited

src/ol/object.js, line 150

  Sets a value.

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

#### setAttributions(attributions) inherited

src/ol/source/source.js, line 179

  Set the attributions of the source.

  Name | Type | Description
  --- | --- | ---
  `attributions` | ol.AttributionLike | undefined | Attributions. Can be passed as `string`, `Array<string>`, ``ol.Attribution``, `Array<`ol.Attribution`>` or `undefined`.

#### setImageLoadFunction(imageLoadFunction)

src/ol/source/imagearcgisrest.js, line 240

  Set the image load function of the source.

  Name | Type | Description
  --- | --- | ---
  `imageLoadFunction` | ol.ImageLoadFunctionType | Image load function.

#### setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

  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)

src/ol/source/imagearcgisrest.js, line 252

  Set the URL to use for requests.

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

#### un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

  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.
  `this` | Object | The object which was used as `this` by the `listener`.

#### unset(key, opt_silent) inherited

src/ol/object.js, line 184

  Unsets a property.

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

#### updateParams(params)

src/ol/source/imagearcgisrest.js, line 266

  Update the user-provided params.

  Name | Type | Description
  --- | --- | ---
  `params` | Object | Params.