Class: SketchPolygonDrawTool

SketchPolygonDrawTool

new SketchPolygonDrawTool(options)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 11

区绘图工具类

Name Type Description
options Object

构造参数

Name Type Description
view MapView | SceneView 可选

地图视图对象
layer GraphicsLayer 可选

草图图层管对象
sketchStyle SketchStyle 可选

草图符号

Extends

Members

arcTypeNumber

弧线类型

editOptionObject

草图选中编辑配置项

elevationInfoSketchStyle

图形高程模式参数

extensionOptionsObject

草图编辑的扩展属性，可以通过该属性传入草图编辑额外需要的参数

layerGraphicsLayer

草图图层

sketchStageSketchStage

草图绘图形集合

sketchStyleSketchStyle

草图符号

typeString

草图工具类型名

undoRedoManagerString

草图撤销回退管理器

viewMapView SceneView

地图视图

Methods

inherited _getProjectionOnRotatedAxes(rotationAngle, startPoint, endPoint){Object}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3294

计算点2到中心点在旋转后坐标轴上的投影距离

Name Type Description
rotationAngle number

旋转角度（弧度）
startPoint Object

起始点（中心点），格式 { x, y }
endPoint Object

终止点（目标点），格式 { x, y }
Returns:
Type Description
Object 返回 { x, y } 表示在旋转后坐标系中的投影距离

inherited _getProjectionOnRotatedAxes1(rotation, startPoint, endPoint){Object}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3331

计算点到坐标轴方向的分量

Name Type Description
rotation number

坐标系旋转角度（弧度，正值为顺时针）
startPoint Object

起点（原点）像素坐标 {x, y}
endPoint Object

终点（P点）像素坐标 {x, y}
Returns:
Type Description
Object 返回 {x, y} - 点在旋转后坐标系的x轴和y轴方向上的分量距离

inherited _getSphereCenterPoint()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 4041

获取立体几何的中心点

inherited _getSphereParams()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3997

获取立体几何的外包球中心点、半径、半径单位等属性

inherited _rotatePoint(angleDegrees, P, Q){Object}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3384

计算点Q绕点P旋转后的坐标

Name Type Description
angleDegrees number

旋转角度（度），逆时针为正，顺时针为负
P Object

旋转中心点坐标
Q Object

旋转前Q点坐标
Returns:
Type Description
Object Q点旋转后的坐标

addFeature(points, sketchStyle)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 431

添加图形

Name Type Description
points Array

生成面的点地理坐标集
sketchStyle SketchStyle

面的符号样式

addMidVertex()

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 1534

选中图形中点点

drawFeature()

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 71

鼠标绘制图形：鼠标单击绘制区的一个顶点；鼠标移动，区图形随鼠标位置变动；鼠标双击，完成区图形绘制。

