JavaScript ArcGIS SnappingOptions用法及代码示例

AMD: require(["esri/views/interactive/snapping/SnappingOptions"], (SnappingOptions) => { /* code goes here */ });

ESM: import SnappingOptions from "@arcgis/core/views/interactive/snapping/SnappingOptions";

类： esri/views/interactive/snapping/SnappingOptions

继承: SnappingOptions > Accessor

自从：用于 JavaScript 4.19 的 ArcGIS API

SnappingOptions 允许用户在 Sketch 和 Editor 小部件中为他们的编辑或绘图体验配置捕捉。

捕捉选项提供了指定应用程序是使用自捕捉、特征捕捉还是两者兼有的能力。两者都在下面说明。

也可以通过按住CTRL 键来切换捕捉。这将打开/关闭捕捉。

自捕捉(几何参考线)

自捕捉是通过 selfEnabled 属性设置的。这意味着，当用户主动创建或更新要素或图形时，除了有助于捕捉现有要素的延伸的可视化之外，他们还将看到有助于识别垂直线和平行线的可视化。下面简要演示了 2D 应用程序中的自捕捉是什么样子的。尽管这是针对 2D 显示的，但相同的前提也适用于 3D。

特征捕捉

函数捕捉是通过 featureEnabled 属性设置的。它提供了将当前正在绘制或重塑的图形或特征的顶点捕捉到现有特征的顶点、边或端点的能力。这些现有要素属于 Map 内的图层，并且必须在 featureSources 属性中指定。以下两个图像演示了 2D 应用程序中的特征捕捉。与自捕捉类似，相同的前提也适用于 3D。

上面显示了在创建新特征时特征捕捉到现有特征的顶点端点和边。底部演示了获取现有特征并重新调整其几何形状以捕捉到另一个特征的顶点。

名字	细节	3D 示例	二维示例
Rectangle	捕捉彼此垂直的线
Parallel	捕捉到所有平行线
Extension	捕捉到当前形状的扩展
顶点(如更新几何时所见)	将顶点捕捉到现有顶点

// Create a new instance of Sketch, and set
// a layer for one of the featureSources property.
// This enables feature snapping on that layer.
const sketch = new Sketch({
  layer: graphicsLayer,
  view: view,
  snappingOptions: { // autocasts to SnappingOptions()
    enabled: true, // global snapping is turned on
    // assigns a collection of FeatureSnappingLayerSource() and enables feature snapping on this layer
    featureSources: [{ layer: graphicsLayer, enabled: true }]
  }
});