SketchViewModel

概览

提供 Sketch 微件的逻辑。SketchViewModel 旨在与图形一起使用，并且需要在其 layer 属性中指定 GraphicsLayer。Sketch 微件通过用户界面 (UI) 提供开箱即用的功能。因此，Sketch 微件允许用户不必担心设计和创建自己的 UI。另一方面，SketchViewModel 是 Sketch 微件 UI 背后的逻辑，允许在应用程序中使用此类的用户为绘制工具设计自己的自定义 UI。

例如，使用 FeatureFilter 过滤 SceneLayer 示例演示了将 SketchViewModel 与自定义 UI 结合使用的示例。

此外，用户可以选择哪些绘制工具与其应用程序相关。在此示例中，仅使用 point、polyline 和 polygon 工具。

下表描述了用于创建具有不同几何的指针和键盘手势。

创建点图形

手势	操作
左键单击	在指针位置处添加点图形。
Enter	在指针位置处添加点图形。

创建折线和面图形

创建折线和面图形时，将应用以下键盘快捷键。

手势	操作	示例
左键单击	在指针位置处添加折点。
向左拖动	在 hybrid 或 freehand 模式下为每个指针移动添加折点。
F	将折点添加至 polyline 或 polygon 图形。在 click 模式下完成 rectangle 或 circle 面图形。
Enter	在没有分段折点的情况下，完成 polyline 或 polygon 图形。double-click 将在当前光标的位置处完成图形。
Z	逐步撤消堆栈中记录的操作。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。
R	逐步恢复堆栈中记录的操作。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。
Ctrl	根据 snappingOptions 中的配置切换捕捉。
Spacebar+Left-drag	在创建折线或面图形时平移视图。
在第一个折点上左击	完成面图形草绘。

使用预定义形状创建面图形

以下键盘快捷键适用于创建具有预定义形状 (rectangle 和 circle) 的面图形。

手势	操作	示例
左键单击+拖动	基于初始单击点和光标位置之间的边界框使用尺寸创建 rectangle 图形。根据初始单击点和光标位置之间的距离使用半径创建 circle 图形。
Shift+左键单击+拖动	将形状从 rectangle 更改为 square 或从 circle 更改为 ellipse。
Alt+左键单击+拖动	创建一个 rectangle 图形，其中心位于初始单击处，尺寸基于初始单击点到光标位置之间的距离。基于初始单击点和光标位置之间的边界框使用半径创建 circle 图形。
Shift+Alt+左键单击+拖动	综合上述行为。

更新图形

Sketch 微件为用户提供了在更新操作期间移动、旋转、缩放或修整图形的功能。要开始更新，请在图形上 Left-click。使用 Shift+Left-click 以向所选内容添加更多图形，以进行批量更新。选择图形后，可以执行以下操作。

手势	操作	示例
在图形上左键单击	选择要移动、旋转或缩放的图形。
Shift+左键单击图形	选择多个图形以移动、旋转或缩放。
拖动图形	移动所选图形。
拖动旋转手柄	旋转所选图形。
拖动缩放手柄	缩放所选图形。
Shift+左键单击+拖动缩放手柄	在中心缩放所选图形。
Z	逐步撤消堆栈中记录的操作。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。
R	逐步恢复堆栈中记录的操作。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。
在视图上左键单击 (不是图形)	完成图形更新。
按 Delete 键	从图层中移除所选图形。

可以对单个折线或面图形执行以下更新操作：

手势	操作	示例
在图形上左键单击	选择要移动或修整的图形。
拖动图形	移动所选图形。
在重影折点上左键单击	添加新折点。
在折点上左键单击	选择折点。
在折点上执行 Shift+左键单击	选择或取消选择多个折点。
拖动折点	移动选定折点。
在折点上右键单击	删除折点。
选择多个折点，然后按 Backspace 或 Delete 键	删除多个折点。

如果图形使用 3D 对象符号图层，则可以对 SceneView 中具有点几何的单个图形执行以下更新操作：

手势	操作	示例
在图形上左键单击	选择要移动、旋转或缩放的图形。
拖动内部手柄	移动所选图形。
拖动高度手柄	垂直移动所选图形 (在 z 轴上)。
侧向拖动外部手柄	旋转所选图形。
向内或向外拖动外部手柄	缩放所选图形。

覆盖符号系统

