Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for Qt

Raster layer (file)

Sample Viewer View Sample on GitHub

Create and use a raster layer made from a local raster file.

Use case

Rasters can be digital aerial photographs, imagery from satellites, digital pictures, or even scanned maps. An end-user will frequently need to import raster files acquired through various data-collection methods into their map to view and analyze the data.

How to use the sample

The sample will load with a map showing a basemap and a loaded raster layer. Tap on "Add Raster" to browse for a new raster file. On desktop platforms the sample also allows you to drag and drop supported raster files to load.

How it works

To add a RasterLayer as an operational layer from a local raster file:

  1. Create a Map with a Basemap. Once this has been loaded, raster layers will be re-projected on the fly to match the map.
  2. Create a Raster from a raster file.
  3. Create a RasterLayer from the raster.
  4. Add it as an operational layer with map.operationalLayers.append(rasterLayer).

Relevant API

  • Raster
  • RasterLayer

Offline Data

Read more about how to set up the sample's offline data here.

Link Local Location
Shasta.tif raster <userhome>/ArcGIS/Runtime/Data/raster/Shasta.tif

Additional information

See the topic What is raster data? in the ArcMap documentation for more information about raster images.

Tags

data, image, import, layer, raster, visualization

Sample Code

import QtQuick 2.6
import QtQuick.Controls 2.2
import Esri.ArcGISRuntime 100.9
import Esri.ArcGISExtras 1.1

Rectangle {
    id: rootRectangle
    clip: true
    anchors.fill: parent
    
    readonly property url dataPath: System.userHomePath + "/ArcGIS/Runtime/Data/raster/"
    readonly property var supportedFormats: ["img","I12","dt0","dt1","dt2","tc2","geotiff","tif", "tiff", "hr1","jpg","jpeg","jp2","ntf","png","i21","ovr"]
    property var rasterLayer: null

    MapView {
        id: mapView
        anchors.fill: parent

        Map {
            id: map

            BasemapImagery {}

            //! [RasterLayerFile qml new raster layer]
            RasterLayer {
                Raster {
                    path: dataPath + "Shasta.tif"
                }
                // ...
                //! [RasterLayerFile qml new raster layer]

                onLoadStatusChanged: {
                    if (loadStatus !== Enums.LoadStatusLoaded)
                        return;

                    mapView.setViewpointCenterAndScale(fullExtent.center, 80000);
                }
            }
        }
    }

    Rectangle {
        visible: addButton.visible
        anchors.centerIn: addButton
        radius: 8
        height: addButton.height + (16)
        width: addButton.width + (16)
        color: "lightgrey"
        border.color: "darkgrey"
        border.width: 2
        opacity: 0.75
    }

    Button {
        id: addButton
        anchors {
            bottom: parent.bottom
            horizontalCenter: parent.horizontalCenter
            margins: 32
        }

        text: "Add Raster"
        onClicked: loader.open();
    }

    RasterLoader {
        id: loader
        anchors.fill: rootRectangle
        folder: dataPath
        supportedExtensions: supportedFormats

        onRasterFileChosen: {
            createAndAddRasterLayer(url);
        }
    }

    function createAndAddRasterLayer(rasterUrl) {
        const newRaster = ArcGISRuntimeEnvironment.createObject("Raster", {path: rasterUrl});
        rasterLayer = ArcGISRuntimeEnvironment.createObject("RasterLayer", {raster: newRaster});

        rasterLayer.loadStatusChanged.connect(zoomToRaster);

        map.operationalLayers.clear();
        map.operationalLayers.append(rasterLayer);
    }

    function zoomToRaster(){
        if (rasterLayer === null)
            return;

        if (rasterLayer.loadStatus !== Enums.LoadStatusLoaded)
            return;

        mapView.setViewpointCenterAndScale(rasterLayer.fullExtent.center, 80000);
    }
}
import QtQuick 2.6
import Qt.labs.platform 1.0 as Dialogs

Item {
    id: root
    signal rasterFileChosen(url url);

    property var supportedExtensions: []
    property alias folder: fileDialog.folder

    function open() {
        fileDialog.open();
    }

    DropArea {
        anchors.fill: parent

        onDropped: {
            if (!drop.hasText)
                return;

            if (drop.urls.length !== 1)
                return;

            if (!root.validateFileExtension(drop.urls[0]))
                return;

            if (drop.proposedAction !== Qt.MoveAction && drop.proposedAction !== Qt.CopyAction)
                return;

            drop.acceptProposedAction();
            root.rasterFileChosen(drop.urls[0]);
        }
    }

    Dialogs.FileDialog {
        id: fileDialog

        onAccepted: {
            root.rasterFileChosen(fileDialog.file)
        }
    }

    function validateFileExtension(filePath) {
        const extension = filePath.split('.').pop();
        const idx = supportedExtensions.indexOf(extension);

        return idx !== -1;
    }

    onSupportedExtensionsChanged: {
        let nameFiltersString = "Raster files (";
        for (let i = 0; i < supportedFormats.length; i++)
            nameFiltersString += "*." + supportedFormats[i] + " ";

        nameFiltersString += ")";
        fileDialog.nameFilters = nameFiltersString;
    }
}