Skip To Content

AppStudio Framework

The AppStudio Framework provides QML components used when creating apps in AppStudio for ArcGIS. It includes components from ArcGIS Runtime and components that target cross platform app development.

At the beginning of every QML file, import the modules you will use in that file. The available AppStudio Framework modules are the following:

import ArcGIS.AppFramework 1.0
import ArcGIS.AppFramework.Barcodes 1.0
import ArcGIS.AppFramework.Desktop 1.0
import ArcGIS.AppFramework.Dialogs 1.0
import ArcGIS.AppFramework.Multimedia 1.0
import ArcGIS.AppFramework.Speech 1.0
import ArcGIS.AppFramework.Networking 1.0
import ArcGIS.AppFramework.WebView 1.0

The following modules are in beta and contain unfinished functionality that is subject to change:

import ArcGIS.AppFramework.Authentication 1.0
import ArcGIS.AppFramework.Devices 1.0
import ArcGIS.AppFramework.Notifications 1.0
import ArcGIS.AppFramework.Notifications.Local 1.0
import ArcGIS.AppFramework.Positioning 1.0
import ArcGIS.AppFramework.Promises 1.0
import ArcGIS.AppFramework.SecureStorage 1.0 
import ArcGIS.AppFramework.Sql 1.0

The following module is required for apps built with Runtime 100.7:

import Esri.ArcGISRuntime 100.7

For information on how to implement modules for ArcGIS Runtime 100.7, see the guide for ArcGIS Runtime SDK for Qt.

AppFramework

This is the parent level Esri module used by AppStudio. It contains cross platform components that are not found in Qt Quick but are useful for making apps. AppFramework includes the following:

  • App infrastructure
  • File system components
  • Network components
  • UI widgets
  • Additional plug-ins

The QML components of this module are documented in the Qt Creator Help system. Choose Help in Qt Creator and choose AppStudio Framework from the contents list.

AppFramework.Barcodes

This module is based on code from the ZXing C++ library. It contains a single component called BarcodeDecoder. This component will soon be added to the AppStudio Framework help in Qt Creator. For details, see https://github.com/glassechidna/zxing-cpp.

AppFramework.Controls

This module is in the process of being deprecated, and should not be used. It currently contains CalloutRectangle, Fader, and ImageButton.

AppFramework.Dialogs

This module is not complete. It currently contains CameraProperties, CameraPropertyChooser, CameraPropertySection, CameraPropertySlider, CameraPropertyText, ImageCaptureDialog, and ImageChooserDialog. These components will be added to the AppStudio Framework help in Qt Creator.

AppFramework.Sensors (desktop only)

This module is in the process of being deprecated, and should not be used. It contains GpsStatus, KestrelK4xxx, LeicaDisto, LTITruPulse, and NmeaGPS. These components can only be used on desktop systems that have serial port connectivity. These components will be added to the AppStudio Framework help in Qt Creator.

Esri.ArcGISRuntime (when using Runtime 100.7)

This module contains the equivalent of the ArcGIS.Runtime module in the ArcGIS Runtime SDK for Qt (QML API) and includes the following:

  • Map control
  • Layers
  • Geometry
  • Portal
  • Geocoding
  • Network analysis
  • Geodatabase
  • Symbology
  • Webmap

The QML components in this module are documented in the Qt Creator Help system. Choose Help in Qt Creator and choose ArcGIS Runtime SDK for Qt (QML API) from the contents list.