SketchViewModel 还允许用户覆盖 polyline、polygon、point 和 multipoint 图形的默认符号。以下代码片段演示了使用 TextSymbols 覆盖默认点图形符号的示例。

// Create a text symbol for drawing the point
const textKeySymbol = {
  type: "text", // autocasts as new TextSymbol()
  color: "#7A003C",
  text: "\ue656", // geoscene-icon-key
  font: {
    // autocasts as new Font()
    size: 20,
    family: "CalciteWebCoreIcons"
  }
};

const sketchViewModel = new SketchViewModel({
  view: view,
  layer: graphicsLayer,
  pointSymbol: textKeySymbol
});

以上示例使用 CalciteWebCoreIcons 字体，用键图标替代点图形的默认符号。

现在还可以在使用 pointSymbol、polylineSymbol 和 polygonSymbol 主动创建新图形时覆盖默认绘制符号。在早期版本中，设置这些属性仅会在完成绘制操作后覆盖图形符号。activeFillSymbol 属性允许用户覆盖默认绘制符号，以匹配最终的 polygonSymbol。这是为了使用户在主动绘制时能够看到最终图形符号的外观。现在，通过设置 pointSymbol、polylineSymbol 和 polygonSymbol，用户可以查看最终图形符号的外观，同时仍可主动绘制图形。下图演示了设置 polygonSymbol 时的行为。

以下是上述示例中使用的代码段。

const polygonSymbol = {
  type: "simple-fill", // autocasts as new SimpleFillSymbol()
  color: "#F2BC94",
  outline: {
    // autocasts as new SimpleLineSymbol()
    color: "#722620",
    width: 3
  }
};

const sketchViewModel = new SketchViewModel({
  view: view,
  layer: graphicsLayer,
  polygonSymbol: polygonSymbol,
});

草绘 3D

为了能够使用高度手柄操作 z 轴上的要素，以下配置是相关的：

• GraphicsLayer 的 高程信息模式需要设置为 absolute-height、relative-to-scene 或 relative-to-ground。
• 要创建具有 z 值的图形，hasZ 需要在 defaultCreateOptions 或 createOptions 中为 true。
• 要更新图形的 z 值，enableZ 需要在 defaultUpdateOptions 或 updateOptions 中为 true。

// define the GraphicsLayer
const gLayer = new GraphicsLayer({
  elevationInfo: {
    mode: "absolute-height" // default value
  }
});

// define the SketchViewModel
const sketchVM = new SketchViewModel({
  layer: gLayer,
  view: view,
  defaultCreateOptions: {
    hasZ: true  // default value
  },
  defaultUpdateOptions: {
    enableZ: true  // default value
  }
});

在 absolute-height 模式下，草绘的折点与场景元素 (要素和地面) 对齐。在 absolute-height 模式下，草绘的 polygon 是平面的，这意味着所有 polygon 折点都使用第一个折点的高度。有关如何将 z 值用于不同高程模式的详细信息，请参阅高程信息。

已知限制

只能在 MapView 中创建多点几何。

另请参阅

• Sketch

• 示例 - 草绘临时几何

• 示例 - 草绘更新验证

• 示例 - 按几何查询统计数据

• 示例 - 使用 FeatureFilter 过滤 SceneLayer

• 编程模式：微件 viewModel 模式

示例

// Create a new SketchViewModel and set its required parameters
let sketchVM = new SketchViewModel({
  layer: tempGraphicsLayer,
  view: view
});

// Listen to sketchViewModel's create event.
sketchVM.on("create", function(event) {
  // check if the create event's state has changed to complete indicating
  // the graphic create operation is completed.
  if (event.state === "complete") {
    // remove the graphic from the layer. Sketch adds
    // the completed graphic to the layer by default.
    polygonGraphicsLayer.remove(event.graphic);

    // use the graphic.geometry to query features that intersect it
    selectFeatures(event.graphic.geometry);
  }
});

构造函数

new SketchViewModel(properties)

参数

properties Object optional 有关可能传递给构造函数的所有属性的列表，请参见属性。

示例

// Typical usage
let sketch = new SketchViewModel({
  view: view,
  layer: graphicsLayer
});

属性概述

属性详细信息

activeFillSymbol SimpleFillSymbol

起始版本：GeoScene Maps SDK for JavaScript 4.20

使用 polygon 工具主动创建新 polygon 图形时显示的 SimpleFillSymbol。仅在 2D MapView 中受支持。

默认值如下：

