MultipointDrawAction

AMD: require(["geoscene/views/draw/MultipointDrawAction"], (MultipointDrawAction) => { /* 代码 */ });
ESM: import MultipointDrawAction from "@geoscene/core/views/draw/MultipointDrawAction";
类: geoscene/views/draw/MultipointDrawAction
继承于: MultipointDrawAction DrawAction Accessor
起始版本: GeoScene API for JavaScript 4.22

此类使用视图事件生成一组坐标,以使用 Draw 创建新的 Multipoint 几何。调用 draw.create("multipoint") 方法时,将返回对 MultipointDrawAction 的引用。 您可以监听 MultipointDrawAction 实例上的 events,该实例允许用户创建满足应用程序指定条件的多点。

已知限制

目前 MultipointDrawAction 仅在 MapView 中受支持。

示例:
示例代码:
function enableCreateMultipoint(draw, view) {
  let action = draw.create("multipoint");

  // 当用户将指针移到视图上时,向他们提供视觉反馈
  action.on("cursor-update", function (evt) {
    createMultipointGraphic(evt.vertices);
  });

  // 当用户点击或按下视图上的“F”键时触发
  //也可以在按下“R”键重做时触发。
  action.on("vertex-add", function (evt) {
    createMultipointGraphic(evt.vertices);
  });

  // 当按下“Z”键撤消最后添加的点时触发
  action.on("vertex-remove", function (evt) {
    createMultipointGraphic(evt.vertices);
  });

  // 当用户点击视图或按下“C”键时创建一个点。
  action.on("draw-complete", function (evt) {
    createMultipointGraphic(evt.vertices);
  });
}

function createMultipointGraphic(vertices) {
  view.graphics.removeAll();

  let multipoint = new Multipoint({
    points: vertices,
    spatialReference: view.spatialReference
  });

  graphic = new Graphic({
    geometry: multipoint,
    symbol: {
      type: "simple-marker",
      style: "square",
      color: "red",
      size: "16px",
      outline: {
        color: [255, 255, 0],
        width: 3
      }
    }
  });
  view.graphics.add(graphic);
}

构造函数

