java.lang.Object
com.esri.arcgisruntime.raster.MosaicRule
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 Understanding the mosaicking rules for a mosaic dataset
- Since:
- 100.9.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the rendering rule applied on items before mosaic operation.Gets the collection of raster IDs for image service rasters forced to be visible at all scales.Gets the type of mosaic method used for individual images.Specifies the mosaic operation used to resolve overlapped pixel values.Gets the collection of raster IDs specifying a subset of rasters used in the mosaic.Gets the field name used together withMosaicMethod.ATTRIBUTE
.Gets the base sort value used together withMosaicMethod.ATTRIBUTE
andgetSortField()
.Gets the viewpoint used along withMosaicMethod.VIEWPOINT
.Gets the SQL WHERE clause to define a subset of rasters used in the mosaic.boolean
Indicates whether this MosaicRule is ascending.void
setAscending
(boolean isAscending) Sets whether this MosaicRule is ascending.void
setItemRenderingRule
(RenderingRule itemRenderingRule) Sets the rendering rule applied on items before mosaic operation.void
setMosaicMethod
(MosaicMethod mosaicMethod) Sets the type of mosaic method used for individual images.void
setMosaicOperation
(MosaicOperation mosaicOperation) Specifies the mosaic operation used to resolve overlapped pixel values.void
setSortField
(String sortField) Sets the field name used together withMosaicMethod.ATTRIBUTE
.void
setSortValue
(String sortValue) Sets the base sort value used together withMosaicMethod.ATTRIBUTE
andgetSortField()
.void
setViewpoint
(Viewpoint viewpoint) Sets the viewpoint used along withMosaicMethod.VIEWPOINT
.void
setWhereClause
(String whereClause) Sets the SQL WHERE clause to define a subset of rasters used in the mosaic.
-
Constructor Details
-
MosaicRule
public MosaicRule()Creates a mosaic rule object.- Since:
- 100.9.0
-
-
Method Details
-
isAscending
public boolean isAscending()Indicates whether this MosaicRule is ascending. The default value is the value used when the mosaic data was created, if unavailable, the default value is true.- Returns:
- true if this MosaicRule is ascending
- Since:
- 100.9.0
-
setAscending
public void setAscending(boolean isAscending) Sets whether this MosaicRule is ascending.- Parameters:
isAscending
- indicates whether this MosaicRule is ascending- Since:
- 100.9.0
-
getItemRenderingRule
Gets the rendering rule applied on items before mosaic operation.- Returns:
- rendering rule applied on items before mosaic operation, or null if none
- Since:
- 100.9.0
-
setItemRenderingRule
Sets the rendering rule applied on items before mosaic operation.- Parameters:
itemRenderingRule
- rendering rule applied on items before mosaic operation. Can be null.- Since:
- 100.9.0
-
getLockRasterIds
Gets the collection of raster IDs for image service rasters forced to be visible at all scales. Used withMosaicMethod.LOCK_RASTER
. Cannot be greater than the maximum mosaic image count of the service.- Returns:
- a mutable collection of raster IDs for image service rasters forced to be visible at all scales
- Since:
- 100.9.0
-
getMosaicMethod
Gets the type of mosaic method used for individual images. The default value is the value used when the mosaic data was created, if unavailable, the default value is MosaicMethod.NONE.- Returns:
- specifies the type of mosaic method used for individual images
- Since:
- 100.9.0
-
setMosaicMethod
Sets the type of mosaic method used for individual images.- Parameters:
mosaicMethod
- specifies the type of mosaic method used for individual images- Throws:
IllegalArgumentException
- if mosaicMethod is null- Since:
- 100.9.0
-
getMosaicOperation
Specifies the mosaic operation used to resolve overlapped pixel values. The default value is the value used when the mosaic data was created, if unavailable, the default value is MosaicOperation.FIRST.- Returns:
- specifies the mosaic operation used to resolve overlapped pixel values
- Since:
- 100.9.0
-
setMosaicOperation
Specifies the mosaic operation used to resolve overlapped pixel values.- Parameters:
mosaicOperation
- specifies the mosaic operation used to resolve overlapped pixel values- Throws:
IllegalArgumentException
- if mosaicOperation is null- Since:
- 100.9.0
-
getRasterIds
Gets the collection of raster IDs specifying a subset of rasters used in the mosaic. Any of the specified rasters may not be visible at all scales.- Returns:
- a mutable collection of raster IDs specifying a subset of rasters used in the mosaic
- Since:
- 100.9.0
-
getSortField
Gets the field name used together withMosaicMethod.ATTRIBUTE
.- Returns:
- the field name used together with MosaicMethod.ATTRIBUTE
- Since:
- 100.9.0
-
setSortField
Sets the field name used together withMosaicMethod.ATTRIBUTE
.- Parameters:
sortField
- the field name used together with MosaicMethod.ATTRIBUTE- Throws:
IllegalArgumentException
- if sortField is null- Since:
- 100.9.0
-
getSortValue
Gets the base sort value used together withMosaicMethod.ATTRIBUTE
andgetSortField()
.- Returns:
- the base sort value used together with MosaicMethod.ATTRIBUTE and getSortField
- Since:
- 100.9.0
-
setSortValue
Sets the base sort value used together withMosaicMethod.ATTRIBUTE
andgetSortField()
.- Parameters:
sortValue
- the base sort value used together with MosaicMethod.ATTRIBUTE and getSortField- Throws:
IllegalArgumentException
- if sortValue is null- Since:
- 100.9.0
-
getViewpoint
Gets the viewpoint used along withMosaicMethod.VIEWPOINT
.- Returns:
- the viewpoint used along with MosaicMethod.VIEWPOINT, or null if none
- Since:
- 100.9.0
-
setViewpoint
Sets the viewpoint used along withMosaicMethod.VIEWPOINT
.- Parameters:
viewpoint
- the viewpoint used along with MosaicMethod.VIEWPOINT. Can be null.- Since:
- 100.9.0
-
getWhereClause
Gets the 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.- Returns:
- SQL WHERE clause to define a subset of rasters used in the mosaic
- Since:
- 100.9.0
-
setWhereClause
Sets the 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.- Parameters:
whereClause
- SQL WHERE clause to define a subset of rasters used in the mosaic- Throws:
IllegalArgumentException
- if whereClause is null- Since:
- 100.9.0
-