AddRastersParameters QML Type

Adds raster datasets to a MosaicDatasetRaster by setting various parameters. More...

Import Statement: import Esri.ArcGISRuntime
Since: Esri.ArcGISRuntime 100.1


Inherited By:




Detailed Description

Mosaic datasets (via the MosaicDatasetRaster class) are used to manage, display, serve, and share raster data. When you create a new mosaic dataset, it is created as an empty container in a geodatabase to which you can add raster data. The AddRastersParameters object provides the mechanism to set various properties, so that a raster can be added to a mosaic dataset via the MosaicDatasetRaster class.

Some of the parameters (also called properties) on the AddRastersParameters class that enable adding a raster into a mosaic dataset also include specifying the file filter type (like .tif or .jpg) of the rasters that are to be included (AddRastersParameters::filter property), the directory location of the raster files (AddRastersParameters::inputDirectory property), the minimum pixel cell size of the raster to be included AddRastersParameters::minPixelSizeFactor property), and more.

Property Documentation

addRastersParametersType : Enums.AddRastersParametersType

Returns the AddRastersParameters type (read-only).

See also Enums.AddRastersParametersType.

filter : string

The raster filename filter.

The optional raster filename filter is a regular expression with ECMA-262 grammar.

inputDirectory : url

The optional input directory of rasters.

inputFile : string

The optional input CSV file.

maxPixelSizeFactor : double

The optional maximum pixel size factor.

minPixelSizeFactor : double

The optional minimum pixel size factor.

rasterFunctionTemplateFile : string

The optional raster function template file.

Signal Documentation


Emitted when the filter property changes.

Note: The corresponding handler is onFilterChanged.


Emitted when the inputDirectory property changes.

Note: The corresponding handler is onInputDirectoryChanged.


Emitted when the inputFile property changes.

Note: The corresponding handler is onInputFileChanged.


Emitted when the maxPixelSizeFactor property changes.

Note: The corresponding handler is onMaxPixelSizeFactorChanged.


Emitted when the minPixelSizeFactor property changes.

Note: The corresponding handler is onMinPixelSizeFactorChanged.


Emitted when the rasterFunctionTemplateFile property changes.

Note: The corresponding handler is onRasterFunctionTemplateFileChanged.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.