new MultipointDrawAction(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
String更多信息

类名。

更多信息Accessor
Boolean更多信息

控制创建的几何图形是否具有 z 坐标。

更多信息DrawAction
Number[][]更多信息

数字的二维数组,表示组成正在绘制的几何图形的每个顶点的坐标。

更多信息DrawAction
MapView更多信息

MapView 的引用。

更多信息DrawAction

属性详细说明

declaredClass Stringreadonly inherited
起始版本: GeoScene API for JavaScript 4.22

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

控制创建的几何图形是否具有 z 坐标。

默认值:true
vertices Number[][]readonly inherited

数字的二维数组,表示组成正在绘制的几何图形的每个顶点的坐标。

MapView 的引用。

方法列表

展示继承方法 隐藏继承方法
属性 返回值类型 描述
Boolean更多信息

指示是否可以在操作实例上调用 redo() 方法。

更多信息DrawAction
Boolean更多信息

指示是否可以在操作实例上调用 undo() 方法。

更多信息DrawAction
更多信息

完成绘制 multipoint 几何并触发 draw-complete 事件。

更多信息MultipointDrawAction
Boolean更多信息

在实例上触发事件。

更多信息DrawAction
FromScreenPointResult|null更多信息

将给定的屏幕点映射到地图点。

更多信息DrawAction
Number[]|null更多信息

将给定的屏幕点映射到地图点。

更多信息DrawAction
Boolean更多信息

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

更多信息DrawAction
Object更多信息

在实例上注册事件处理程序。

更多信息DrawAction
更多信息

增量重做堆栈中记录的操作。

更多信息DrawAction
Point|null更多信息

将给定的屏幕点映射到地图点。

更多信息DrawAction
更多信息

逐步撤消堆栈中记录的操作。

更多信息DrawAction

方法详细说明

canRedo(){Boolean}inherited

指示是否可以在操作实例上调用 redo() 方法。

返回值:
类型 描述
Boolean 如果 redo() 可以被调用,将会返回 true
canUndo(){Boolean}inherited

指示是否可以在操作实例上调用 undo() 方法。

返回值:
类型 描述
Boolean 如果 undo() 可以被调用,将会返回 true
complete()

完成绘制 multipoint 几何并触发 draw-complete 事件如果绘图逻辑需要通过双击或按“C”键以外的方式完成,则调用此方法。

emit(type, event){Boolean}inherited

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

参数:
type String

事件名称

event Object
optional

事件负载。

返回值:
类型 描述
Boolean 如果侦听器收到通知,则为true 
getCoordsAndPointFromScreenPoint(screenPoint){FromScreenPointResult|null}inherited

将给定的屏幕点映射到地图点。

参数:
screenPoint ScreenPoint

屏幕上的位置。

返回值:
类型 描述
FromScreenPointResult | null 包含的结果对象,如果无法映射屏幕点,则返回 null
getCoordsFromScreenPoint(screenPoint){Number[]|null}inherited

将给定的屏幕点映射到地图点。

参数:
screenPoint ScreenPoint

屏幕上的位置。

返回值:
类型 描述
Number[] | null 与给定屏幕点关联的点的 x、y 和 z 分量数组(如果启用了 hasZ),如果无法映射屏幕点,则为 null
hasEventListener(type){Boolean}inherited

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

参数:
type String

事件名称

返回值:
类型 描述
Boolean 如果类支持输入事件,则返回 true。
on(type, listener){Object}inherited

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

参数:

要监听的event 或者事件数组

listener Function

事件触发时要调用的函数

返回值:
类型 描述
Object 返回一个remove() 方法的事件处理程序,该方法用以停止侦听事件。
属性 类型 描述
remove Function 当被调用时,从事件中移除监听器。
示例代码:
view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});
redo()inherited

增量重做堆栈中记录的操作。在调用此方法之前调用 canRedo() 以检查是否可以在操作实例上调用此方法。 调用此方法将触发 vertex-addvertex-remove 事件,具体取决于最后一个操作。

示例代码:
if (action.canRedo()) {
  action.redo();
}
screenToMap(screenPoint){Point|null}inherited

将给定的屏幕点映射到地图点。

参数:
screenPoint ScreenPoint

屏幕上的位置。

返回值:
类型 描述
Point | null MapPoint 与给定的屏幕点关联,如果屏幕点无法映射,则为 null。 
undo()inherited

逐步撤消堆栈中记录的操作。 在调用此方法之前调用 canUndo() 以检查是否可以在操作实例上调用此方法。 调用此方法将触发 vertex-addvertex-remove 事件,具体取决于最后一个操作。

示例代码:
if (action.canUndo()) {
  action.undo();
}

Event Overview

属性 类型 描述
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: "cursor-update"}
更多信息

指针在视图上移动后触发。

更多信息 MultipointDrawAction
{vertices: Number[][],preventDefault: Function,defaultPrevented: Boolean,type: "draw-complete"}
更多信息

在用户完成绘制 multipoint 后触发。

更多信息 MultipointDrawAction
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: String}
更多信息

在响应重做操作或调用 redo() 时触发。

更多信息 MultipointDrawAction
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: String}
更多信息

在响应撤消操作或调用 undo() 时触发。

更多信息 MultipointDrawAction
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: "vertex-add"}
更多信息

当一个点添加到 multipoint 时触发。

更多信息 MultipointDrawAction
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: "vertex-remove"}
更多信息

当一个点从 multipoint 中移除时触发。

更多信息 MultipointDrawAction

Event Details

cursor-update

指针在视图上移动后触发。

属性:
vertices Number[][]

表示绘制几何图形的每个顶点坐标的二维数字数组。

vertexIndex Number

添加到顶点数组的最后一个顶点的索引。

preventDefault Function

防止事件传播在事件链上冒泡。

