new MosaicRule({
  ascending: true,
  method: "center",
  operation: "last"
});

Property Overview

Property Details

ascending Boolean

Indicates whether the sort should be ascending. This property applies to all mosaic methods where an ordering is defined except seamline.

Default Value:true

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

itemRenderingRule RasterFunction

The rendering rule applied on items before mosaicking.

lockRasterIds Number[]

An array of raster Ids. All the rasters with the given list of raster Ids are selected to participate in the mosaic. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters.

Example:

var mosaicRule = new MosaicRule();
mosaicRule.method = "lock-raster";
mosaicRule.lockRasterIds = [32,454,14];

method String

The mosaic method determines how the selected rasters are ordered. The mosaic method defines how the mosaicked image is created from these input rasters.

Value	Description
none	Orders rasters based on the order of objectIds in the mosaic dataset attribute table.
center	Enables rasters to be sorted based their ZOrder, then PixelSize, and then by a default order where rasters that have their centers closest to the view center are placed on top.
nadir	Enables rasters to be sorted by the ZOrder, then PixelSize, and then by the distance between the nadir position and view center. This is similar to the Closest to Center method but uses the nadir point to a raster, which may be different than the center, especially for oblique imagery.
viewpoint	Orders rasters based on the ZOrder, then PixelSize, and then by a user-defined location and nadir location for the rasters using the viewpoint.
attribute	Enables raster ordering based on ZOrder, then PixelSize, and then by a defined metadata attribute and its difference from a base value.
lock-raster	Enables a user to lock the display of single or multiple rasters based on the lockRasterIds.
northwest	Enables raster ordering by ZOrder, then PixelSize, and then by the shortest distance between the center of a raster to the northwest position.
seamline	Cuts the raster using the predefined seamline shape for each raster, using optional feathering along the seams, and orders images based on the ZOrder and then the SOrder fields in the attribute table.

Possible Values:"none"|"center"|"nadir"|"viewpoint"|"attribute"|"lock-raster"|"northwest"|"seamline"

Example:

var mosaicRule = new MosaicRule();
mosaicRule.method = "lock-raster";

multidimensionalDefinition DimensionalDefinition[]

A multiple dimensional service can have multiple dimensions for one or more variables. Use multiDimensionalDefinitions to filter data based on a slice or range of data. For example, a single ImageryLayer may have a depth dimension storing sea temperatures for the same pixel location at various depths. Another dimension could be time, where the same pixel stores multiple values based on a window of time.

This property can be used to filter and display ImageryLayer pixels for specific "slices" in those dimensions (e.g. display sea temperature at 1000m below sea level for a specific week in the year).

Example:

// Display water salinity at a specific point in time.
// In this case - Nov 30 2009
var mosaicRule = new MosaicRule();
mosaicRule.multidimensionalDefinition = [];
mosaicRule.multidimensionalDefinition.push(new DimensionalDefinition({
  variableName: "Salinity",
  dimensionName: "StdTime",
  values: [1259625600000]
}));

layer.mosaicRule = mosaicRule;

objectIds Number[]

Defines a selection using a set of ObjectIDs. This property applies to all mosaic methods.

operation String

Defines the mosaic operation used to resolve overlapping pixels.

Possible Values:

Value	Description
first	The overlapping areas will contain the cells from the first raster dataset listed in the source.
last	The overlapping areas will contain the cells from the last raster dataset listed in the source.
min	The overlapping areas will contain the minimum cell values from all the overlapping cells.
max	The overlapping areas will contain the maximum cell values from all the overlapping cells.
mean	The overlapping areas will contain the mean cell values from all the overlapping cells.
blend	The overlapping areas will be a blend of the cell values that overlap. This blend value relies on an algorithm that is weight based and dependent on the distance from the cells to the edge within the overlapping area.
sum	The overlapping areas will contain the total sum of the cell values from all the overlapping cells.

Possible Values:"first"|"last"|"min"|"max"|"mean"|"blend"|"sum"

sortField String

The name of the attribute field that is used with a constant sortValue to define the mosaicking order when the mosaic method is set to attribute. The ordering is defined by the absolute value of the difference between the specified sort field value and the sort base value. For example, if the sort field is Month and the sort value is 7 (July), then the ordering is defined by ABS(Month -7).

sortValue String

A constant value defining a reference or base value for the sort field when the mosaic method is set to attribute.

viewpoint Point

Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters.

Example:

var mosaicRule = new MosaicRule();
mosaicRule.method = "viewpoint";
mosaicRule.viewpoint = inPoint;
layer.mosaicRule = mosaicRule;

where String

The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods. This property will be overridden by the ImageryLayer's definitionExpression property if both properties are set.

Method Overview

Method Details

clone(){MosaicRule}

Creates a clone of the MosaicRule object.

Returns:

Type	Description
MosaicRule	A clone of the object that invoked this method.

Example:

// Creates a clone of the mosaic rule
var mosaicRule = layer.mosaicRule.clone();

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:

json Object A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:

Type	Description
*	Returns a new instance of this class.

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.