{
  type: "simple-fill",
  style: "solid",
  color: [150, 150, 150, 0.2],
  outline: {
    color: [50, 50, 50],
    width: 0
  }
}

activeTool Stringreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.10

创建新图形时 (例如，在调用 create() 之后)，此属性反映正在使用的创建工具。更新图形时 (例如，在调用 update() 之后)，此属性反映正在使用的更新工具。如果未进行创建或更新操作，则为 null。

可能值："point"|"multipoint"|"polyline"|"polygon"|"circle"|"mesh"|"rectangle"|"move"|"transform"|"reshape"

createGraphic Graphicreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.10

正在创建的图形。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

类的名称。声明的类名称格式化为 geoscene.folder.className。

defaultCreateOptions Object

起始版本：GeoScene Maps SDK for JavaScript 4.14

为 SketchViewModel 设置的默认创建选项。

属性

mode String optional 创建如何创建图形的操作模式。 值 描述 hybrid 在单击或拖动指针时添加折点。适用于 polygon 和 polyline。 freehand 在拖动指针时添加折点。适用于 polygon、polyline rectangle 和 circle。默认为 rectangle 和 circle。 click 单击指针时会添加折点。适用于 polygon、polyline rectangle 和 circle。默认为 polygon 和 polyline。 可能值："hybrid"|"freehand"|"click"

hasZ Boolean optional 控制创建的几何是否具有 z 值。

defaultZ Number optional 新创建的几何的默认 z 值。当 hasZ 为 false，或图层的高程模式设置为 absolute-height 时，将忽略此选项。

defaultUpdateOptions Object

起始版本：GeoScene Maps SDK for JavaScript 4.10

为 SketchViewModel 设置的默认更新选项。此属性上设置的更新选项将被传递给 update() 方法的选项所覆盖。

属性

tool String optional 更新工具的名称。对于具有面和折线几何的图形，默认工具为 transform；对于具有点和多点几何的图形，默认工具为 move。但是，如果具有点几何的图形使用 3D 对象符号图层，则默认工具为 transform。 可能值："move"|"transform"|"reshape"

enableRotation Boolean optional 默认值：true 指示在更新图形时是否启用了 rotation 操作。仅当 tool 为 transform 时才适用。

enableScaling Boolean optional 默认值：true 指示在更新图形时是否启用了 scale 操作。仅当 tool 为 transform 时才适用。

enableZ Boolean optional 默认值：true 指示在更新图形时是否可以修改 z 值。启用后，将显示高度手柄操纵器。

multipleSelectionEnabled Boolean optional 默认值：true 指示是否可以一次进行多个选择。这适用于 shift+单击与 transform 工具的交互。

preserveAspectRatio Boolean optional 默认值：false 指示在更新图形时是否启用了统一比例操作。将此属性设置为 true 时，enableScaling 必须设置为 true。仅当 tool 为 transform，且在变换使用 3D 对象符号图层的点时始终为 true 时适用。

toggleToolOnClick Boolean optional 默认值：true 指示是否可以在 transform 和 reshape 更新选项之间切换要更新的图形。

reshapeOptions Object optional 更改 reshape 工具的行为。定义用于移动形状和/或折点的边和/或约束操作。仅在 3D 中受支持。 规范 edgeOperation String optional 默认值："split" 设置边的修整操作。这会影响线和面。完全支持 3D，部分支持 2D。 值 描述 none 边上没有显示操纵器。(2D 和 3D) split 操纵器通过添加新折点来显示分割边。(2D 和 3D) offset 显示操纵器以偏移边。(仅 3D) 可能值："none"|"split"|"offset" shapeOperation String optional 默认值："move" 设置整个形状的移动约束。支持 2D 和 3D 值 描述 none 未显示移动操纵器。(2D 和 3D) move 移动操纵器显示以在 xy 和 z 中移动。(2D 和 3D) move-xy 移动操纵器显示仅在 xy 中移动。(仅 3D) 可能值："none"|"move"|"move-xy" vertexOperation String optional 默认值："move" 设置折点的移动约束。仅在 3D 中受支持。 值 描述 move 移动操纵器显示以在 xy 和 z 中移动。 move-xy 移动操纵器显示仅在 xy 中移动。 可能值："move"|"move-xy"

highlightOptions Object optional 用于控制何时显示或隐藏更新操作的突出显示的选项。 规范 enabled Boolean optional 默认值：true 指示是否为更新操作启用了突出显示。仅在 2D 中受支持。

