AGSImageServiceRaster Class Reference

Description

A raster dataset based on an ArcGIS Image Service.

An instance of this class represents a raster dataset based on an ArcGIS Image Service, for instance, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/World/MODIS/ImageServer . Raster data can be displayed on screen in a 2D map or a 3D scene using an AGSRasterLayer.

See also

AGSRasterLayer to display rasters in a map or a scene

License Restrictions:

This feature requires a Standard license for production deployment when raster functions are applied. . No license required in Developer mode for testing.

Since

100.1

Inheritance diagram for AGSImageServiceRaster:

Instance Methods
(void)	- cancelLoad
(instancetype)	- initWithFileURL:
(instancetype)	- initWithName:extension:
(instancetype)	- initWithRasterFunction:
(instancetype)	- initWithURL:
(void)	- loadWithCompletion:
(void)	- retryLoadWithCompletion:

Class Methods
(instancetype)	+ imageServiceRasterWithURL:
(instancetype)	+ rasterWithFileURL:
(instancetype)	+ rasterWithName:extension:
(instancetype)	+ rasterWithRasterFunction:

Properties
AGSCredential *	credential
NSURL *	fileURL
AGSRasterFunction *	function
NSError *	loadError
AGSLoadStatus	loadStatus
AGSMosaicRule *	mosaicRule
AGSRenderingRule *	renderingRule
AGSRequestConfiguration *	requestConfiguration
AGSArcGISImageServiceInfo *	serviceInfo
NSURL *	URL

Method Documentation

cancelLoad()

- (void) cancelLoad

requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since

100

imageServiceRasterWithURL:()

+ (instancetype) imageServiceRasterWithURL:

(NSURL *)

URL

Initialize the raster with a URL to a remote ArcGIS Image Service, for instance, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/World/MODIS/ImageServer

Parameters

URL	to a remote ArcGIS Image Service

Returns

Initialized image service raster

Since

100.1

initWithURL:()

- (instancetype) initWithURL:

(NSURL *)

URL

Initialize the raster with a URL to a remote ArcGIS Image Service, for instance, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/World/MODIS/ImageServer

Parameters

URL	to a remote ArcGIS Image Service

Returns

Initialized image service raster

Since

100.1

loadWithCompletion:()

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion

requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion

block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note

The completion block is always invoked on the main thread.

Since

100

See also

- cancelLoad to cancel loading

- retryLoadWithCompletion: to force reload

retryLoadWithCompletion:()

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion

requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
2. the server was down earlier when it failed and you want to retry
3. the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion

block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note

The completion block is always invoked on the main thread.

Since

100

Property Documentation

credential

- (AGSCredential*) credential

readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

Since

100

fileURL

- (NSURL*) fileURL

readnonatomicstronginherited

File URL to the local raster dataset on disk

Since

100

function

- (AGSRasterFunction*) function

readnonatomicstronginherited

A function to transform the raster

Since

100

loadError

- (NSError*) loadError

readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since

100

loadStatus

- (AGSLoadStatus) loadStatus

readrequirednonatomicassigninherited

Status of the load operation.

Since

100

mosaicRule

- (AGSMosaicRule*) mosaicRule

readwritenonatomicstrong

The mosaic rule used for combining a number of input rasters that are often overlapping.

Since

100.9

renderingRule

- (AGSRenderingRule*) renderingRule

readwritenonatomicstrong

Rendering rule for how the raster should be rendered. Rendering rules allows you to perform complex processing, such as computing hillshade or slope, on raster data of an ArcGIS Image Service. The source data is not changed. Instead, processing is performed on-the-fly while displaying the raster layer in a map or a scene.

Since

100.1

requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration

readwritenonatomicstronginherited

The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.

Since

100

serviceInfo

- (AGSArcGISImageServiceInfo*) serviceInfo

readnonatomicstrong

Metadata about the ArcGIS Image Service used by this raster

Since

100.1

URL

- (NSURL*) URL

readrequirednonatomicstronginherited

The URL of the remote resource.

Since

100