ArcGIS Runtime SDK for iOS: AGSMosaicRule Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSMosaicRule Class Reference

Description

A rule determining how a requested image should participate in the mosaic.

An image service uses a mosaic rule to mosaic multiple rasters on-the-fly. A mosaic rule parameter is used by many image service operations, such as export image and identify operations.

See also
https://desktop.arcgis.com/en/arcmap/10.6/manage-data/raster-and-images/understanding-the-mosaicking-rules-for-a-mosaic-dataset.htm
Since
100.9
Inheritance diagram for AGSMosaicRule:
AGSObject

Instance Methods

(instancetype) - init
 

Class Methods

(instancetype) + mosaicRule
 

Properties

BOOL ascending
 
AGSRenderingRuleitemRenderingRule
 
NSArray< NSNumber * > * lockRasterIDs
 
AGSMosaicMethod mosaicMethod
 
AGSMosaicOperation mosaicOperation
 
NSArray< NSNumber * > * rasterIDs
 
NSString * sortField
 
NSString * sortValue
 
AGSViewpointviewpoint
 
NSString * whereClause
 

Method Documentation

◆ init

- (instancetype) init

Creates a mosaic rule object.

Since
100.9

◆ mosaicRule

+ (instancetype) mosaicRule

Creates a mosaic rule object.

Since
100.9

Property Documentation

◆ ascending

- (BOOL) ascending
readwritenonatomicassign

Indicates whether this AGSMosaicRule is ascending.

The default value is the value used when the mosaic data was created, if unavailable, the default value is YES.

Since
100.9

◆ itemRenderingRule

- (AGSRenderingRule*) itemRenderingRule
readwritenonatomicstrong

Rendering rule applied on items before mosaic operation.

Since
100.9

◆ lockRasterIDs

- (NSArray<NSNumber *>*) lockRasterIDs
readwritenonatomiccopy

An array of raster IDs for image service rasters forced to be visible at all scales.

Used with AGSMosaicMethodLockRaster. Cannot be greater than the maximum mosaic image count of the service.

Since
100.9

◆ mosaicMethod

- (AGSMosaicMethod) mosaicMethod
readwritenonatomicassign

Specifies the type of AGSMosaicMethod used for sorting rasters in a mosaic dataset.

The default value is the value used when the mosaic data was created, if unavailable, the default value is AGSMosaicMethodNone.

Since
100.9

◆ mosaicOperation

- (AGSMosaicOperation) mosaicOperation
readwritenonatomicassign

Specifies the AGSMosaicOperation used to resolve overlapped pixel values from various rasters in a mosaic dataset.

The default value is the value used when the mosaic data was created, if unavailable, the default value is AGSMosaicOperationFirst.

Since
100.9

◆ rasterIDs

- (NSArray<NSNumber *>*) rasterIDs
readwritenonatomiccopy

An array of raster IDs specifying a subset of rasters used in the mosaic.

Any of the specified rasters may not be visible at all scales.

Since
100.9

◆ sortField

- (NSString*) sortField
readwritenonatomiccopy

The field name used together with AGSMosaicMethodAttribute .

Since
100.9

◆ sortValue

- (NSString*) sortValue
readwritenonatomiccopy

The base sort value used together with AGSMosaicMethodAttribute . This value is compared with the value of the field specified by AGSMosaicRule::sortField parameter.

Since
100.9

◆ viewpoint

- (AGSViewpoint*) viewpoint
readwritenonatomicstrong

The viewpoint used along with AGSMosaicMethodViewpoint .

Since
100.9

◆ whereClause

- (NSString*) whereClause
readwritenonatomiccopy

SQL WHERE clause to define a subset of rasters used in the mosaic.

Any of the rasters in the subset may not be visible at all scales.

Since
100.9