RasterLayer QML Type
A RasterLayer is used to render data from a Raster onto a Map. More...
| Import Statement: | import Esri.ArcGISRuntime 100.9 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- fullTimeExtent : TimeExtent
- item : ArcGISItem
- popupDefinition : PopupDefinition
- popupEnabled : bool
- raster : Raster
- renderer : RasterRenderer
- supportsTimeFiltering : bool
- timeFilteringEnabled : bool
- timeInterval : TimeValue
- timeOffset : TimeValue
Signals
- fullTimeExtentChanged()
- popupDefinitionChanged()
- popupEnabledChanged()
- rasterChanged()
- rendererChanged()
- supportsTimeFilteringChanged()
- timeFilteringEnabledChanged()
- timeIntervalChanged()
- timeOffsetChanged()
Detailed Description
RasterLayer adopts the loadable pattern; many of its properties are initialized asynchronously. See Loadable for more information.
In its simplest form, raster data consists of a matrix of cells (or pixels) organized into rows and columns (or a grid), where each cell contains a value representing information. RasterLayer can support these main raster data sources:
- Raster files - path to a file on the device
- Remote ArcGIS Image services - see ImageServiceRaster
- Raster files within GeoPackages - see GeoPackageRaster
- Mosaic datasets - see MosaicDatasetRaster
You can change how a raster layer is visualized by creating a RasterRenderer and applying it to the layer. Each raster layer supports identify on its individual cells when it is displayed in a MapView or SceneView.
If a raster dataset has just one value associated with each cell it is called a single- band raster. For example, in a digital elevation model (DEM) each cell contains one value representing the elevation at that location.
A satellite image, however, commonly has multiple bands representing different wavelengths of the electromagnetic spectrum. Landsat imagery, for example, contains seven bands that represent data from the visible and infrared parts of the spectrum. Rasters are particularly useful for remote sensing tasks, such as monitoring vegetation and seeing through smoke to analyze an active fire.
Raster datasets can be large. The size of the dataset depends on:
- The geographic extent of the data
- The size of the cells used (resolution)
- The number of bands
As with any data consumed locally, file size can be an issue for storage as well as for transferring datasets over the network.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| Raster | raster |
| RasterRenderer | renderer |
| ArcGISItem | item |
Note: The RasterLayer will automatically reproject on the fly. For example, this would mean that a RasterLayer that is in WKID 4326 could be added to a Map that is in WKID 3857, and the RasterLayer would project on-the-fly to WKID 3857.
Learn more about rasters from the ArcGIS Desktop documentation.
For samples, see:
- Raster layer (GeoPackage)
- Raster layer (file)
- Hillshade renderer
- Raster layer (service)
- Raster function (file)
See also Layer, LayerContent, Raster, Loadable, ImageAdjustmentLayer, ImageServiceRaster, GeoPackageRaster, MosaicDatasetRaster, PopupSource, and TimeAware.
Property Documentation
fullTimeExtent : TimeExtent |
Returns the full time extent of the time aware layer (read-only).
Note: This property is only available after the time aware layer is loaded.
This property was introduced in Esri.ArcGISRuntime 100.3.
See also TimeExtent.
[default] item : ArcGISItem |
The image service raster portal item used to initialize this RasterLayer.
The item cannot be changed after the layer is loaded.
popupDefinition : PopupDefinition |
See also PopupSource.
See also PopupSource.
[default] raster : Raster |
The Raster used to create the RasterLayer.
[default] renderer : RasterRenderer |
The raster renderer for this layer..
Returns whether the time aware layer supports filtering its contents by time values (read-only).
This property was introduced in Esri.ArcGISRuntime 100.3.
Returns whether the time aware layer participates in filtering based on the time extent of its geo view.
This property was introduced in Esri.ArcGISRuntime 100.3.
timeInterval : TimeValue |
Returns a time interval that represents the suggested step size for use when manipulating the time extent (read-only).
This information can be used to set the step size for a time slider control.
Note: This property is only available after the time aware layer is loaded.
This property was introduced in Esri.ArcGISRuntime 100.3.
See also TimeValue.
timeOffset : TimeValue |
The time offset of the time aware layer.
The time offset is subtracted from the time extent set on the time aware layer's geo view. This can be used to overlay data from different periods of time for comparison.
Note: This property is only available after the layer is loaded.
This property was introduced in Esri.ArcGISRuntime 100.3.
See also TimeValue.
Signal Documentation
Emitted when the fullTimeExtent property of the time aware layer changes.
Note: The corresponding handler is onFullTimeExtentChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Emitted when the popupDefinition property changes.
Note: The corresponding handler is onPopupDefinitionChanged.
Emitted when the popupEnabled property changes.
Note: The corresponding handler is onPopupEnabledChanged.
Emitted when the raster property changes.
Note: The corresponding handler is onRasterChanged.
Emitted when the renderer property changes.
Note: The corresponding handler is onRendererChanged.
Emitted when the supportsTimeFiltering property of the time aware layer changes.
Note: The corresponding handler is onSupportsTimeFilteringChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Emitted when the timeFilteringEnabled property of the time aware layer changes.
Note: The corresponding handler is onTimeFilteringEnabledChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Emitted when the timeInterval property of the time aware layer changes.
Note: The corresponding handler is onTimeIntervalChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Emitted when the timeOffset property of the time aware layer changes.
Note: The corresponding handler is onTimeOffsetChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.