The 100.0.0 version of ArcGIS Runtime SDK for Android is the next generation of ArcGIS Runtime.
This major release introduces new and purposefully redesigned APIs from previous releases. This topic describes what's new, what's changed, and known limitations in this release.
The 100.0 release is the first release in the Quartz family. The Quartz code name reflects the next generation of ArcGIS Runtime, built from the ground up using a new architecture. This has enabled new capabilities and performance optimizations and provides API and functional consistency across all of the Runtime SDKs. The entire API was re-imagined to incorporate these new capabilities and best-of-breed ideas from all of the ArcGIS Runtime SDKs.
Below are details of what's new and changed in this release.
Due to a revamped architecture and improved API, changes are required to use projects that were built with version 10.2.6.
This release of the ArcGIS Runtime puts the map at the heart of the API to allow developers to quickly leverage the ArcGIS platforms Web GIS capabilities. The following additions highlight the benefits of the new ArcGIS Runtime release.
The Map object has been split out from the view that displays it, to represent a model component from a Model-View-Controller architecture. This important object at the heart of the ArcGIS Runtime has an API that follows the ArcGIS Web GIS information model. It contains operational layers, basemaps, bookmarks, popups and other ArcGIS specific data to enable these to be leveraged in your apps. It also includes convenient APIs to instantiate it from URLs, portal items or default basemaps so you can get great maps working quickly.
Version 2.0 of web maps and higher are supported (web maps from Portal for ArcGIS 10.3 and above); pre-2.0 versions are no longer supported.
GeoViews (MapView and SceneView) are solely responsible for display and interaction, separating concerns from the model objects and allowing the APIs to be simplified and harmonized between the 2D and 3D worlds. The Views contain Graphic Overlays, as well as operations to easily identify features and graphics without having to write any layer type specific code.
To make things easy for you, the APIs for common operations such as editing, searching, geocoding or routing are the same whether you are online or offline.
- Mobile map packages — Offline maps with great symbology, place search and directions can be packaged with ArcGIS Pro, side loaded onto your device and used in the Runtime through Mobile Map Packages. A mobile map package is a set of items bundled together for transport, often for use in offline workflows. The items are one or more maps, their associated layers and data, and optionally networks and locators. A mobile map package also includes metadata about the package.
- Offline services — You can also take your connected ArcGIS based feature and tiled layers offline line on demand with dedicated Tasks and associated Jobs. The GeodatabaseSyncTask works with ArcGIS feature services to take features offline in a mobile geodatabase (.geodatabase file) and allow them to be edited and synced. The ExportTileCacheTask extracts tiles from a tiled ArcGIS map service as a tile package (.tpk file) and allows them to be viewed offline.
For more information, see the "Create an offline map" topic in this guide.
Vector tiled layers
You can use vector tiled layers in your ArcGIS Runtime app. These layers are similar to raster-based tiled layers but they are faster, smaller, and look better on high resolution devices. They also differ in the way cartography is delivered. Instead of raster pixels, vector tiled layers deliver cartography using vectors so cartography is rendered at runtime leveraging all the available pixels on the device. The file format is binary and conforms to the Mapbox vector tile specification. Vector tiled layers don't contain any feature data and they don't support identify or search operations. For details, see the API reference for ArcGISVectorTiledLayer or see the "Tiled layers" section in the "Layers" topic in this guide.
Graphics as overlays
Graphics have always been used to display temporary application data on top of a map. To formalize this usage, graphics are now added to GeoViews (MapView or SceneView) as overlays. This ensures that graphics are always displayed on top, even when map layers are reordered. This also makes it convenient to switch out maps while still keeping the graphics in place. For more information, see the "Add graphics overlays to your app" topic in this guide. It is now also possible to identify graphics overlays in a map view via a single convenient method.
Raster (in beta)
This capability is Beta for deploying on mobile platforms.
You can now add raster data on desktop devices from many popular raster file formats such as DTED (Digital Terrain Elevation Data), GeoTIFF, RPF (Raster Product Format), NITF (National Imagery Transmission Format), HRE (High Resolution Elevation), Erdas Imagine, etc.
World files are no longer required to display GeoTiff and NITF formats.
Change the visualization of raster data by computing hillshades, applying colormaps, or stretching the statistical distribution of pixel values.
New layer names
Other changes have been made to layer names: Use ArcGIS map image layers for adding ArcGIS Server map services. Use ArcGIS tiled layers for adding ArcGIS Server tiled map services and tile packages. Use a Feature layer with associated Feature Tables for adding layers or tables from ArcGIS feature services and geodatabases (including non-spatial tables). See the "Layers" topic in this guide for information on the supported layer types.
Web map pop-ups
Web map pop-ups allow you to customize how the data in your layers are presented to users. A new full popup API has been added to allow you to tap into the their configuration and build great user experiences for your users which include feature editing. Those layers which allow popup definitions implement the new PopupSource interface. The map view also provides coarse-grained methods to identify pop-ups taking into consideration different types of layers, their visibility, scale range, and pop-up configuration, and so on, and returns a list of pop-ups for features at a given location.
Version 2.0 of web maps and higher are supported (web maps from Portal for ArcGIS 10.3 and above); pre-2.0 versions are no longer supported.
The mapping API seamlessly integrates with the portal API, allowing you to access portal content and use them as maps. You can also edit existing maps or author completely new maps and save them back to the portal, which can then be used elsewhere in the ArcGIS system. For details see the "Access portal content" topic in this guide.
Resources, such as maps, layers, tasks etc, that load metadata asynchronously to initialize their state adopt the loadable pattern. This pattern makes the behavior of loading state more consistent and uniform, and also makes its asynchronous nature more explicit. Loadable resources do not automatically load their state. They load lazily, when asked either by the developer, or by other objects that depend on it. The status of a loadable resource can be easily monitored to determine if it is loading, loaded successfully, or failed to load, and you can retry loading it if it failed to load. For more information, refer to the loadable pattern topic in this guide.
Features retrieved from ArcGISFeatureTable have been optimized to contain only a minimum set of attributes which are required to render them on a map. To get the full list of attributes, the feature has to be explicitly loaded. This optimization reduces latency and bandwidth consumption while displaying features, but still allows you get the feature's complete data if you want to edit or display feature details. When editing features, they must be loaded first.
Centralized handling of authentication
All security and authentication related aspects are managed by a newAuthenticationManager class which helps to unify and centralize how authentication is performed regardless of the security mechanism being used or the operation being performed. The authentication manager issues an authentication challenge whenever security related events are encountered. Developers can monitor these challenges and respond with credentials to get access to secured resources, or allow the authentication manager to prompt the end user for credentials. For more information, refer to the API reference documentation for AuthenticationManager
Geometries and geometry builders
The fundamental geometry objects remain the same - point, multipoint, polyline, and polygon but they are immutable and cannot be modified once they are created. The constructors on geometry objects allow them to be created easily in one shot if their coordinates are known, but you can also use geometry builders to progressively construct new geometries, either from scratch or by using an existing geometry as the starting point and then manipulating its coordinates. For more information see the "Edit geometries" topic in this guide.
It's now easier to determine where errors occur in the stack so you can provide better error messages to your users. A new standardized error domain property is available, which indicates if the error occurred client-side within the ArcGIS Runtime or server-side from an ArcGIS Server service or web service. A consistent error code property can be used to further diagnose what the error was and what error message should be displayed to the user. A listing of error code descriptions is provided in the "Platform error codes" topic in this guide.
New async pattern
A brand new consistent asynchronous pattern has been developed, extending the familiar Future java pattern with an interface called ListenableFuture. This new API allows you to add as many listeners as required to know when the method is complete.
Support for writing Qt Widgets C++ apps on macOS
ArcGIS Runtime SDK 100.0 for Qt adds support for writing C++ apps on macOS, in addition to Windows and Linux.
Support for C++ apps that expose maps through QML
In previous versions of the SDK you had the choice of writing your apps with C++ or QML. If you wrote using C++ you could not expose a map that could easily participate in a UI built with QML. Now you can. Map views are represented with one of two C++ classes or a QML type that you choose based on the type of app you are designing. Choose the map view type for your app using the table below.
Map view types
|App Pattern||Use this API||Use this map view type||Runs on Windows, Linux or macOS||Runs on iOS and Android|
If you choose to develop a hybrid C++/QML app, you will use C++ to write your ArcGIS Runtime logic. Only the MapView is exposed to QML. Refer to the topic Display a map for details.
- Deadlocks may occur if a map is destructed while it has outgoing requests.
- In some cases, wrap-around does not stay enabled.
- Map zooms in and out (5-10%) when dragged between monitors with different DPI
- Some specialized layers are not supported in this release: KML, WMS, WMTS, OpenStreetMap, Bing, CSV by reference and GeoRSS.
- Maps do not open consistently at exactly the same initial extent.
- Map view grid lines close to the date line and poles may not display.
- MapView doesn't zoom to geometry if the supplied geometry's envelope has zero height or width.
- Cloning/copying an unloaded map does not render in a map view.
- Quickly opening a mobilemap and then destroying the mapview may cause a crash
- A web map won't open when a feature layer's type ID is not an integer.
- Pop-up title does not use name when its defined with a coded value domain field.
- There's an inconsistency in handling null values in JsonSerializable UnknownJson.
- Map does not display any features for FeatureLayer with date-based definition expression using the timestamp keyword.
- Vector tiled layers (ArcGISVectorTiledLayer)
- DrawStatus does not complete when zoomed out to lowest level of detail (LOD) and no labels are displayed
- Vector tile symbols don't scale consistently with DPI
- Vector tiled layers created from a URL don't have attribution
- Crash may occur on Android when zooming and panning with vector tiled layers.
- A vector tiled layer may crash if you interact with it before it has begun drawing.
- ArcGISTiledLayer fails to load with cached image service as portal item
- If the URL property under basemap doesn't exist in a layer type unsupported by ArcGIS Runtime, the layer will not get serialized.
- Overrides to definition expressions on sublayers in a map image layer from a portal item are not respected.
- Identifying a GeoElement may cause unexpected behavior when a MapImageLayer is present in the Map or Scene.
Symbols, renderers and graphics
- Points are not drawn on a graphics overlay if they're on the dateline.
- If min/max scale is changed on graphics overlay before the map is loaded, min/max scale on the map view is locked.
- The LocationDisplay symbol may sometimes behave strangely in navigation mode.
- ClassBreaksRenderer with one class break and no minimum value symbolizes features incorrectly
- Popup.Symbol returns null for features from a map service.
- For GraphicsOverlay, the selection doesn't show for fully transparent symbols.
- When creating a feature collection from an array of graphics, the graphics symbols are not honored.
- For graphics overlays in dynamic mode, a renderer's rotation is used even if the graphic's symbol is overridden.
- Symbol rotation type (arithmetic/geographic) is ignored by graphics.
- Extrusion is applied to symbol in graphics when it should only be applied on symbol in renderer
- Feature layers from federated 10.3 and 10.3.1 ArcGIS Servers cannot use the default advanced symbology setting.
- Features with uncompressed BMP symbols may not display.
- Static graphic overlays render fill symbols with an outline even if it is set to Null. Use a transparent outline instead.
- Large amounts of local feature data delays tiles
- When syncing a large geodatabase, offline features disappear intermittently during map interaction
- Synchronizing large geodatabases with many features and no local edits may take longer than expected.
- ArcGIS Online doesn't support requesting features from feature services in a different spatial reference using the latest WKID value stored in a map
- TextSymbol doesn't honor the screen alignment property.
- Creating a feature with an invalid field name throws an incorrect error (an ownership-based access error)
- Sometimes, when changing zoom levels, there's a drawing delay for symbols for features in a FeatureLayer.
- Fetching attachments immediately after adding or deleting attachments returns no results. This is an intermittent issue and may be related to timing. Trying again to fetch attachments usually works. Failures seen in release mode cannot be reproduced in debug mode.
- 3D symbols sometimes do not draw properly on OpenGL ES platforms (Android, iOS, and ANGLE). For example, simple marker scene symbols can disappear when zooming in close while using relative surface placement, or model marker symbols can display white with no texture.
- Animating both a SceneView and a MapView simultaneously may cause the displays to flicker.
- Setting a viewpoint on a SceneView with distance from moving a graphic appears to judder (non-smooth animation).
- Polygon and Polyline symbols don't display on iOS in 3D scenes using dynamic mode.
- Polygon add a red outline in 3D scenes using dynamic mode when selected.
- SimpleFillSymbol in 3D can overlap its border.
- Raster renderer produces different results between MapView and SceneView
- RasterLayer doesn't free a used raster before the application is shut down.
- Applying a raster blend renderer to a layer may not cause a rendering change until you zoom in or out.
- To return m and z values from the Submit geoprocessing tasks, you must include the returnZ=true and return=true parameters to the call that fetches the output value of the GeoprocessingFeature.
- Suggestion results from local street address locators cannot be used to retrieve results if they don't contain a house number
- Geodatabase objects may be taken out of scope too soon, so accessing tables once the geodatabase is loaded may fail. It's recommended to keep the geodatabase as a global variable.
- Locator performance may be poor for larger local locator datasets.
- Calling pause on a job that is downloading a file does not pause the job.
- Creating a FeatureCollectionTable from a FeatureQueryResult throws an exception.
- ReturnGeometry set to false is not honored when QueryParameter is passed to PopulateFromServiceAsync
- Loading feature layers with apps built on Linux may load feature layers more slowly than with apps built on other platforms. This issue is under investigation.
- Occasionally, the static function Esri::ArcGISRuntime::SpatialReference::wgs84() will return a null SpatialReference. This usually happens very early in code execution when the function is called in the header file.
- The "model" types, such as BookmarkListModel and LayerListModel, are supported with Qt Quick views but not fully supported with Qt Widget views.
- Importing a pfx file for PKI authentication on macOS or iOS fails due to Qt issue (https://bugreports.qt.io/browse/QTBUG-56596)
- The WebView for OAuth 2.0 with SAML Authentication may not work on mobile platforms.
The WebView for OAuth 2.0 with Enterprise logins may not work on mobile platforms.
- PKI authentication requires you to wait 60 seconds after initial challenge before you can successfully authenticate.
Android file paths containing spaces
There are some issues to watch for when working with the Android app template in Qt Creator on Windows. Due to a Qt Company bug relating to when there are spaces in the file path referenced in the Android .prf file, we added logic to the Android deployment process to copy the .so file into the users output build folder. This is the temporary solution for Android until this is fixed by the Qt Company. However, the process can still fail if the output folder has a space in it.