sourceSettings property

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 ArcGISMapViewController. To use rule-based snapping, call SnapSettings.syncSourceSettings(SnapRules, SnapSourceEnablingBehavior) instead.

SnapSettings is connected to an ArcGISMapViewController via GeometryEditor.snapSettings, and ArcGISMapViewController.geometryEditor. If there is no connected ArcGISMapViewController, 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 GeoModel.operationalLayers and GeoViewController.graphicsOverlays collections, with objects from GeoModel.operationalLayers appearing first, followed by GeoViewController.graphicsOverlays objects, in order.

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

After synchronization, the collection will not contain a SnapSourceSettings for any loadable SnapSource which is not yet 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.