Skip To Content ArcGIS for Developers Sign In Dashboard

MosaicRule QML Type

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

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.9
Inherits:

Object

Properties

Signals

Detailed Description

https://desktop.arcgis.com/en/arcmap/10.6/manage-data/raster-and-images/understanding-the-mosaicking-rules-for-a-mosaic-dataset.htm

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.

Property Documentation

ascending : bool

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.


itemRenderingRule : RenderingRule

Rendering rule applied on items before mosaic operation.


lockRasterIds : list<string>

The collection of raster IDs for image service rasters forced to be visible at all scales.

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

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

Note: lockRasterIds and lockRasterIdsAsInts can be used interchangeably. Both reference the same underlying Runtime property.

See also lockRasterIdsAsInts.


lockRasterIdsAsInts : list<int>

The same as lockRasterIds but represented as an integer types (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

Note: lockRasterIds and lockRasterIdsAsInts can be used interchangeably. Both reference the same underlying Runtime property.


mosaicMethod : Enums.MosaicMethod

Specifies 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 Enums.MosaicMethodNone.


mosaicOperation : Enums.MosaicOperation

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 Enums.MosaicOperationFirst.


rasterIds : list<string>

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.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

Note: rasterIds and rasterIdsAsInts can be used interchangeably. Both reference the same underlying Runtime property.

See also rasterIdsAsInts.


rasterIdsAsInts : list<int>

The same as rasterIds but represented as an integer types (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

Note: rasterIds and rasterIdsAsInts can be used interchangeably. Both reference the same underlying Runtime property.


sortField : string

The field name used together with Enums.MosaicMethodAttribute method.


sortValue : string

The base sort value used together with Enums.MosaicMethodAttribute method and sortField parameter.


viewpoint : Viewpoint

The viewpoint used along with Enums.MosaicMethodViewpoint method.


whereClause : string

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.


Signal Documentation

ascendingChanged()

Emitted when the ascending property changes.

Note: The corresponding handler is onAscendingChanged.


itemRenderingRuleChanged()

Emitted when the itemRenderingRule property changes.

Note: The corresponding handler is onItemRenderingRuleChanged.


lockRasterIdsAsIntsChanged()

Emitted when the lockRasterIdsAsInts property changes.

Note: The corresponding handler is onLockRasterIdsAsIntsChanged.


lockRasterIdsChanged()

Emitted when the lockRasterIds property changes.

Note: The corresponding handler is onLockRasterIdsChanged.


mosaicMethodChanged()

Emitted when the mosaicMethod property changes.

Note: The corresponding handler is onMosaicMethodChanged.


mosaicOperationChanged()

Emitted when the mosaicOperation property changes.

Note: The corresponding handler is onMosaicOperationChanged.


rasterIdsAsIntsChanged()

Emitted when the rasterIdsAsInts property changes.

Note: The corresponding handler is onRasterIdsAsIntsChanged.


rasterIdsChanged()

Emitted when the rasterIds property changes.

Note: The corresponding handler is onRasterIdsChanged.


sortFieldChanged()

Emitted when the sortField property changes.

Note: The corresponding handler is onSortFieldChanged.


sortValueChanged()

Emitted when the sortValue property changes.

Note: The corresponding handler is onSortValueChanged.


viewpointChanged()

Emitted when the viewpoint property changes.

Note: The corresponding handler is onViewpointChanged.


whereClauseChanged()

Emitted when the whereClause property changes.

Note: The corresponding handler is onWhereClauseChanged.



Feedback on this topic?