defaultPrevented Boolean

在调用 preventDefault() 时设置为 true。

type String

事件类型

该值通常是 "cursor-update".

示例代码:
// 当指针在视图上移动时触发。
action.on("cursor-update", function (evt) {
  view.graphics.removeAll();
  let multipoint = new Multipoint({
    points: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(multipoint);
  view.graphics.add(graphic);
});
draw-complete

在用户完成绘制 multipoint 后触发。

属性:
vertices Number[][]

表示绘制几何图形的每个顶点坐标的二维数字数组。

preventDefault Function

防止事件传播在事件链上冒泡。

defaultPrevented Boolean

在调用 preventDefault() 时设置为 true。

type String

事件类型

该值通常是 "draw-complete".

示例代码:
// 完成绘制多点时触发。
action.on("draw-complete", function (evt) {
  view.graphics.removeAll();
  let multipoint = new Multipoint({
    points: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(multipoint);
  view.graphics.add(graphic);
});
redo
起始版本: GeoScene API for JavaScript 4.22

在响应重做操作或调用 redo() 时触发。

属性:
vertices Number[][]

二维数字数组,表示构成几何的每个顶点的坐标。

vertexIndex Number

应用 redo 的顶点的索引。

preventDefault Function

防止事件传播在事件链上冒泡。

defaultPrevented Boolean

在调用 preventDefault() 时设置为 true。

type String

事件的类型。 对于此事件,重做的事件类型。 例如,如果由于 redo 而添加了顶点,则类型将是 vertex-add

示例代码:
// 更新视图上的图形,因为最后一个操作被重做
action.on("redo", function (evt) {
  view.graphics.removeAll();
  let multipoint = new Multipoint({
    points: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(multipoint);
  view.graphics.add(graphic);
});
undo
起始版本: GeoScene API for JavaScript 4.22

在响应撤消操作或调用 undo() 时触发。

属性:
vertices Number[][]

二维数字数组,表示构成几何的每个顶点的坐标。

vertexIndex Number

应用 undo 的顶点的索引。

preventDefault Function

防止事件传播在事件链上冒泡。

defaultPrevented Boolean

在调用 preventDefault() 时设置为 true。

type String

事件的类型。对于此事件,请键入已撤消的事件。 例如,如果顶点由于 undo 而被删除,则类型将是 vertex-remove

示例代码:
// 更新视图上的图形,因为最后一个操作被撤消
action.on("undo", function (evt) {
  view.graphics.removeAll();
  let multipoint = new Multipoint({
    points: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(multipoint);
  view.graphics.add(graphic);
});
vertex-add

当一个点添加到 multipoint 时触发。

属性:
vertices Number[][]

表示绘制几何图形的每个顶点坐标的二维数字数组。

vertexIndex Number

添加到顶点数组的最后一个顶点的索引。

preventDefault Function

防止事件传播在事件链上冒泡。

defaultPrevented Boolean

在调用 preventDefault() 时设置为 true。

type String

事件类型

该值通常是 "vertex-add".

示例代码:
// 当一个点被添加到 multipoint 时触发。
action.on("vertex-add", function (evt) {
  view.graphics.removeAll();
  let multipoint = new Multipoint({
    points: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(multipoint);
  view.graphics.add(graphic);
});
vertex-remove

当一个点从 multipoint 中移除时触发。

属性:
vertices Number[][]

表示绘制几何图形的每个顶点坐标的二维数字数组。

vertexIndex Number

从顶点数组中移除的顶点的索引。

preventDefault Function

防止事件传播在事件链上冒泡。

defaultPrevented Boolean

在调用 preventDefault() 时设置为 true。

type String

事件类型

该值通常是 "vertex-remove".

示例代码:
// 当一个点从 multipoint 中移除时触发。
action.on("vertex-remove", function (evt) {
  view.graphics.removeAll();
  let multipoint = new Multipoint({
    points: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(multipoint);
  view.graphics.add(graphic);
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.