SnapSourceSettings class final

Configures a valid source of geometries that the GeometryEditor can snap interactive edits to.

Following a call to SnapSettings.syncSourceSettings or SnapSettings.syncSourceSettings(SnapRules, SnapSourceEnablingBehavior), 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.

FeatureLayer, GraphicsOverlay, SubtypeFeatureLayer, and SubtypeSublayer objects are types of snap source. For SubtypeFeatureLayer snap sources, the SnapSourceSettings.childSourceSettings collection is populated with 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(SnapRules, SnapSourceEnablingBehavior). 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.