Snap
Configures a valid source of geometries that the GeometryEditor can snap interactive edits to. Following a call to SnapSettings.syncSourceSettings or SnapSettings.syncSourceSettings, the SnapSettings.sourceSettings collection is populated with SnapSourceSettings objects that are valid for snapping. Each represents a SnapSource that is in the currently connected map and provides full resolution geometries suitable for snapping.
com.arcgismaps.mapping.layers.FeatureLayer, com.arcgismaps.mapping.view.GraphicsOverlay, com.arcgismaps.mapping.layers.SubtypeFeatureLayer, and com.arcgismaps.mapping.layers.SubtypeSublayer objects are types of snap source. For com.arcgismaps.mapping.layers.SubtypeFeatureLayer snap sources, the SnapSourceSettings.childSourceSettings collection is populated with com.arcgismaps.mapping.layers.SubtypeSublayer snap sources.
Set SnapSourceSettings.isEnabled to true for each item that you want allow your users to snap to. You may wish to delegate the choice of snapping sources to users by binding the collection of snapping sources to controls which allow them to change SnapSourceSettings.isEnabled for each snapping source individually. When rule-based snapping is configured, interactive snapping behavior is affected by the SnapRules used in SnapSettings.syncSourceSettings. See SnapRules and SnapSourceSettings.ruleBehavior for more information.
Snapping works for visible objects within a visible SnapSource - for example if a feature layer or graphics overlay is not visible due to the current scale range, definition expression, or other reason, it will not participate in snapping at that time. Visibility does not affect whether a SnapSourceSettings object is present in the SnapSettings.sourceSettings collection or not.
See SnapSource for more information about which data sources are valid for snapping.
Since
200.4.0
See also
Properties
A collection of SnapSourceSettings objects representing the child snap sources of SnapSourceSettings.source, when the snap source is a com.arcgismaps.mapping.layers.SubtypeFeatureLayer. When this snap source is a com.arcgismaps.mapping.layers.SubtypeFeatureLayer, this collection contains a SnapSourceSettings object corresponding to each com.arcgismaps.mapping.layers.SubtypeSublayer of that layer, in the same order as the com.arcgismaps.mapping.layers.SubtypeFeatureLayer.subtypeSublayers collection.
True to enable snapping to the geometries in the SnapSource, false otherwise. Default is false. Snapping sources can be enabled or disabled individually. If SnapSettings.isEnabled or SnapSettings.isFeatureSnappingEnabled are false, this value is ignored and interactive snapping is not enabled to this SnapSource.
Describes how SnapRules affect the interactive snapping behavior of this SnapSourceSettings. This value indicates how interactive snapping behavior is affected by SnapRules, which may allow, limit, or prevent snapping to this SnapSourceSettings. Rule-based snapping is configured by calling SnapSettings.syncSourceSettings - see SnapRules for more information about configuring a GeometryEditor with rule-based snapping.
Underlying source of geometries to snap to, for example a com.arcgismaps.mapping.layers.FeatureLayer, com.arcgismaps.mapping.layers.SubtypeFeatureLayer, com.arcgismaps.mapping.layers.SubtypeSublayer, or com.arcgismaps.mapping.view.GraphicsOverlay.