This page describes an older version, please see latest API at http://resources.arcgis.com/en/help/flex-api/apiref/com/esri/ags/layers/supportClasses/MosaicRule.html.
Packagecom.esri.ags.layers.supportClasses
Classpublic class MosaicRule
InheritanceMosaicRule Inheritance Object

Since : ArcGIS API for Flex 2.0

Specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. Mosaic rules are for mosaicking rasters in the mosaic dataset.
    A mosaic rule is used to define:
  1. the selection of rasters that will participate in the mosaic (using where clause);
  2. the mosaic method, for example, how the selected rasters are ordered;
  3. the mosaic operation, for example, how overlapping pixels at the same location are resolved.

See also

com.esri.ags.layers.ArcGISImageServiceLayer.mosaicRule
com.esri.ags.tasks.supportClasses.ImageServiceIdentifyParameters.mosaicRule
IMosaicFunction Interface


Public Properties
 PropertyDefined By
  ascending : Boolean = false
Indicates whether the sort should be ascending or not.
MosaicRule
  lockRasterIds : Array
The lock raster IDs.
MosaicRule
  method : String
The mosaic method determines how the selected rasters are ordered.
MosaicRule
  objectIds : Array
The current selection set on the source catalog.
MosaicRule
  operation : String
The mosaic operation determines how overlapping pixels at the same location are resolved.
MosaicRule
  sortField : String
The sort field on the source catalog.
MosaicRule
  sortValue : Object
The sort base value.
MosaicRule
  viewpoint : MapPoint
The view point.
MosaicRule
  where : String
The where clause determines which rasters will participate in the mosaic.
MosaicRule
Public Constants
 ConstantDefined By
  METHOD_ATTRIBUTE : String = esriMosaicAttribute
[static] Sorts rasters based on an attribute field and its difference from a base value.
MosaicRule
  METHOD_CENTER : String = esriMosaicCenter
[static] Sorts rasters based on their proximity to the view center or the center of view extent.
MosaicRule
  METHOD_LOCK_RASTER : String = esriMosaicLockRaster
[static] Selects only the rasters in a given list of raster IDs to participate in the mosaic.
MosaicRule
  METHOD_NADIR : String = esriMosaicNadir
[static] Sorts rasters based on the distance between the nadir position and view center.
MosaicRule
  METHOD_NONE : String = esriMosaicNone
[static] By no special ordering.
MosaicRule
  METHOD_NORTHWEST : String = esriMosaicNorthwest
[static] Sorts rasters in a view-independent way, where rasters with their centers most northwest are displayed on top.
MosaicRule
  METHOD_SEAMLINE : String = esriMosaicSeamline
[static] Cuts the raster using a predefined seamline shape for each raster using optional feathering along the seams.
MosaicRule
  METHOD_VIEWPOINT : String = esriMosaicViewpoint
[static] Sorts rasters based on a user-defined view point location and nadir location for the rasters Mosaic operations that apply: first (default), last, min, max, mean and blend.
MosaicRule
  OPERATION_BLEND : String = MT_BLEND
[static] The output value will be a blend of values of the overlapped cells.
MosaicRule
  OPERATION_FIRST : String = MT_FIRST
[static] The output value will be determined by the order the inputs are entered, with the first raster specified as the top.
MosaicRule
  OPERATION_LAST : String = MT_LAST
[static] Mosaics using the last value.
MosaicRule
  OPERATION_MAX : String = MT_MAX
[static] The output value will be the maximum value of the overlapped cells.
MosaicRule
  OPERATION_MEAN : String = MT_MEAN
[static] The output value will be the mean value of the overlapped cells.
MosaicRule
  OPERATION_MIN : String = MT_MIN
[static] The output value will be the minimum value of the overlapped cells.
MosaicRule
Property Detail
ascendingproperty
public var ascending:Boolean = false

Indicates whether the sort should be ascending or not.

lockRasterIdsproperty 
public var lockRasterIds:Array

The lock raster IDs.

methodproperty 
public var method:String

The mosaic method determines how the selected rasters are ordered.

See also

objectIdsproperty 
public var objectIds:Array

The current selection set on the source catalog.

operationproperty 
public var operation:String

The mosaic operation determines how overlapping pixels at the same location are resolved.

See also

sortFieldproperty 
public var sortField:String

The sort field on the source catalog.

sortValueproperty 
public var sortValue:Object

The sort base value.

viewpointproperty 
public var viewpoint:MapPoint

The view point.

whereproperty 
public var where:String

The where clause determines which rasters will participate in the mosaic.

Constant Detail
METHOD_ATTRIBUTEConstant
public static const METHOD_ATTRIBUTE:String = esriMosaicAttribute

Sorts rasters based on an attribute field and its difference from a base value.

Mosaic operations that apply: first (default), last, min, max, mean and blend.

METHOD_CENTERConstant 
public static const METHOD_CENTER:String = esriMosaicCenter

Sorts rasters based on their proximity to the view center or the center of view extent. The rasters that have their center closest to the view center are placed on top.

Mosaic operations that apply: first (default), last, min, max, mean and blend.

METHOD_LOCK_RASTERConstant 
public static const METHOD_LOCK_RASTER:String = esriMosaicLockRaster

Selects only the rasters in a given list of raster IDs to participate in the mosaic. This method takes LockRasterIDs as a parameter which defines the list. The rasters are in a random order. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters.

Mosaic operations that apply: first (default), last, min, max, mean and blend.

METHOD_NADIRConstant 
public static const METHOD_NADIR:String = esriMosaicNadir

Sorts rasters based on the distance between the nadir position and view center. This is similar to the esriMosaicCenter method but uses the nadir point to a raster, which may be different than the center, especially for oblique imagery.

Mosaic operations that apply: first (default), last, min, max, mean and blend.

METHOD_NONEConstant 
public static const METHOD_NONE:String = esriMosaicNone

By no special ordering.

METHOD_NORTHWESTConstant 
public static const METHOD_NORTHWEST:String = esriMosaicNorthwest

Sorts rasters in a view-independent way, where rasters with their centers most northwest are displayed on top.

Mosaic operations that apply: first (default), last, min, max, mean and blend.

METHOD_SEAMLINEConstant 
public static const METHOD_SEAMLINE:String = esriMosaicSeamline

Cuts the raster using a predefined seamline shape for each raster using optional feathering along the seams. The Ordering is defined during seamline generation.

Mosaic operations that apply: first (default), min, max, mean and blend.

METHOD_VIEWPOINTConstant 
public static const METHOD_VIEWPOINT:String = esriMosaicViewpoint

Sorts rasters based on a user-defined view point location and nadir location for the rasters

Mosaic operations that apply: first (default), last, min, max, mean and blend.

OPERATION_BLENDConstant 
public static const OPERATION_BLEND:String = MT_BLEND

The output value will be a blend of values of the overlapped cells.

OPERATION_FIRSTConstant 
public static const OPERATION_FIRST:String = MT_FIRST

The output value will be determined by the order the inputs are entered, with the first raster specified as the top. This is the default.

OPERATION_LASTConstant 
public static const OPERATION_LAST:String = MT_LAST

Mosaics using the last value.

OPERATION_MAXConstant 
public static const OPERATION_MAX:String = MT_MAX

The output value will be the maximum value of the overlapped cells.

OPERATION_MEANConstant 
public static const OPERATION_MEAN:String = MT_MEAN

The output value will be the mean value of the overlapped cells.

OPERATION_MINConstant 
public static const OPERATION_MIN:String = MT_MIN

The output value will be the minimum value of the overlapped cells.