inherited getDistanceByPixel(pixel){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1975

根据像素单位获取距离

Name Type Description
pixel Number

编辑状态码
Returns:
Type Description
Number 距离

inherited getMidScaleCoordinates(coordinates, direction, extent, startPoint, movePoint, oriCoordinates){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 2106

获取图形通过四个中点缩放后的坐标

Name Type Description
coordinates Array

坐标数组
direction String

方向
extent Extent

图形extent范围
startPoint Point

移动前的点
movePoint Point

移动后的点
oriCoordinates Point

图形原始坐标
Returns:
Type Description
Number 缩放后的坐标

inherited getPanCoordinates(coordinates, deltaX, deltaY, pointType, extent){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1993

获取平移后的坐标

Name Type Description
coordinates Array

坐标数组
deltaX Number

x轴偏移量
deltaY Number

y轴偏移量
pointType Number

点属性类型
extent Number

点所在范围
Returns:
Type Description
Number 平移后的坐标

inherited getScaleCoordinates(coordinates, direction, extent, startPoint, movePoint, oriCoordinates){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 2023

获取图形通过四个顶点缩放后的坐标

Name Type Description
coordinates Array

坐标数组
direction String

方向
extent Extent

图形extent范围
startPoint Point

移动前的点
movePoint Point

移动后的点
oriCoordinates Point

图形原始坐标
Returns:
Type Description
Number 缩放后的坐标

inherited removeDrawTool()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1922

清除草图绘制工具

removeVertex(index)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 1971

移除草图图形的某个顶点

Name Type Description
index Number

需移除的顶点的索引值，索引值从0开始

selectFeature(feature)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 525

选中草图feature

Name Type Description
feature Feature

被选中草图feature对象

inherited selectFeatureRotate(feature)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3814

选中feature图形旋转

Name Type Description
feature Feature

被选中feature对象

selectFeatureVertex(feature)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 534

选中feature图形顶点

Name Type Description
feature Feature

被选中feature对象

inherited setSketchStyle(sketchStyle)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1742

设置草图样式

Name Type Description
sketchStyle SketchStyle

inherited setSnapAndReferGeometries(geometries)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 2874

设置捕获和线造区边界参考几何图形集合

Name Type Description
geometries Array.<Geometry>

可选，几何图形集合。

inherited setSnapFeatures(features)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3808

设置捕获和线造区边界参考几何图形集合

Name Type Description
features Array.<Geometry>

可选，几何图形集合。

inherited start()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 176

开始绘制草图

startPanGraphics(feature, event)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 740

平移图形

Name Type Description
feature Feature

被选中feature对象
event Object

拾取事件

inherited stop()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 189

停止绘制草图

inherited updateFeature(point, feature)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1900

更新feature

Name Type Description
point Point

待更新的位置
feature Feature

被更新的feature

updateVertex(point, index)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 1799

更新当前草图图形的某个顶点

Name Type Description
point Point

新的顶点
index Number

需更新的顶点的索引值，索引值从0开始

SketchPolygonDrawTool

new SketchPolygonDrawTool(options)

sketchEditor/base/SketchSnappingTool.js, line 14

草图捕捉工具类

Name Type Description
options Object

构造参数

Name Type Description
pixelTolerance Object 可选

容差（像素单位）
tolerance Object 可选

容差（米单位）
isSnapVertex Object 可选

是否自动捕捉顶点
isSnapVertexInLine Object 可选

是否自动捕捉线上的点
isSnapPerpendicular Object 可选

是否自动捕捉垂点
isSnapParallel Object 可选

是否自动捕捉水平交点

Members

arcTypeNumber

弧线类型

editOptionObject

草图选中编辑配置项

elevationInfoSketchStyle

图形高程模式参数

extensionOptionsObject

草图编辑的扩展属性，可以通过该属性传入草图编辑额外需要的参数

layerGraphicsLayer

草图图层

sketchStageSketchStage

草图绘图形集合

sketchStyleSketchStyle

草图符号

typeString

草图工具类型名

undoRedoManagerString

草图撤销回退管理器

viewMapView SceneView

地图视图

Methods

inherited _getProjectionOnRotatedAxes(rotationAngle, startPoint, endPoint){Object}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3294

计算点2到中心点在旋转后坐标轴上的投影距离

Name Type Description
rotationAngle number

旋转角度（弧度）
startPoint Object

起始点（中心点），格式 { x, y }
endPoint Object

终止点（目标点），格式 { x, y }
Returns:
Type Description
Object 返回 { x, y } 表示在旋转后坐标系中的投影距离

inherited _getProjectionOnRotatedAxes1(rotation, startPoint, endPoint){Object}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3331

计算点到坐标轴方向的分量

Name Type Description
rotation number

坐标系旋转角度（弧度，正值为顺时针）
startPoint Object

起点（原点）像素坐标 {x, y}
endPoint Object

终点（P点）像素坐标 {x, y}
Returns:
Type Description
Object 返回 {x, y} - 点在旋转后坐标系的x轴和y轴方向上的分量距离

inherited _getSphereCenterPoint()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 4041

获取立体几何的中心点

inherited _getSphereParams()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3997

获取立体几何的外包球中心点、半径、半径单位等属性

inherited _rotatePoint(angleDegrees, P, Q){Object}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3384

计算点Q绕点P旋转后的坐标

Name Type Description
angleDegrees number

旋转角度（度），逆时针为正，顺时针为负
P Object

旋转中心点坐标
Q Object

旋转前Q点坐标
Returns:
Type Description
Object Q点旋转后的坐标

addFeature(points, sketchStyle)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 431

添加图形

Name Type Description
points Array

生成面的点地理坐标集
sketchStyle SketchStyle

面的符号样式

addMidVertex()

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 1534

选中图形中点点

drawFeature()

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 71

鼠标绘制图形：鼠标单击绘制区的一个顶点；鼠标移动，区图形随鼠标位置变动；鼠标双击，完成区图形绘制。

inherited getDistanceByPixel(pixel){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1975

根据像素单位获取距离

Name Type Description
pixel Number

编辑状态码
Returns:
Type Description
Number 距离

inherited getMidScaleCoordinates(coordinates, direction, extent, startPoint, movePoint, oriCoordinates){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 2106

获取图形通过四个中点缩放后的坐标

Name Type Description
coordinates Array

坐标数组
direction String

方向
extent Extent

图形extent范围
startPoint Point

移动前的点
movePoint Point

移动后的点
oriCoordinates Point

图形原始坐标
Returns:
Type Description
Number 缩放后的坐标

inherited getPanCoordinates(coordinates, deltaX, deltaY, pointType, extent){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1993

获取平移后的坐标

Name Type Description
coordinates Array

坐标数组
deltaX Number

x轴偏移量
deltaY Number

y轴偏移量
pointType Number

点属性类型
extent Number

点所在范围
Returns:
Type Description
Number 平移后的坐标

inherited getScaleCoordinates(coordinates, direction, extent, startPoint, movePoint, oriCoordinates){Number}

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 2023

获取图形通过四个顶点缩放后的坐标

Name Type Description
coordinates Array

坐标数组
direction String

方向
extent Extent

图形extent范围
startPoint Point

移动前的点
movePoint Point

移动后的点
oriCoordinates Point

图形原始坐标
Returns:
Type Description
Number 缩放后的坐标

inherited removeDrawTool()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1922

清除草图绘制工具

removeVertex(index)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 1971

移除草图图形的某个顶点

Name Type Description
index Number

需移除的顶点的索引值，索引值从0开始

selectFeature(feature)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 525

选中草图feature

Name Type Description
feature Feature

被选中草图feature对象

inherited selectFeatureRotate(feature)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3814

选中feature图形旋转

Name Type Description
feature Feature

被选中feature对象

selectFeatureVertex(feature)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 534

选中feature图形顶点

Name Type Description
feature Feature

被选中feature对象

inherited setSketchStyle(sketchStyle)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1742

设置草图样式

Name Type Description
sketchStyle SketchStyle

inherited setSnapAndReferGeometries(geometries)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 2874

设置捕获和线造区边界参考几何图形集合

Name Type Description
geometries Array.<Geometry>

可选，几何图形集合。

inherited setSnapFeatures(features)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 3808

设置捕获和线造区边界参考几何图形集合

Name Type Description
features Array.<Geometry>

可选，几何图形集合。

inherited start()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 176

开始绘制草图

startPanGraphics(feature, event)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 740

平移图形

Name Type Description
feature Feature

被选中feature对象
event Object

拾取事件

inherited stop()

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 189

停止绘制草图

inherited updateFeature(point, feature)

sketchEditor/base/drawTools/SketchBaseDrawTool.js, line 1900

更新feature

Name Type Description
point Point

待更新的位置
feature Feature

被更新的feature

updateVertex(point, index)

sketchEditor/base/drawTools/SketchPolygonDrawTool.js, line 1799

更新当前草图图形的某个顶点

Name Type Description
point Point

新的顶点
index Number

需更新的顶点的索引值，索引值从0开始