ArcGIS Runtime SDK for iOS
100.15
|
An instance of this class represents a raster that is retrieved from an ArcGIS image service.
An image service provides access to raster data through a web service. A single raster dataset or a mosaic dataset which contains a collection of raster datasets can be served as one image service. The mosaic dataset can dynamically process and mosaic the images on the fly. An image service supports accessing both the mosaicked image and its catalog, as well as individual rasters in the catalog. An image service raster allows you to display raster data from image services using an AGSRasterLayer
. It also allows you to apply service-defined or client-defined rendering rules by setting AGSRenderingRule
on it. You can pass an image service raster as a raster input to an AGSRasterFunction
to work with local raster functions.
The image service raster is derived from AGSRaster
.
AGSRasterLayer
to display rasters in a map or a scene. Instance Methods | |
(void) | - cancelLoad |
(void) | - doCancelLoading |
(void) | - doStartLoading: |
(instancetype) | - initWithFileURL: |
(instancetype) | - initWithName:extension: |
(instancetype) | - initWithRasterFunction: |
(instancetype) | - initWithURL: |
(void) | - loadDidFinishWithError: |
(void) | - loadWithCompletion: |
(void) | - onLoadStatusChanged |
(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 |
|
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
- (void) doCancelLoading |
Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p)
is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly))
at the end passing in an error representing NSUserCancelledError
.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (void) doStartLoading: | (BOOL) | retrying |
Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p)
or retryLoadWithCompletion: (AGSLoadable-p)
is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly))
upon completion, passing in the error if any.
retrying | flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p) . |
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
+ (instancetype) imageServiceRasterWithURL: | (NSURL *) | URL |
Create a raster with a URL to a remote ArcGIS Image Service, for instance, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/World/MODIS/ImageServer.
URL | to a remote ArcGIS Image Service. |
- (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.
URL | to a remote ArcGIS Image Service. |
- (void) loadDidFinishWithError: | (nullable NSError *) | error |
Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly))
and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly))
when done loading or failed to load.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
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.
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. |
- cancelLoad
to cancel loading - retryLoadWithCompletion:
to force reload - (void) onLoadStatusChanged |
Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus
changes is called. Subclasses can optionally implement this to know when their loading status has changed.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
requiredinherited |
Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:
cancelLoad
and then this methodIf 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.
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. |
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
|
readnonatomicstronginherited |
File URL to the local raster dataset on disk
|
readnonatomicstronginherited |
A function to transform the raster
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
|
readrequirednonatomicassigninherited |
Status of the load operation.
|
readwritenonatomicstrong |
The mosaic rule used for combining a number of input rasters that are often overlapping.
|
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.
|
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.
|
readnonatomicstrong |
Metadata about the ArcGIS Image Service used by this raster.
|
readrequirednonatomicstronginherited |
The URL of the remote resource.