Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: SnappingManager
[ AMD Module Require | Legacy Module Require ]
require(["esri/SnappingManager"], function(SnappingManager) { /* code goes here */ });
Description
(Added at v2.3)
The SnappingManager is used to add snapping capability to the Editor, Measurement Widget, Draw toolbar and Edit toolbar.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new SnappingManager(options?) | Create a new SnappingManager object. |
Methods
| Name | Return type | Summary |
|---|---|---|
| destroy() | None | Destroy the SnappingManager object. |
| getSnappingPoint(screenPoint) | Deferred | Returns a deferred object, which can be added to a callback to find the snap point. |
| setLayerInfos(layerInfos) | None | An array of layerInfo objects used to specify the target snapping layers. |
Constructor Details
Create a new SnappingManager object. It is not required to create a SnappingManager object to enable snapping for the Editor, Measurement or Draw and Edit Toolbars. To enable snapping, call the map's
enableSnapping method. Create a new snapping manager object if the default options need to be modified.Parameters:
< |
Optional | Optional parameters. See options list. |
options properties: < |
Optional | When true, snapping is always enabled. When false users press the snapKey to enable snapping. Default value is false. |
< |
Optional | See the object specifications table below for the structure of the layerInfos object. |
< |
Required | Reference to the map. Required parameter. |
<dojo/keys> snapKey |
Optional | When alwaysSnap is set to false use this option to define the key users press to enable snapping. The default value is the dojo.copyKey. The dojo.copyKey is a virtual key that maps to CTRL on Windows and the Command key on mac. |
< |
Optional | Define a symbol for the snapping location. The default symbol is a simple marker symbol with the following properties: size:15px, color:cyan, style:STYLE_CROSS. |
< |
Optional | Specify the radius of the snapping circle in pixels. The default value is 15 pixels. |
Object Specifications:
<
layerInfo>< |
Required | Reference to a feature or graphics layer that will be a target snapping layer. The default option is to set all feature and graphics layers in the map to be target snapping layers. |
< |
Required | Default is true. When true snapping to edges will be enabled for layers with polyline or polygon geometry. |
< |
Required | Default is true. When true snapping to points will be enabled for layers with point geometry. |
< |
Required | Default is true. When true snapping to vertices will be enabled for layers with polyline or polygon geometry. |
Method Details
Destroy the SnappingManager object. All related objects will be set to null.
Sample:
snappingManager.destroy();
Returns a deferred object, which can be added to a callback to find the snap point.
Return type:
DeferredParameters:
< |
Required | The input screen point for which to find the snapping location. |
Sample:
var deferred = snappingManager.getSnappingPoint(evt.screenPoint);
deferred.then(function(value){
if(value !== undefined){
var snapPoint = value;
}
},
function(error){
console.log('failure');
});
An array of layerInfo objects used to specify the target snapping layers.
Parameters:
< |
Required | An array of layerInfo objects that define the snapping target layers. All values are optional. If no snapping options are set the default values will be used. See the object specifications table below for the structure of the layerInfos object. |
Object Specifications:
<
layerInfo>< |
Required | Reference to a feature or graphics layer that will be a target snapping layer. The default option is to set all feature and graphics layers in the map to be target snapping layers. |
< |
Required | Default is true. When true snapping to edges will be enabled for layers with polyline or polygon geometry. |
< |
Required | Default is true. When true snapping to points will be enabled for layers with point geometry. |
< |
Required | Default is true. When true snapping to vertices will be enabled for layers with polyline or polygon geometry. |
Sample:
var layerInfos = [
{layer:results[0].layer}
];
snappingManager.setLayerInfos(layerInfos);