sourceSettings

Defines the collection of snapping sources and whether or not each is enabled for snapping. Call SnapSettings.syncSourceSettings to populate this collection with a SnapSourceSettings for each valid SnapSource present in the connected com.arcgismaps.mapping.view.MapView. To use rule-based snapping, call SnapSettings.syncSourceSettings instead.

SnapSettings is connected to a com.arcgismaps.mapping.view.MapView via GeometryEditor.snapSettings, and com.arcgismaps.mapping.view.MapView.geometryEditor. If there is no connected com.arcgismaps.mapping.view.MapView, or the map view and the associated map contains no valid SnapSource objects, then the collection will be empty after the synchronization call returns.

The order of SnapSourceSettings objects will match the order that the associated SnapSource objects appear in the com.arcgismaps.mapping.ArcGISMap.operationalLayers and com.arcgismaps.mapping.view.MapView.graphicsOverlays collections, with objects from com.arcgismaps.mapping.ArcGISMap.operationalLayers appearing first, followed by com.arcgismaps.mapping.view.MapView.graphicsOverlays objects, in order.

For SnapSourceSettings objects that correspond to a com.arcgismaps.mapping.layers.SubtypeFeatureLayer, SnapSourceSettings.childSourceSettings returns a collection of separate SnapSourceSettings objects representing each com.arcgismaps.mapping.layers.SubtypeSublayer.

After synchronization, the collection will not contain a SnapSourceSettings for any loadable SnapSource which is not yet com.arcgismaps.LoadStatus.Loaded.

As snapping is used to maintain data integrity between different sources of data, only SnapSource objects that provide full resolution geometries as considered valid for creating a SnapSourceSettings object - see SnapSource for more information.