示例

// Turn off highlights for update operations
const svm = new SketchViewModel({
 view,
 defaultUpdateOptions: {
   highlightOptions: {
     enabled: false
   }
 }
});
// Turn off highlights from the update() method
const updateOptions = { tool: "reshape", highlightOptions: { enabled: false }};
svm.update(graphic, updateOptions);

labelOptions SketchLabelOptionsautocast

起始版本：GeoScene Maps SDK for JavaScript 4.24

该选项用于配置所创建或更新的几何的每个线段旁边显示的标注。

已知限制

当前仅在使用 SceneView 时支持草图标注。

layer GraphicsLayer

起始版本：GeoScene Maps SDK for JavaScript 4.6

与 SketchViewModel 相关联的 GraphicsLayer。SketchViewModel 可将新图形添加到此图层，或者只能更新存储在此图层中的图形。

pointSymbol SimpleMarkerSymbol|PointSymbol3D|TextSymbol|CIMSymbol|WebStyleSymbol

SimpleMarkerSymbol、PointSymbol3D、TextSymbol、CIMSymbol 或 WebStyleSymbol 用于表示绘制的点几何。SimpleMarkerSymbol 还可用于对 SceneView 中的点要素进行符号化。但是，建议您改用 PointSymbol3D。

默认值如下：

{
  type: "simple-marker",
  style: "circle",
  size: 6,
  color: [255, 255, 255],
  outline: {
   color: [50, 50, 50],
    width: 1
  }
}

polygonSymbol SimpleFillSymbol|PolygonSymbol3D|CIMSymbol

SimpleFillSymbol、PolygonSymbol3D 或 CIMSymbol 用于表示绘制的面几何。SimpleFillSymbol 还可用于对 SceneView 中的面要素进行符号化。但是，建议您改用 PolygonSymbol3D。

默认值如下：

{
  type: "simple-fill",
  color: [150, 150, 150, 0.2],
  outline: {
    color: [50, 50, 50],
    width: 2
  }
}

polylineSymbol SimpleLineSymbol|LineSymbol3D|CIMSymbol

SimpleLineSymbol、LineSymbol3D 或 CIMSymbol 用于表示绘制的折线几何。SimpleLineSymbol 还可用于对 SceneView 中的折线要素进行符号化。但是，建议您改用 LineSymbol3D。

默认值如下：

{
  type: "simple-line",
  color: [130, 130, 130],
  width: 2
}

snappingOptions SnappingOptionsautocast

起始版本：GeoScene Maps SDK for JavaScript 4.18

用于草绘的 SnappingOptions。它支持 self 和 feature 捕捉。

state Stringreadonly

草绘视图模型的状态。

可能值："ready"|"disabled"|"active"

默认值：disabled

tooltipOptions SketchTooltipOptionsautocast

起始版本：GeoScene Maps SDK for JavaScript 4.24

该选项用于在创建或更新图形时配置游标旁边显示的工具提示。

updateGraphics Collection<Graphic>readonly

起始版本：GeoScene Maps SDK for JavaScript 4.10

由 SketchViewModel 更新的图形数组。

updateOnGraphicClick Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.10

指示是否可以选择要更新的图形。如果为 false，则无法选择要更新的图形。将此属性设置为 false 可添加用于更新图形的自定义 hitTest 逻辑。

view MapView|SceneView

用户将在其中绘制几何的视图。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

cancel()

起始版本：GeoScene Maps SDK for JavaScript 4.10

取消活动操作并触发 create 或 update 事件，如果在创建操作期间调用，则 cancel() 将丢弃部分创建的图形。

canRedo(){Boolean}

指示是否可以在当前更新会话中执行 redo() 操作。

返回

类型	描述
Boolean	如果堆栈中记录了重做操作，则返回 true。

canUndo(){Boolean}

指示是否可以在当前更新会话中执行 undo() 操作。

返回

类型	描述
Boolean	如果堆栈中记录了撤消操作，则返回 true。

complete()

起始版本：GeoScene Maps SDK for JavaScript 4.6

完成活动操作并触发 create 或 update 事件，并将事件的状态更改为 complete。如果在创建操作期间调用，则 complete() 完成活动的创建操作并保留有效几何。

create(tool, createOptions)

使用 tool 参数中指定的几何创建图形。添加图形的第一个折点时，create 事件将开始触发。提供的 tool 将成为 activeTool。

