Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/layers/support/MosaicRule"], function(MosaicRule) { /* code goes here */ });
Class: esri/layers/support/MosaicRule
Inheritance: MosaicRule Accessor
Since: ArcGIS API for JavaScript 4.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:

  • The selection of rasters that will participate in the mosaic (using where clause).
  • The mosaic method, e.g. how the selected rasters are ordered.
  • The mosaic operation, e.g. how overlapping pixels at the same location are resolved.
See also:
Example:
new MosaicRule({
  ascending: true,
  method: "center",
  operation: "last"
});

Constructors

new MosaicRule(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Boolean

Indicates whether the sort should be ascending.

more details
more detailsMosaicRule
String

The name of the class.

more details
more detailsAccessor
RasterFunction

The rendering rule applied on items before mosaicking.

more details
more detailsMosaicRule
Number[]

An array of raster Ids.

more details
more detailsMosaicRule
String

The mosaic method determines how the selected rasters are ordered.

more details
more detailsMosaicRule
DimensionalDefinition[]

A multiple dimensional service can have multiple dimensions for one or more variables.

more details
more detailsMosaicRule
Number[]

Defines a selection using a set of ObjectIDs.

more details
more detailsMosaicRule
String

Defines the mosaic operation used to resolve overlapping pixels.

more details
more detailsMosaicRule
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.

more details
more detailsMosaicRule
String

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

more details
more detailsMosaicRule
Point

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

more details
more detailsMosaicRule
String

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

more details
more detailsMosaicRule

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.

Possible Values:

ValueDescription
noneOrders rasters based on the order of objectIds in the mosaic dataset attribute table.
centerEnables 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.
nadirEnables 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.
viewpointOrders rasters based on the ZOrder, then PixelSize, and then by a user-defined location and nadir location for the rasters using the viewpoint.
attributeEnables raster ordering based on ZOrder, then PixelSize, and then by a defined metadata attribute and its difference from a base value.
lock-rasterEnables a user to lock the display of single or multiple rasters based on the lockRasterIds.
northwestEnables raster ordering by ZOrder, then PixelSize, and then by the shortest distance between the center of a raster to the northwest position.
seamlineCuts 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.
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:

ValueDescription
firstThe overlapping areas will contain the cells from the first raster dataset listed in the source.
lastThe overlapping areas will contain the cells from the last raster dataset listed in the source.
minThe overlapping areas will contain the minimum cell values from all the overlapping cells.
maxThe overlapping areas will contain the maximum cell values from all the overlapping cells.
meanThe overlapping areas will contain the mean cell values from all the overlapping cells.
blendThe 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.
sumThe overlapping areas will contain the total sum of the cell values from all the overlapping cells.
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.

Method Overview

NameReturn TypeSummaryClass
MosaicRule

Creates a clone of the MosaicRule object.

more details
more detailsMosaicRule
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsMosaicRule
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsMosaicRule

Method Details

clone(){MosaicRule}

Creates a clone of the MosaicRule object.

Returns:
TypeDescription
MosaicRuleA 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...