ArcGIS Runtime API Toolkit
Current Release: 100.2.1
This project contains QML source code for controls and utilities you can use with the ArcGIS Runtime SDK for Qt. There are QML examples in this repo that demonstrate the use of these controls and how they can be used as resuable building blocks for your QML-based ArcGIS applications.
- UserCredentials Dialog - A dialog that takes in a username and password. It can be connected with a UserCredentials instance and a Portal instance to sign into Portal for ArcGIS or ArcGIS Online. The dialog is customizable, as the top banner and several labels can be changed.
- AuthenticationView Dialog - A wrapper view that will automatically display the proper authentication view for any of the supported authentication types (OAuth, Token, HTTP Basic, HTTP Digest, SAML, PKI).
- ClientCertificateView Dialog - A dialog for handling PKI authentication.
- OAuth2View Dialog - A dialog for handling OAuth authentication.
- SslHandshakeView Dialog - A dialog for allowing/blocking SSL Handshake related issues.
- UserCredentialsView Dialog - A generic dialog for handling username/password authentication.
- Callout Control - A view for displaying information at a geographic location on the map.
- PopupView Control - A view for displaying attributes and attachments for features.
- Fork and then clone the repo or download the .zip file.
- The Toolkit components are designed to be used with the ArcGIS Runtime SDK for Qt. Confirm that your system meets the minimum requirements for using the ArcGIS Runtime SDK for Qt. See the below version section to ensure you have the correct version of the Toolkit and ArcGIS Runtime.
- Add a QML Import Path that points to your local repository's installed location into your project. The process for this is documented in the Import Statements Qt documentation. For example, you could do any of the following:
- Add an environment variable -
- Add a qmake variable -
- Add the path to the QML Engine's path list in C++ code -
- Import the QML plugin modules in your project. For example:
import Esri.ArcGISRuntime.Toolkit.Controls 100.2
import Esri.ArcGISRuntime.Toolkit.Dialogs 100.2
Alternate Setup instructions (importing the Toolkit as a plugin)
Starting with Qt 5.9.0 on iOS, the Toolkit must be imported as a plugin.
- Follow the steps above (Setup instructions ) but skip step 3 for adding the Qml import paths to your project.
- Include ArcGISRuntimeToolkitPlugin.pri in your project file.
- The Toolkit will now be compiled into your application directly as a plugin.
Running the toolkit demo project
The toolkit repo has a demo project located in the Examples folder. This project is not meant to be a template to base your projects off of, but rather to be a quick and easy way to test and demonstrate the capabilities of various toolkit components. You can run the demo project by doing the following steps:
Examples.qmlprojectin Qt Creator
- Go to Projects > Run, and add a new variable called QML2_IMPORT_PATH, and set the value equal to the path of ArcGIS Runtime and the Toolkit. For example,
- Depending on your system, you may additionally need to add the path to the EsriCommonQt library into an environment variable. On Windows, add it to the PATH, on Linux, add it to LD_LIBRARY_PATH, and on macOS, add it to DYLD_LIBRARY_PATH. For example,
PATH=C:\Program Files (x86)\ArcGIS SDKs\Qt100.2.1\sdk\windows\x64\bin\release.
- The qmlscene application on Windows and Linux require that the path to the Qt libraries be specified in the PATH and LD_LIBRARY_PATH, respectively. For example,
- On Windows only, force the usage of ANGLE by setting the
QT_OPENGLenvironment variable to
- Run the app and select an example from the drop down.
The Toolkit is forwards compatible with the ArcGIS Runtime API. It is not backwards compatible. This means that version 100.0 of the Toolkit can be used with version 100.2 of the Runtime API. However, version 100.2 of the Toolkit cannot be used with version 100.0 of the Runtime API, as this version of the Toolkit may require functionality from a newer version of the Runtime API.
Use a previous version
master branch contains toolkit components for the current, most up-to-date version of ArcGIS Runtime. To access previous versions, you can checkout by a tag or commit, or alternativley you can download the source zip:
Find a bug or want to request a new feature? Please let us know by submitting an issue.
Anyone and everyone is welcome to contribute.
Copyright 2017 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's license.txt file.
Some files (ios_config.prf) are from the Qt SDK and modified to support the Toolkit. See https://www.qt.io/terms-conditions/ for license details for those files.