参数

规范

tool String 创建工具的名称。指定要创建的图形的几何。 可能值："point"|"multipoint"|"polyline"|"polygon"|"rectangle"|"circle"|"mesh"

createOptions Object optional 要创建的图形的选项。 规范 mode String optional 指定如何创建图形。创建模式仅在创建 polygon、polyline、rectangle 和 circle 几何时适用。 值 描述 hybrid 在单击或拖动指针时添加折点。适用于 polygon 和 polyline。 freehand 在拖动指针时添加折点。适用于 polygon、polyline rectangle 和 circle。默认为 rectangle 和 circle。 click 单击指针时会添加折点。适用于 polygon、polyline rectangle 和 circle。默认为 polygon 和 polyline。 可能值："hybrid"|"freehand"|"click" hasZ Boolean optional 控制创建的几何是否具有 z 值。 defaultZ Number optional 新创建的几何的默认 z 值。当 hasZ 为 false，或图层的高程模式设置为 absolute-height 时，将忽略此选项。

示例

// Call create method to create a polygon with freehand option.
sketchVM.create("polygon", {mode: "freehand"});

* // listen to create event, only respond when event's state changes to complete
sketchVM.on("create", function(event) {
  if (event.state === "complete") {
    // remove the graphic from the layer associated with the sketch widget
    // instead use the polygon that user created to query features that
    // intersect it.
    polygonGraphicsLayer.remove(event.graphic);
    selectFeatures(event.graphic.geometry);
  }
});

delete()

起始版本：GeoScene Maps SDK for JavaScript 4.14

删除更新工作流中使用的选定图形。调用此方法将触发 delete 事件。

示例

// selected graphics can be deleted only when update event becomes active
sketch.on("update", function(event) {
  if (event.state === "active") {
    sketch.delete();
  }
});

// fires after delete method is called
// returns references to deleted graphics.
sketch.on("delete", function(event) {
  event.graphics.forEach(function(graphic){
    console.log("deleted", graphic)
  });
});

destroy()

销毁视图模型实例。

duplicate()

起始版本：GeoScene Maps SDK for JavaScript 4.26

复制更新工作流中使用的当前图形，并自动将其添加到关联图层

emit(type, event){Boolean}

在实例上触发事件。仅当创建此类的子类时，才应使用此方法。

参数

type String 事件的名称。

event Object optional 事件有效负载。

返回

类型	描述
Boolean	true 如果监听器收到通知，则为

hasEventListener(type){Boolean}

指示实例上是否存在与提供的事件名称相匹配的事件监听器。

参数

type String 事件的名称。

返回

类型	描述
Boolean	如果类支持输入事件，则返回 true。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

on(type, listener){Object}

在实例上注册事件处理程序。调用此方法将事件与监听器挂钩。

参数

type String|String[] 要监听的事件或事件数组。

listener Function 事件触发时要调用的函数。

返回

类型	描述
Object	返回一个具有 remove() 方法的事件处理程序，应该调用该方法以停止监听事件。 属性 类型 描述 remove Function 当调用时，将从事件中移除该监听器。

示例

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

redo()

起始版本：GeoScene Maps SDK for JavaScript 4.9

逐步恢复堆栈中记录的操作。调用此方法将触发 redo 事件。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

undo()

起始版本：GeoScene Maps SDK for JavaScript 4.9

逐步撤消堆栈中记录的操作。调用此方法将触发 undo 事件。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。

update(graphics, updateOptions){Promise<void>}

起始版本：GeoScene Maps SDK for JavaScript 4.10

初始化指定图形的更新操作并触发 update 事件。

参数

规范

graphics Graphic|Graphic[] 要更新的图形或图形数组。只有添加到 SketchViewModel 的 layer 属性的图形才能更新。

