ImageServiceRaster QML Type

  • Esri.ArcGISRuntime
  • ImageServiceRaster
  • Represents a raster based off an image service. More...

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

    Raster

    Properties

    Signals

    Detailed Description

    An image service provides access to raster data through a web service. A single raster dataset or a mosaic dataset which contains a collection of raster datasets can be served as one image service. The mosaic dataset can dynamically process and mosaic the images on the fly. An image service supports accessing both the mosaicked image and its catalog, as well as individual rasters in the catalog. An image service raster allows you to display raster data from image services using a RasterLayer. It also allows you to apply service-defined or client-defined rendering rules by setting renderingRule on it. You can pass an image service raster as a raster input to a RasterFunction to work with local raster functions.

    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.

    Create an ImageServiceRaster:

    // create the raster layer from an image service raster
    ImageServiceRaster {
        id: imageServiceRaster
        url: "https://gis.ngdc.noaa.gov/arcgis/rest/services/bag_hillshades_subsets/ImageServer"
    
        // zoom to the center of the raster once it's loaded
        onLoadStatusChanged: {
            if (loadStatus === Enums.LoadStatusLoaded) {
                const scale = 100000;
                mapView.setViewpointCenterAndScale(ArcGISRuntimeEnvironment.createObject("Point", {x: -13643095.660131, y: 4550009.846004}), scale);
            }
        }
    }

    You can see the complete code in the QML sample Raster Layer Service.

    See also Loadable and Raster.

    Property Documentation

    [default] credential : Credential

    The security credential used to access the image service.

    Only applicable if the service is secured.


    [default, since Esri.ArcGISRuntime 100.9] mosaicRule : MosaicRule

    The mosaic rule used for combining a number of input rasters that are often overlapping.

    This property was introduced in Esri.ArcGISRuntime 100.9.


    [default] renderingRule : RenderingRule

    The rendering rule to apply.


    [default] requestConfiguration : RequestConfiguration

    The configuration parameters used for network requests sent to this service.


    [read-only] serviceInfo : ArcGISImageServiceInfo

    Returns the service info corresponding to this image service.


    url : url

    The url to the image service.

    Note: You cannot set the url to the ImageServiceRaster after the instance is already loaded.


    Signal Documentation

    credentialChanged()

    Emitted when the credential property changes.

    Note: The corresponding handler is onCredentialChanged.


    [since Esri.ArcGISRuntime 100.9] mosaicRuleChanged()

    Emitted when the mosaicRule property changes.

    Note: The corresponding handler is onMosaicRuleChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.9.


    renderingRuleChanged()

    Emitted when the renderingRule property changes.

    Note: The corresponding handler is onRenderingRuleChanged.


    requestConfigurationChanged()

    Emitted when the requestConfiguration property changes.

    Note: The corresponding handler is onRequestConfigurationChanged.


    serviceInfoChanged()

    Emitted when the serviceInfo property changes.

    Note: The corresponding handler is onServiceInfoChanged.


    urlChanged()

    Emitted when the url property changes.

    Note: The corresponding handler is onUrlChanged.


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