Release notes for 100.1

This page provides details about what's new in the 100.1 release of ArcGIS Runtime SDK for Android. It also lists this release's deprecations, resolved issues, and known issues.

What's new

3D

3D has been brought to the ArcGIS Runtime for native app development. Build 3D scenes with raster, tiled, and vector data sets including 3D specific symbology for great “better than flat” visualizations.

Raster support on mobile devices commercially available

In the previous release, apps that used local raster data on mobile phones and tablets could only be deployed as BETA; Raster was commercially supported only on desktop platforms. At 100.1, local raster capabilities are fully supported on mobile phones and tablets.

Take a map offline

Web maps or specific areas of a web map from a portal can be downloaded and used in disconnected scenarios. The new OfflineMapTask provides a high-level API to download the map definition and its related data. When the map is taken offline, it is stored as a mobile map. If the map contains sync-enabled feature layers, those can be edited offline and the changes synced when network connectivity is later available.

Client-side labeling control

A new LabelDefinition class is introduced that defines how labeling is applied to feature data for a given scale range. You can specify the following:

Which features are covered by the definition (by applying the label definition's where-clause)
What text should be displayed, based on the individual feature's attributes and the label definition label-expression formula. Arcade expressions are supported in label definitions and visual variables but not in unique value renderers or class breaks renderers.
How the text should appear, using the definition's text symbol
Where the text should appear with respect to its feature, using the definition's label placement
How to move or avoid other labels or features that would overlap each label

At this release, you can only construct a LabelDefinition instance from JSON but there is no explicit API for specifying labeling settings.

Support for additional layer types

This release adds support for the following data layer types.

OGC WMTS
Image Service
Dynamic sublayers of an ArcGIS Map Service
OpenStreetMap
Bing

Extensible tile layers

This release provides APIs to display custom tiles. The WebTiledLayer is an extensible layer that requests map tiles from a web service based on a URI template. It provides a simple way to integrate non-ArcGIS Services as a layer in a map. Also, custom tiled layers can be created by sub-classing ImageTiledLayer and its subclass, ServiceImageTiledLayer. These two abstract classes expose protected abstract methods to either fetch tile images or return the URL of the tile images. By extending these two classes and implementing the abstract methods, you can create custom tiled layers and add them to a map.

This release provides APIs for supporting related tables. With this, apps can handle workflows that involve reading, editing, and querying related data in both spatial and non-spatial tables. These related table workflows are supported in both online and offline maps. For details, see Relate features and Search for related features.

Display heat maps

A new HeatmapRenderer class uses the points in a layer to calculate and display the relative density of points on a map. The density is displayed as a heat map by smoothly varying sets of colors ranging from cool (low density of points) to hot (high density of points). At this release, this class is constructed only from JSON when it's defined in a web map and no explicit API is provided for working with it.

Sketch editor

A 2D SketchEditor class enables sketching geometries on a map. It can be used to create new geometries and edit existing ones. This type of sketching is typically done through user interaction; programmatic sketching is also supported. The SketchEditor class also support undo/redo of edits, custom styling of the editor, and a system of notifications for the developer to handle during the sketching process.

Editing of public feature services available at the Lite license level

The ability to perform edits in a connected environment on a public feature services from ArcGIS Online or Enterprise at the Lite license level has been introduced this release. At version 100.0, all editing capabilities began at the Basic level. The editing of private feature services or editing in an offline environment remains at the Basic, Standard, and Advanced licensing levels.

Service area and closest facility analysis

Closest facility and service area tasks are now available for performing more network analysis in your ArcGIS Runtime applications. A service area is a region that encompasses all streets that can be accessed within a given distance or travel time from one or more facilities. For example, a three-minute, drive-time polygon around a grocery store can determine which residents are able to reach the store within three minutes and are thus more likely to shop there. The closest facility task generates routes between facilities and incidents. Routes may include a route shape and driving directions. The task may generate routes from facilities to incidents or from incidents to facilities and can find a user specified number of routes, for example finding the three closest fire stations for an address.

Coordinate formatting

The CoordinateFormatter class can be used to convert between points and formatted coordinates notation strings such as decimal degrees; degrees, minutes, and seconds; U.S. National Grid (USNG); and Military Grid Reference System (MGRS).

Follow a graphic in 3D

Camera controllers allow you to change the default camera behavior in a scene view. Two "orbit" camera controllers were added to lock the focus of a camera to a fixed point target or a possibly moving graphic.

Support for StreetMap Premium packages

StreetMap Premium for ArcGIS Runtime is a new data product, licensed as an extension to ArcGIS Runtime, that provides enriched street data, which powers a high-quality cartographic map and high-quality search, geocoding, and route analysis. Streetmap Premium for ArcGIS Runtime maps are consistent across all regions of the world and can be taken offline for disconnected use; they can simultaneously fulfill the need for an address locator, street network dataset, and basemap in your app.

StreetMap Premium for ArcGIS Runtime delivers HERE data as a mobile map package (an .mmpk file) for your app to access locally. This MMPK format allows the data to be accessed offline and therefore doesn't consume data from your user's data plan. This is the same high-quality data used by ArcGIS Online services, including the World Geocoding Service, Routing Service, and Street Map Service.

GeoView Attribution

MapView and SceneView have been enhanced to automatically display attribution for map and scene layers respectively. The attribution is dynamic and updates as layers are added/removed, toggled on/off, or change visibility as they go in and out of scale range.

Other new items

Return type of MapView.getOnTouchListener() refactored from MapView.OnTouchListener() to View.OnTouchListener().

API additions

The following list shows the new classes which have been added to the API:

3D

ArcGISScene
ArcGISScene.BasemapChangedEvent
ArcGISScene.BasemapChangedListener
ArcGISSceneLayer
ArcGISTiledElevationSource
AtmosphereEffect
DefaultSceneViewOnTouchListener
DistanceCompositeSceneSymbol
ElevationSource
LightingMode
LocationToScreenResult
LocationToScreenResult.SceneLocationVisibility
MarkerSceneSymbol
ModelSceneSymbol
RasterElevationSource
SceneSymbol
SceneView
SimpleMarkerSceneSymbol
Surface

Layers

ArcGISMapServiceSublayerInfo
ArcGISMapServiceSublayerInfo.ServiceType
BingMapsLayer
BingMapsLayer.Style
ImageServiceRaster
ImageTiledLayer.NoDataTileBehavior
MapSublayerSource
OpenStreetMapLayer
RasterSublayerSource
ServiceImageTiledLayer
SublayerSource
WebTiledLayer

Web Map Tile Service

WmtsLayer
WmtsLayerInfo
WmtsService
WmtsServiceInfo
WmtsTileMatrixSet
WmtsTileMatrixSet.TileMatrix

Offline Map

GenerateOfflineMapJob
GenerateOfflineMapParameters
GenerateOfflineMapResult
OfflineCapability
OfflineMapCapabilities
OfflineMapItemInfo
OfflineMapSyncJob
OfflineMapSyncLayerResult
OfflineMapSyncParameters
OfflineMapSyncResult\
OfflineMapSyncTask
OfflineMapTask

RelatedFeatureQueryResult
RelatedQueryParameters
RelationshipCardinality
RelationshipConstraintViolation
RelationshipInfo
RelationshipRole
TableJoinSublayerSource
TableQuerySublayerSource
TableSublayerSource

Sketch Layer

SketchCreationMode
SketchEditor
SketchGeometryChangedEvent
SketchGeometryChangedListener
SketchStyle

General

AnimationCurve
ArcGISImageServiceInfo
AttributionTextChangedEvent
AttributionTextChangedListener
CameraController
CameraDistanceChangedEvent
CameraDistanceChangedListener
CameraHeadingOffsetChangedEvent
CameraHeadingOffsetChangedListener
CameraPitchOffsetChangedEvent
CameraPitchOffsetChangedListener
CoordinateFormatter
CoordinateFormatter.GarsConversionMode
CoordinateFormatter.LatitudeLongitudeFormat
CoordinateFormatter.MgrsConversionMode
CoordinateFormatter.UtmConversionMode
ExtendOptions
GeoprocessingParameterInfo
GeoprocessingTaskInfo
GlobeCameraController
HeatmapRenderer
OrbitGeoElementCameraController
OrbitLocationCameraController
PictureFillSymbol
PixelType
PopupRelatedFeaturesDefinition
PopupRelatedFeaturesSortOrder
RenderingRule
RenderingRuleInfo

API deprecations

The following list shows the deprecations in the API and where relevant the replacement API.

com.esri.arcgisruntime.concurrent package
- Job.setUri(String) - no equivalent available, this method is for internal use only.
com.esri.arcgisruntime.mapping.popup package
- PopupDefinition.setShowRelatedRecords(boolean) - replaced by PopupRelatedFeaturesDefinition.setShowRelatedFeatures(boolean)
- PopupDefinition.isShowRelatedRecords() - replaced by PopupRelatedFeaturesDefinition.isShowRelatedFeatures()
- PopupManager.getRelatedRecords() - use existing method ArcGISFeatureTable.queryRelatedFeaturesAsync(ArcGISFeature)
- PopupManager.isShowRelatedRecords(ArcGISMap) - use existing method PopupRelatedFeaturesDefinition#isShowRelatedFeatures()
com.esri.arcgisruntime.symbology package
- PictureMarkerSymbol(BitmapDrawable) - replaced by PictureMarkerSymbol.createAsync(BitmapDrawable)
- PictureMarkerSymbol.getImage() - use PictureMarkerSymbol.getImage(Resources) instead
com.esri.arcgisruntime.tasks.networkanalysis package
- RouteTask(String) - replaced by RouteTask(Context, String)
- RouteParameters.getPointBarriers() - replaced by RouteParameters.setPointBarriers(Iterable)
- RouteParameters.getPolygonBarriers() - replaced by RouteParameters.setPolygonBarriers(Iterable)
- RouteParameters.getPolylineBarriers() - replaced by RouteParameters.setPolylineBarriers(Iterable)
- RouteParameters.getStops() - replaced by RouteParameters.setStops(Iterable)

Issues fixed from earlier Runtime versions

NIM100285 Documentation Enhancement Request: additional information and code snippets for the ClassBreak class in the ArcGIS Android API
NIM102854 Some graphics are missing when calling MapView.getDrawingMapCache()
BUG-000083273 A file geodatabase is corrupted in HTC One
BUG-000089913 The GeometryEngine.Intersect Method returns an empty polyline instead of the required output created through the operation. The method GeometryEngine.intersections is now available that allows for dimensionality.
BUG-000093433 Adding a z-value point to a z-value enabled feature service results in a table exception, which the shape must not have a Z value
ENH-000103980 No method or classes exist that allow initializing credential objects with a token or setting a token for a secure resource in the Android Runtime 100.x SDK

Known issues

Maps, layers, and general

MapViewlocationToScreen gives incorrect coordinates in wrap around mode.
Map view grid lines that lie close to the 180th meridian or poles may not always display correctly.
AutoPanMode and InitialZoomScale are ignored if set before starting location display.
PKI secured service throws SocketException instead of returning 403.
Querying FeatureTable does not complete if the table failed to load.
Cloning an unloaded map prevents it from rendering in a map view. Load the map before cloning it.
Text in vector tiled layers may not display at certain scales.
Vector tiled layers created from a URL don't have attribution.
Crash may occur on Android when zooming and panning with vector tiled layers.
Once a vector tile layer is cloned, there is no way to handle requests for it.
Related tables: When an origin feature is deleted, the key field of the related feature is not set to null for hosted services that have a non-unique primary key.
Web maps saved from an ArcGIS Runtime app containing Bing Maps layers may not be compatible with older versions of the Web Viewer.
ArcGIS Online currently does not support requesting features from feature services in a different spatial reference using the latest WKID value stored in a map.
SpatialReference.equals() may return false when comparing Web Mercator spatial references.
When exporting a tile package from a service that is hosted in ArcGIS Online (tiles.arcgis.com) with a geometry that is not in the same spatial reference as the service, the tile package will be corrupted and will not display correctly.
ArcGISSceneLayer does not support legends.
GeoView.getLayerViewState fails for a layer that has not finished rendering.
Using SketchEditor, you cannot digitize a polyline across the dateline.
Memory is not freed when graphics symbolized with picture marker symbols are cleared from a graphics overlay.
A Bing Maps layer created with a Portal needs to load the Portal first.
Definition expressions using time fields on spatial service feature tables will result in no features being displayed.
Cannot change definition expression after setting invalid definition expression on feature layer in a SceneView.
Feature layers with indexes on GlobalID fields may cause an app to crash.
Loading feature layers that have fill symbols with an outline with of less than 0 will return an exception.
Diagonal fill symbols render in opposite directions between JavaScript and Runtime.
Moving map view to a screen with a different DPI zooms the map in and out (5-10%).
Moving map view to a screen with a different DPI changes the size of the map content.
Symbol sizes for graphics in static mode differ in size between 2D and 3D views.
Vector tile symbols don't always scale consistently with DPI.
Map view doesn't zoom to geometry if the supplied geometry's envelope has zero height or width.
Setting minimum scale on a graphics overlay in a scene view is not accurate.
Calling the clone method on a loaded feature layer throws bad_weak_ptr exception.
Gradient fills used in mobile map package are not displayed correctly in apps.
Invalid base layer, reference layer, or operational layer will not raise LayerViewStateChangedEvent under certain scenarios.
In some cases, a feature layer can have a load status of Loaded but getRenderer still returns null.
Service feature table contents do not re-populate after clearing cache.
Service feature table can fail to load from a service with "Invalid JSON" error when the real problem is the JSON from the service contains an unsupported image format.
There's an inconsistency in handling null values in JsonSerializable UnknownJson.
Popup title does not use name when the title is defined with a coded value domain field.
Popup.GeoElement.Attributes uses label/alias values instead of field names as keys for the attribute dictionary when used with ArcGIS map services.
Field name in popup definition for Arcade expression does not include the title for the expression field.
Popup getSymbol returns null for features from a map service.
A geodatabase is taken out of scope even if its feature tables are in scope. This is because the geodatabase holds on to strong references to its tables, but the tables do not have a strong reference back to the geodatabase (as this would lead to a circular reference). This is by design. It's recommended to keep the geodatabase as a global variable.
Editing overrides for a feature layer in a web map are not honored.
Synchronizing large geodatabases with many features and no local edits may take longer than expected.
Offline features disappear intermittently during map interaction when syncing large geodatabase.
When registering a mobile geodatabase with a new user (different from user who created the mobile geodatabase), local edits still apply the user who created the geodatabase when editor tracking is enabled.
When using local street address locators, suggestion results without a house number can't be used to retrieve results.
Locator performance may be poor for larger local locator datasets.
Saving map with ForceSave false and feature collection layers by reference throws exception. Workaround: ForceSave the map and while loading the saved map set the visibility of FeatureLayer referenced by FeatureCollectionTable to true.
Functions are not supported in where clauses for labeling.
GeoprocessingJob.ToJson throws exception when it contains input parameter type of GeoprocessingFeatures with null features.
GeoprocessingJob.FromJson does not populate GeoprocessingFeatures.URL.

Raster

Adding rasters to MosaicDatasetRaster with some invalid parameters can fail without notifying the user.
Some 3D renderers on some platforms may not work correctly on MosaicRasterDataset.
In some cases, the default rendering applied to raster data may appear different from how it appears in ArcGIS Online.
The LoadStatusChanged event doesn't fire when using a MosaicDatasetRaster instance to create a mosaic dataset and binding it to a RasterLayer for rendering.
When adding rasters to a mosaic dataset that is already being used for a raster layer, the new content will not show up in that existing layer.
Raster layers report LayerViewState.Error ("Layer does not have SpatialReference") while loading. The layer will then transition to LayerViewState.Active after self-correcting and loading the layer.
RasterLayer doesn't free a used raster before the application is shut down.

Image services

When an ImageServiceRaster is created with a URL, getPath should return null but instead it returns the URL.
Setting a color map raster function as rendering rule on an image service has no effect.
Visual artifacts can appear on a map when the default rendering rule of an image service has dynamic range adjustment (DRA) enabled.
Setting a rendering rule on ImageServiceRaster after loading has no effect.
App may crash when exporting tile cache from image service that does not support it.

Symbols, renderers and graphics

TextSymbol doesn't honor the screen alignment property for feature layers.
Kerning does not work with simple Latin scripts, causing a performance problem with military symbol text.
PictureFillSymbol width, height, and image properties are not working correctly on scene view.
When kerning is enabled on a statically-rendered TextSymbol, it will appear misaligned and may render beyond the extent of its background.
In a scene view, changing TextSymbol font weight or style does not affect the symbol as expected. The glyph spacing changes, but the glyphs themselves remain the same.
In a scene view, changing TextSymbol halo color or size has no effect when symbolizing elements displayed in dynamic mode.
In a graphics overlay displayed using dynamic mode in a scene view, applying a font decoration to TextSymbol has no effect.
Crash when drawingInfo uses field alias name instead of field name when using advanced symbology.
Feature layers from federated 10.3 and 10.3.1 ArcGIS Servers cannot use the default advanced symbology setting.
When a specific offset value is applied to both dynamic and static picture marker symbols, the displacement is different on both the graphics.
In static rendering mode, setting Y offset on TextSymbol causes the symbol to render twice, once at the old and once at the new location.
When invoking toJson on LabelDefinition, certain text symbols may get serialized as "", losing their properties.
Symbols should be loaded before being used in a renderer sent to a service.
Random tile flickering may occur when adding polygons to a graphic overlay with horizontal fill symbol and transparent color, in static rendering mode.
TextSymbol for a polygon graphic spanning the dateline and rendered in Static mode is displayed in the wrong location when zooming out.
TextSymbol HaloColor and HaloSize properties have no effect when used with graphics in dynamic mode in a SceneView.
Military polyline and polygon symbols that render correctly in 2D do not render correctly in a graphics overlay in dynamic mode in 3D.
Some military line symbols do not display in the correct location.
Symbol rotation type (arithmetic/geographic) is ignored by graphics.
Creating a swatch returns a null image for scene symbols.
Extruded graphics in a scene view may disappear while navigating the map.
Selection halo thickness for various types of graphics are not consistently sized.
Selection color does not display for a selected polygon with a transparent outline in a dynamic graphics overlay in a SceneView.
Graphics overlays drawn in static mode do not render correctly. Use graphics overlays in dynamic mode.
A service feature table will not render when unique value renderer contains classification values with commas.

Portal

New TypeKeywords and Tags objects are created when a PortalItem is loaded, rather than repopulating the existing objects.

Feature collections

A feature collection in a web map that doesn't have a spatial reference for its extent will not draw.
FeatureCollection.toJSON loses popup info properties.
Creating FeatureCollectionTable from FeatureQueryResult can throw an exception.
When creating a feature collection from an array of graphics, the graphics' symbols are not honored. Instead, the default symbol is used.
Very large feature collections may cause an app to run out of memory and crash.

Web maps

Web maps with dynamic layers produced by ArcGIS Runtime do not draw correctly in ArcGIS Pro. Any overridden properties (renderer, labeling, opacity, sublayer visibility, and so on) will revert to service-specified defaults.
Labeling behavior and display in a web map may not match between JavaScript and Runtime.

3D

Files added to an existing raster elevation source at runtime are not applied to the scene view.
Elevation of vertices of a 3D polyline drawn high above the surface, viewed in relative mode, can dip when the tile beneath it is out of view and therefore unloaded.
SceneView.screenToLocationAsync can return inaccurate Z values.
The rotation property of a viewpoint is not applied when it is used to set a viewpoint for another view.
The color of a ModelMarkerSymbol can't be changed.
Models in a SceneView may render black on Android simulators.
Z-aware feature layers do not render correctly in scene view.
When using a scene layer package with a terrain, it can be seen through terrain.
Scene layer may not display due to limited device memory.
Alpha property incorrectly applied during image export of a SceneView.
Labels for feature layers do not display on scene view.
An application might fail when using military symbology layers in a graphics overlay with a scene. This does not happen with military feature layers.
Setting minimum scale on a graphics overlay in a scene view may not always be accurate.
Set viewpoint with NAN scale value causes globe in SceneView to render black.
Edges of polyline may appear behind globe in SceneView.
A selection highlight doesn't work when two graphics overlap.
screenToLocationAsync sometimes gives unexpected elevations when zoomed out.
In a scene view, changing the identify tolerance for graphics overlay behaves as though a zero tolerance is set.
Graphics overlay selection halo does not appear around selected symbols that are fully transparent.
The thickness of the selection halo varies between different symbol types.
For both compact and exploded caches in Web Mercator, an error occurs reading the cache configuration.
Rendering graphics in static mode near the poles or at varying distances from a camera may display unexpected results.
Camera from CurrentViewpoint on SceneView always returns null.
Multiple touch points for scene interactions, except for zoom, have not been implemented yet.
Layer refresh interval does not work in 3D scenes.
When rotating down on a scene view, the rotation stops when the clicked point is at 0,0.
For a Scene (3D), WGS 1984 is the only supported spatial reference.
App can crash when no symbol is set on a extrusion renderer.
Portions of building models may become transparent when panning the 3D scene.
Models in a SceneView may render black on iPhone 5 devices.
Identify operation can return empty results for ArcGISSceneLayer.
Graphics that not visible can be identified in a SceneView.
Unable to identify a partially-transparent symbol for a graphic in a dynamic graphics overlay in a SceneView.
Visibility of a graphic in a SceneView is determined by geometry, not display location.
Scene layer transparent pixels are not rendering correctly on Android platforms.
Transparent simple marker graphics on a 3D scene view do not correctly display all symbols that are directly behind them.
A 3D scene may exhibit significant flickering while adding a new feature.
Selected features may flicker in a scene view.
Scene layer packages are sometimes visible through the terrain.
3D vertical extrusion is applied to a graphic's symbol when it should only be applied to the renderer's symbol.
Rendering of dynamic graphics in a SceneView is fragmented in iOS simulator.
A crash can occur when destroying SceneView on Android if pause/resume are not called.

Miscellaneous

When a self signed certificate is trusted it is always cached and is not cleared.
Multiple Authentication Challenges may be fired for concurrent requests.
MapView.setViewpointGeometryAsync(Geometry, int padding) ignores padding and doesn't zoom to geometry for horizontal lines.
A cached portal credential may not be used to access a second portal.
Authentication challenge issued when accessing a certificate secured portal under some workflows.
The map extent saved to a portal may not be accurate under some circumstances.
Basemap created by Basemap.copy() doesn't display.
Map save methods need to load map implicitly if not yet loaded.
UnsupportedOperationException thrown when calling ArcGISMapServiceInfo.getDocumentInfo().getTextAntiAliasingMode().
Upper case characters in OAuth Redirect URIs will not work.
TextSymbol does not honor SCREEN alignment property for feature layers.
Sync fails with ArcGIS Server 10.3 feature services that have realm applied.
SceneView crashes on some older devices (e.g. Asus Transformer Pad TF300T, Nexus 7 2012 version, Galaxy Note 10.1)
Default challenge handler prompts again after un-checking Remember and clicking BLOCK in the Untrusted Host dialog.
Sketch Editor fails to start sketching (NullPointer) if map changed with same SR since SR changed listener was not fired. Make sure the map is done loading before calling start on the sketch editor.
Map save methods need to load map implicitly if not yet loaded.
When a self signed certificate is trusted it is always cached and is not cleared.
Portal user is not set after logging into a PKI portal.
Multiple Authentication Challenges may be fired for concurrent requests.
PKI portal with both client and server certificate fails to load, throws ArrayStoreException. The workaround is to use client certificate only in the keystore.
Camera.zoomToward with factors of 0 or less cause Camera failure.
After connecting to a portal, you may get challenged again when accessing a federated service.
In a SceneView the selected graphic always renderers on top.
Popup title does not use name when defined with a coded value domain field.
When creating a feature collection from an array of graphics, the graphics' symbols are not honored.
Capabilities overridden in web map are not honored.
Applying a label definition to an ArcGISMapImageSublayer doesn't work.
Using MapView.identifyLayersAsync(...).get() hangs. It works if using a done listener instead.
Some PopupAttachment file name extensions will get changed after upload.
LocationDisplay symbol may change between navigation and default location symbols while mode remains Navigation Mode if velocity of location update is 0.
MapView.getLocationDisplay() may block thread for several seconds.
NavigationChangedEvent fires multiple times when panning + flick, and will return false for isNavigating even if the map is still moving.
exportImageAsync() fails to create a valid image on some devices (e.g. Nexus 7)
PopupManager.isShowAttachments returns incorrect value for features from a map service.
PopupManager.getFormattedValue() returns null/empty for identify popups from map services 10.4 or earlier.
Vector tiled layer using static basemap constructors not loading on some older devices (e.g. Nexus S and ASUS TF300T) due to ssl issue.
GL context creation is problematic on some devices (e.g. Nexus 7 (2012) and ASUS fonepad 7).