updateOptions Object optional 要更新的图形的更新选项。 规范 tool String optional 更新工具的名称。指定所选图形的更新操作。提供的工具将成为 activeTool。 可能值 值 描述 transform 这是图形的默认工具，图形可以为具有面几何、折线几何的图形或使用具有点几何的 3D 对象符号图层的图形。默认情况下，它允许缩放，旋转和移动一个或多个图形。其默认行为可以通过在调用 update 方法时设置 enableRotation、enableScaling 或 preserveAspectRatio 参数来更改，或在 Sketch 微件初始化时在 defaultUpdateOptions 属性上设置它们来更改。 reshape 此工具允许移动整个图形或图形的单个折点。可以添加或移除折点。此工具只能用于具有面或折线几何的单个图形。 move 这是具有不使用 3D 对象符号图层的点几何图形的默认工具。它应用于以下特定情况：您只想移动所选 polygon 和 polyline 图形而不使用其他选项。此外，move 工具不支持切换到不同模式，因为默认情况下，move 操作同时内置于 transform 和 reshape 工具中。 可能值："transform"|"reshape"|"move" enableRotation Boolean optional 默认值：true 指示在更新图形时是否启用了 rotation 操作。仅当 tool 为 transform 时才适用。 enableScaling Boolean optional 默认值：true 指示在更新图形时是否启用了 scale 操作。仅当 tool 为 transform 时才适用。 enableZ Boolean optional 默认值：true 指示在更新图形时是否可以修改 z 值。启用后，将显示高度手柄操纵器。 multipleSelectionEnabled Boolean optional 默认值：true 指示是否可以一次进行多个选择。这适用于 shift+单击与 transform 工具的交互。 preserveAspectRatio Boolean optional 默认值： false 指示在更新图形时是否启用了统一比例操作。将此属性设置为 true 时，enableScaling 必须设置为 true。仅当 tool 为 transform，且在变换使用 3D 对象符号图层的点时始终为 true 时适用。 toggleToolOnClick Boolean optional 默认值：true 指示是否可以在 transform 和 reshape 更新选项之间切换要更新的图形。

返回

类型	描述
Promise<void>	解析请求的更新工具何时已加载并准备好使用。

示例

// start update operation for the selected graphic
// with transform tool. Only allow uniform scaling operation.
sketchVM.update([selectedGraphic], {
  tool: "transform",
  enableRotation: false,
  enableScaling: true,
  preserveAspectRatio: true,
  toggleToolOnClick: false
});

// Listen to sketch's update event to validate graphic's
// location while it is being reshaped or moved
sketchViewModel.on("update", onGraphicUpdate);
function onGraphicUpdate(event) {
  // get the graphic as it is being updated
  const graphic = event.graphics[0];
  // check if the graphic is intersecting school buffers
  intersects = geometryEngine.intersects(buffers, graphic.geometry);

  // change the graphic symbol to valid or invalid symbol
  // depending the graphic location
  graphic.symbol = (intersects) ? invalidSymbol : validSymbol

  // check if the update event's the toolEventInfo.type is move-stop or reshape-stop
  // user finished moving or reshaping the graphic, call complete method.
  // This changes update event state to complete.
  const toolType = event.toolEventInfo.type;
  if (event.toolEventInfo && (toolType === "move-stop" || toolType === "reshape-stop")) {
    if (!intersects) {
      sketchViewModel.complete();
    }
  } else if (event.state === "complete") {
      // graphic update has been completed
      // if the graphic is in a bad spot, call sketch's update method again
      // giving user a chance to correct the location of the graphic
      if ((!contains) || (intersects)) {
        sketchViewModel.update([graphic], {
          tool: "reshape",
          toggleToolOnClick: false
        });
      }
  }
}

事件概述

事件详细说明

create

起始版本：GeoScene Maps SDK for JavaScript 4.10

当用户开始草绘图形、正在绘制图形并完成绘制图形时触发。

属性

graphic Graphic 正在创建的图形。

state String 事件的当前状态。 可能值 值 描述 start 在创建第一个折点时，状态更改为 start。创建 points 时不适用。 active 创建图形时，状态为 active。创建 points 时不适用。 complete 调用 complete() 方法后，当用户在创建图形时双击、按 Enter 键或单击 polygon 的第一个折点时，状态将更改为 complete。创建 point 时，将以 complete 状态触发创建事件。 cancel 如果用户在创建操作期间和状态更改为 complete 之前按了 escape 键或调用了 create() 或 cancel() 方法，则状态更改为 cancel。 可能值："start"|"active"|"complete"|"cancel"

tool String 创建工具的名称。 可能值："point"|"multipoint"|"polyline"|"polygon"|"rectangle"|"circle"|"mesh"

toolEventInfo CreateToolEventInfo 返回与创建操作相关的其他信息，例如用户单击视图的位置或用户将光标移动到的位置。当 create 事件的 state 更改为 complete 或 cancel 时，此参数的值将更改为 null。

type String 事件的类型。 值通常是 "create"。

