# Interface MosaicRuleJson

Specifies the mosaic rule when defining how individual images should be mosaiced. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. Mosaic rules are for mosaicing rasters in the mosaic dataset.

See https://developers.arcgis.com/web-map-specification/objects/mosaicRule/ https://developers.arcgis.com/web-scene-specification/objects/mosaicRule/.

interface MosaicRuleJson {
ascending?: boolean;
fids?: number[];
itemRenderingRule?: string;
lockRasterIds?: number[];
mosaicMethod?:
| "esriMosaicNone"
| "esriMosaicCenter"
| "esriMosaicNadir"
| "esriMosaicViewPoint"
| "esriMosaicAttribute"
| "esriMosaicLockRaster"
| "esriMosaicNorthwest"
| "esriMosaicSeamline";
mosaicOperation?:
| "MT_FIRST"
| "MT_LAST"
| "MT_MIN"
| "MT_MAX"
| "MT_MEAN"
| "MT_BLEND"
| "MT_SUM";
multidimensionalDefinition?: {
dimensionName?: string;
isSlice?: boolean;
values?: number[];
variableName?: string;
}[];
sortField?: string;
sortValue?: string | number;
viewpoint?: PointJson;
where?: string;
}

#####
Index

### Properties

ascending?
fids?
itemRenderingRule?
lockRasterIds?
mosaicMethod?
mosaicOperation?
multidimensionalDefinition?
sortField?
sortValue?
viewpoint?
where?

##
Properties

### `Optional` ascending

ascending?: boolean

Indicates whether the sort should be ascending.

### `Optional` fids

fids?: number[]

A list that defines a subset of rasters used in the mosaic, be aware that the rasters may not be visible at all scales.

### `Optional` itemRenderingRule

itemRenderingRule?: string

The rendering rule applies on items before mosaicing.

### `Optional` lockRasterIds

lockRasterIds?: number[]

Lock a few rasters in the image service. Used together with esriMosaicLockRaster.

### `Optional` mosaicMethod

mosaicMethod?:
| "esriMosaicNone"
| "esriMosaicCenter"
| "esriMosaicNadir"
| "esriMosaicViewPoint"
| "esriMosaicAttribute"
| "esriMosaicLockRaster"
| "esriMosaicNorthwest"
| "esriMosaicSeamline"

The mosaic method determines how the selected rasters are ordered.

### `Optional` mosaicOperation

mosaicOperation?:
| "MT_FIRST"
| "MT_LAST"
| "MT_MIN"
| "MT_MAX"
| "MT_MEAN"
| "MT_BLEND"
| "MT_SUM"

Use the mosaic operation to resolve overlap pixel values: from first or last raster, use the min, max or mean of the pixel values, or blend them.

### `Optional` multidimensionalDefinition

multidimensionalDefinition?: {
dimensionName?: string;
isSlice?: boolean;
values?: number[];
variableName?: string;
}[]

Definition of multidimensional variables.

See https://developers.arcgis.com/web-map-specification/objects/multidimensionalDefinition/ and https://developers.arcgis.com/web-scene-specification/objects/multidimensionalDefinition/.

#### Type declaration

- ##### `Optional` dimensionName?: string

  Type of dimension being used (ex. StdTime).

- ##### `Optional` isSlice?: boolean

  Is slice?

- ##### `Optional` values?: number[]

  Numerical array of associated values.

- ##### `Optional` variableName?: string

  Name of the variable.

### `Optional` sortField

sortField?: string

The field name used together with esriMosaicAttribute method.

### `Optional` sortValue

sortValue?: string | number

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

### `Optional` viewpoint

viewpoint?: PointJson

Use a view point along with esriMosaicViewpoint.

### `Optional` where

where?: string

Use a where clause to define a subset of rasters used in the mosaic, be aware that the rasters may not be visible at all scales.