Class PathObjectUtils

Implements

PathObjectUtilsType

Index

Constructors

Properties

Methods

getLineCap getLineJoin getLineWidth getMiterLimit setLineCap setLineJoin setLineWidth setMiterLimit create

Constructors

constructor

new PathObjectUtils(options?: Options): PathObjectUtils
创建一个 PathObjectUtils 实例。请使用 create 来创建实例，而不是通过 new 模式创建。
Parameters
- Optionaloptions: Options
  使用指定的选项创建一个 PathObjectUtils 实例。
Returns PathObjectUtils
Example
```
const pathObjectUtils = await PathObjectUtils.create();
```

Properties

`Optional`options

options?: Options

Methods

getLineCap

getLineCap(utils: GraphicObjectUtilsType): Promise<FPD_LineCap>
获取当前路径对象的线端样式。
Parameters
- utils: GraphicObjectUtilsType
  图形对象工具实例。
Returns Promise<FPD_LineCap>
一个解析为线端样式的 Promise。

Implementation of PathObjectUtilsType.getLineCap

getLineJoin

getLineJoin(utils: GraphicObjectUtilsType): Promise<FPD_LineJoin>
获取当前路径对象的线连接样式。
Parameters
- utils: GraphicObjectUtilsType
Returns Promise<FPD_LineJoin>
一个解析为线连接样式的 Promise。

Implementation of PathObjectUtilsType.getLineJoin

getLineWidth

getLineWidth(utils: GraphicObjectUtilsType): Promise<number>
获取当前路径对象的线宽。
Parameters
- utils: GraphicObjectUtilsType
  图形对象工具实例。
Returns Promise<number>
一个解析为线宽的 Promise。

Implementation of PathObjectUtilsType.getLineWidth

getMiterLimit

getMiterLimit(utils: GraphicObjectUtilsType): Promise<number>
获取当前路径对象的斜接限制（miter limit）。
Parameters
- utils: GraphicObjectUtilsType
  图形对象工具实例。
Returns Promise<number>
一个解析为斜接限制值的 Promise。

Implementation of PathObjectUtilsType.getMiterLimit

setLineCap

setLineCap(utils: GraphicObjectUtilsType, cap: FPD_LineCap): Promise<boolean>
设置当前路径对象的线端样式。
Parameters
- utils: GraphicObjectUtilsType
  图形对象工具实例。
- cap: FPD_LineCap
  要设置的线端样式。
Returns Promise<boolean>
一个 Promise，成功时返回 true，失败时返回 false。

Implementation of PathObjectUtilsType.setLineCap

setLineJoin

setLineJoin(utils: GraphicObjectUtilsType, join: FPD_LineJoin): Promise<boolean>
设置当前路径对象的线条连接方式。
Parameters
- utils: GraphicObjectUtilsType
  图形对象工具实例。
- join: FPD_LineJoin
  要设置的线条连接方式。
Returns Promise<boolean>
一个 Promise，成功时解析为 true，否则为 false。

Implementation of PathObjectUtilsType.setLineJoin

setLineWidth

setLineWidth(utils: GraphicObjectUtilsType, lineWidth: number): Promise<boolean>
设置当前路径对象的线宽。
Parameters
- utils: GraphicObjectUtilsType
  图形对象工具实例。
- lineWidth: number
  要设置的线宽。
Returns Promise<boolean>
一个 Promise，成功时返回 true，否则返回 false。

Implementation of PathObjectUtilsType.setLineWidth

setMiterLimit

setMiterLimit(
utils: GraphicObjectUtilsType,
miterLimit: number,
): Promise<boolean>
设置当前路径对象的斜接限制（miter limit）。
Parameters
- utils: GraphicObjectUtilsType
  图形对象工具实例。
- miterLimit: number
  要设置的斜接限制值。
Returns Promise<boolean>
一个 Promise，如果成功则解析为 true，否则为 false。

Implementation of PathObjectUtilsType.setMiterLimit

`Static`create

create(options?: Options): Promise<PathObjectUtilsType>
创建一个 PathObjectUtils 实例。
Parameters
- Optionaloptions: Options
  使用指定的选项创建一个 PathObjectUtils 实例。
Returns Promise<PathObjectUtilsType>
Example
```
const pathObjectUtils = await PathObjectUtils.create();
```