示例

// Listen to sketch widget's create event.
sketchVM.on("create", function(event) {
  // check if the create event's state has changed to complete indicating
  // the graphic create operation is completed.
  if (event.state === "complete") {
    // remove the graphic from the layer. Sketch adds
    // the completed graphic to the layer by default.
    polygonGraphicsLayer.remove(event.graphic);

    // use the graphic.geometry to query features that intersect it
    selectFeatures(event.graphic.geometry);
  }
});

delete

起始版本：GeoScene Maps SDK for JavaScript 4.14

当用户通过单击 Sketch 微件上的 Delete feature 按钮来删除选定图形或调用 delete() 方法时触发。

属性

graphics Graphic[] 删除图形的数组。

tool String 删除图形时激活的工具的名称。 可能值："move"|"reshape"|"transform"

type String 事件的类型。 值通常是 "delete"。

redo

起始版本：GeoScene Maps SDK for JavaScript 4.10

在创建新图形或更新现有图形期间，为响应恢复操作而触发。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。

属性

graphics Graphic[] 更新或创建的图形数组。

tool String 激活的创建或更新工具的名称。 可能值："point"|"multipoint"|"polyline"|"polygon"|"rectangle"|"circle"|"mesh"|"move"|"transform"|"reshape"

type String 事件的类型。 值通常是 "redo"。

undo

起始版本：GeoScene Maps SDK for JavaScript 4.10

在创建新图形或更新现有图形期间，为响应撤消操作而触发。撤消/恢复堆栈用于单个草绘操作，这意味着您可以在创建或更新图形时恢复/撤消操作。

属性

graphics Graphic[] 更新或创建的图形数组。

tool String 激活的创建或更新工具的名称。 可能值："point"|"multipoint"|"polyline"|"polygon"|"rectangle"|"circle"|"mesh"|"move"|"transform"|"reshape"

type String 事件的类型。 值通常是 "undo"。

update

起始版本：GeoScene Maps SDK for JavaScript 4.10

当用户开始更新图形、正在更新图形以及完成更新图形时触发。

属性

graphics Graphic[] 正在更新的图形数组。

state String 事件的状态。 可能值 值 描述 start 选择要更新的图形时，状态更改为 start。 active 当图形正在更新且 toolEventInfo 参数不为 null 时，状态为 active。 complete 图形更新后状态更改为 complete。 可能值："start"|"active"|"complete"

aborted Boolean 指示更新操作是否已中止。如果用户按下 escape 键，或者在 update 事件的 state 更改为 complete 之前调用 update()、create() 或 cancel() 方法，则设置为 true。

tool String 更新操作工具的名称。 可能值："move"|"transform"|"reshape"

type String 事件的类型。 值通常是 "update"。

toolEventInfo UpdateToolEventInfo 更新操作工具信息。返回与所选图形正在进行的更新操作相关的其他信息，以及更新操作所处的阶段。当 update 事件的 state 更改为 complete 时，此参数的值将更改为 null。

示例

// Listen to SketchViewModel's update event to show relevant data in a chart
// as the graphics are being moved
sketchViewModel.on("update", onMove);

// Point graphics at the center and edge of the buffer polygon are being moved.
// Recalculate the buffer with updated geometry and run the query stats using
// the updated buffer and update the chart.
function onMove(event) {
  // If the edge graphic is moving, keep the center graphic
  // at its initial location. Only move edge graphic to resize the buffer.
  if (event.toolEventInfo && event.toolEventInfo.mover.attributes.edge) {
    const toolType = event.toolEventInfo.type;
    if (toolType === "move-start") {
      centerGeometryAtStart = centerGraphic.geometry;
    }
    // keep the center graphic at its initial location when edge point is moving
    else if (toolType === "move" || toolType === "move-stop") {
      centerGraphic.geometry = centerGeometryAtStart;
    }
  }

  // the center or edge graphic is being moved, recalculate the buffer
  const vertices = [
    [centerGraphic.geometry.x, centerGraphic.geometry.y],
    [edgeGraphic.geometry.x, edgeGraphic.geometry.y]
  ];

  // client-side stats query of features that intersect the buffer
  calculateBuffer(vertices);

  // user is clicking on the view... call update method with the center and edge graphics
  if (event.state === "complete" && !event.aborted) {
    sketchViewModel.update([edgeGraphic, centerGraphic], { tool: "move" });
  }
}