跳到主要内容
版本：9.16.0

三维图形绘制图层（sketchLayer）

方法​

clear​

清除所有绘制的图形。

参数​

无

案例​

sketchLayer.clear() // 清除所有绘制的图形

editShapeById​

根据图形id编辑图形，id为图形数据中id属性值。

参数​

名称类型描述
idString必填图形id，用于唯一标识一个图形。

案例​

sketchLayer.editShapeById(id)

exportData​

导出绘制的图形数据。

参数​

无

案例​

let data = sketchLayer.exportData() // 导出绘制的图形数据
console.log(data) // 输出导出的图形数据

importData​

导入图形数据，并在场景中显示图形。

参数​

无

案例​

let data = sketchLayer.exportData() 
sketchLayer.importData(data) // 导入绘制的图形数据

getShapeById​

根据图形id获取图形数据，id为图形数据中id属性值。

参数​

名称类型描述
idString必填图形id，用于唯一标识一个图形。

案例​

let shapeData = sketchLayer.getShapeById(id) // 获取图形数据
console.log('图形数据:',shapeData) // 输出图形数据

getSelectedShape​

获取鼠标当前选中的图形。

参数​

无

案例​

const shape = sketchLayer.getSelectedShape(); // 获取当前选中的图形数据
if (shape) {
    console.log('选中的图形:',shape) // 输出选中的图形数据
}

removeSelected​

移除鼠标当前选中的图形。

参数​

无

案例​

const shape = sketchLayer.getSelectedShape(); // 获取当前选中的图形数据
if (shape) {
    sketchLayer.removeSelected() // 移除选中的图形
}

setEditable​

设置编辑状态。

参数​

名称类型描述
editableBoolean必填设置是否可编辑。

案例​

sketchLayer.setEditable(true) // 设置可编辑
sketchLayer.setEditable(false) // 设置不可编辑

setMode​

设置图形绘制模式。

参数​

名称类型描述
modeEnum必填设置图形绘制模式，可选值为“none"、"polygon"、"rectangle"、"circle"，分别表示取消绘制、绘制多边形、绘制矩形、绘制圆形。

案例​

sketchLayer.setMode('polygon') // 设置绘制多边形模式
sketchLayer.setMode('rectangle') // 设置绘制矩形模式
sketchLayer.setMode('circle') // 设置绘制圆形模式
sketchLayer.setMode('none') // 设置取消绘制模式

updateShapeById​

根据图形id更新图形数据，id为图形数据中id属性值。

参数​

名称类型描述
idString必填图形id，用于唯一标识一个图形。
dataObject可选设置需要更新的属性
名称类型描述
fillColorString可选图形填充面颜色，默认为图形当前填充面颜色的值。
fillOpacityNumber可选图形填充面不透明度，取值范围0.0~1.0，默认为图形当前填充面不透明度的值。
strokeColorString可选图形边框线颜色，默认为图形当前边框线颜色的值。
strokeWidthNumber可选图形边框线宽度，单位为像素，默认为图形当前边框线宽度的值。
strokeOpacityNumber可选图形边框线不透明度，取值范围0.0~1.0，默认为图形当前边框线不透明度的值。

案例​

let data = {
    fillColor: '#000000',
    fillOpacity: 0.5,
    strokeColor: '#ffffff',
    strokeWidth: 2,
    strokeOpacity: 0.5,
}
sketchLayer.updateShapeById(id, data)

updateShapeFillColor​

更新鼠标当前选中的图形的填充面颜色。

参数​

名称类型描述
shapeObject必填选中的图形数据。
fillColorString必填图形填充面颜色。

案例​

const shape = sketchLayer.getSelectedShape(); // 获取当前选中的图形数据
sketchLayer.updateShapeFillColor(shape, '#000000') // 更新选中的图形填充面颜色为黑色

updateShapeStrokeColor​

更新鼠标当前选中的图形的边框线颜色。

参数​

名称类型描述
shapeObject必填选中的图形数据。
strokeColorString必填图形边框线颜色。

案例​

const shape = sketchLayer.getSelectedShape(); // 获取当前选中的图形数据
sketchLayer.updateShapeStrokeColor(shape, '#ffffff') // 更新选中的图形边框线颜色为白色

undo​

撤销上一步绘制的图形。

参数​

无

案例​

sketchLayer.undo() // 撤销上一步绘制的图形