# Path2D对象
> **说明:**
>从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
路径对象,支持通过对象的接口进行路径的描述,并通过Canvas的stroke接口进行绘制。
## addPath
addPath\(path: Object\): void
将另一个路径添加到当前的路径对象中。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
path
|
Object
|
是
|
null
|
需要添加到当前路径的路径对象
|
- 示例
```
@Entry
@Component
struct AddPath {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Da: Path2D = new Path2D("M250 150 L150 350 L350 350 Z")
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.addPath(this.path2Da)
this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```

## closePath
closePath\(\): void
将路径的当前点移回到路径的起点,当前点到起点间画一条直线。如果形状已经闭合或只有一个点,则此功能不执行任何操作。
- 示例
```
@Entry
@Component
struct ClosePath {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.moveTo(200, 100)
this.path2Db.lineTo(300, 100)
this.path2Db.lineTo(200, 200)
this.path2Db.closePath()
this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```
.png)
## moveTo
moveTo\(x: number, y: number\): void
将路径的当前坐标点移动到目标点,移动过程中不绘制线条。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
x
|
number
|
是
|
0
|
目标点X轴坐标
|
y
|
number
|
是
|
0
|
目标点Y轴坐标
|
- 示例
```
@Entry
@Component
struct MoveTo {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.moveTo(50, 100)
this.path2Db.lineTo(250, 100)
this.path2Db.lineTo(150, 200)
this.path2Db.closePath()
this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```

## lineTo
lineTo\(x: number, y: number\): void
从当前点绘制一条直线到目标点。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
x
|
number
|
是
|
0
|
目标点X轴坐标
|
y
|
number
|
是
|
0
|
目标点Y轴坐标
|
- 示例
```
@Entry
@Component
struct LineTo {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.moveTo(100, 100)
this.path2Db.lineTo(100, 200)
this.path2Db.lineTo(200, 200)
this.path2Db.lineTo(200, 100)
this.path2Db.closePath()
this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```
.png)
## bezierCurveTo
bezierCurveTo\(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number\): void
创建三次贝赛尔曲线的路径。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
cp1x
|
number
|
是
|
0
|
第一个贝塞尔参数的x坐标值。
|
cp1y
|
number
|
是
|
0
|
第一个贝塞尔参数的y坐标值。
|
cp2x
|
number
|
是
|
0
|
第二个贝塞尔参数的x坐标值。
|
cp2y
|
number
|
是
|
0
|
第二个贝塞尔参数的y坐标值。
|
x
|
number
|
是
|
0
|
路径结束时的x坐标值。
|
y
|
number
|
是
|
0
|
路径结束时的y坐标值。
|
- 示例
```
@Entry
@Component
struct BezierCurveTo {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.moveTo(10, 10)
this.path2Db.bezierCurveTo(20, 100, 200, 100, 200, 20);this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```

## quadraticCurveTo
quadraticCurveTo\(cpx: number, cpy: number, x: number ,y: number\): void
创建二次贝赛尔曲线的路径。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
cpx
|
number
|
是
|
0
|
贝塞尔参数的x坐标值。
|
cpy
|
number
|
是
|
0
|
贝塞尔参数的y坐标值。
|
x
|
number
|
是
|
0
|
路径结束时的x坐标值。
|
y
|
number
|
是
|
0
|
路径结束时的y坐标值。
|
- 示例
```
@Entry
@Component
struct QuadraticCurveTo {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.moveTo(10, 10)
this.path2Db.quadraticCurveTo(100, 100, 200, 20)
this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```

## arc
arc\(x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: number\): void
绘制弧线路径。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
x
|
number
|
是
|
0
|
弧线圆心的x坐标值。
|
y
|
number
|
是
|
0
|
弧线圆心的y坐标值。
|
radius
|
number
|
是
|
0
|
弧线的圆半径。
|
startAngle
|
number
|
是
|
0
|
弧线的起始弧度。
|
endAngle
|
number
|
是
|
0
|
弧线的终止弧度。
|
anticlockwise
|
boolean
|
否
|
false
|
是否逆时针绘制圆弧。
|
- 示例
```
@Entry
@Component
struct Arc {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.arc(100, 75, 50, 0, 6.28);this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```

## arcTo
arcTo\(x1: number, y1: number, x2: number, y2: number, radius: number\): void
依据圆弧经过的点和圆弧半径创建圆弧路径。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
x1
|
number
|
是
|
0
|
圆弧经过的第一个点的x坐标值。
|
y1
|
number
|
是
|
0
|
圆弧经过的第一个点的y坐标值。
|
x2
|
number
|
是
|
0
|
圆弧经过的第二个点的x坐标值。
|
y2
|
number
|
是
|
0
|
圆弧经过的第二个点的y坐标值。
|
radius
|
number
|
是
|
0
|
圆弧的圆半径值。
|
- 示例
```
@Entry
@Component
struct ArcTo {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.arcTo(150, 20, 150, 70, 50)
this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```

## ellipse
ellipse\(x: number, y: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number, anticlockwise?: number\): void
在规定的矩形区域绘制一个椭圆。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
x
|
number
|
是
|
0
|
椭圆圆心的x轴坐标。
|
y
|
number
|
是
|
0
|
椭圆圆心的y轴坐标。
|
radiusX
|
number
|
是
|
0
|
椭圆x轴的半径长度。
|
radiusY
|
number
|
是
|
0
|
椭圆y轴的半径长度。
|
rotation
|
number
|
是
|
0
|
椭圆的旋转角度,单位为弧度。
|
startAngle
|
number
|
是
|
0
|
椭圆绘制的起始点角度,以弧度表示。
|
endAngle
|
number
|
是
|
0
|
椭圆绘制的结束点角度,以弧度表示。
|
anticlockwise
|
number
|
否
|
0
|
是否以逆时针方向绘制椭圆,0为顺时针,1为逆时针。(可选参数,默认为0)
|
- 示例
```
@Entry
@Component
struct CanvasExample {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.ellipse(200, 200, 50, 100, Math.PI * 0.25, Math.PI * 0.5, Math.PI, true)
this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```

## rect
rect\(x: number, y: number, width: number, height: number\): void
创建矩形路径。
- 参数
参数
|
类型
|
必填
|
默认值
|
描述
|
x
|
number
|
是
|
0
|
指定矩形的左上角x坐标值。
|
y
|
number
|
是
|
0
|
指定矩形的左上角y坐标值。
|
width
|
number
|
是
|
0
|
指定矩形的宽度。
|
height
|
number
|
是
|
0
|
指定矩形的高度。
|
- 示例
```
@Entry
@Component
struct CanvasExample {
private settings: RenderingContextSettings = new RenderingContextSettings(true)
private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
private path2Db: Path2D = new Path2D()
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Canvas(this.context)
.width('100%')
.height('100%')
.backgroundColor('#ffff00')
.onReady(() =>{
this.path2Db.rect(20, 20, 100, 100);this.context.stroke(this.path2Db)
})
}
.width('100%')
.height('100%')
}
}
```
