Class PathObjectUtils

Implements

PathObjectUtilsType

Index

Constructors

Properties

Methods

getLineCap getLineJoin getLineWidth getMiterLimit setLineCap setLineJoin setLineWidth setMiterLimit create

Constructors

constructor

new PathObjectUtils(options?: Options): PathObjectUtils
Create a PathObjectUtils instance. Instead of creating an instance in new mode, use create to create an instance.
Parameters
- Optionaloptions: Options
  Create a PathObjectUtils instance with the specified options.
Returns PathObjectUtils
Example
```
const pathObjectUtils = await PathObjectUtils.create();
```

Properties

`Optional`options

options?: Options

Methods

getLineCap

getLineCap(utils: GraphicObjectUtilsType): Promise<FPD_LineCap>
Get the line cap of the current path object.
Parameters
- utils: GraphicObjectUtilsType
  The graphic object utils instance.
Returns Promise<FPD_LineCap>
A promise that resolves to the line cap.

Implementation of PathObjectUtilsType.getLineCap

getLineJoin

getLineJoin(utils: GraphicObjectUtilsType): Promise<FPD_LineJoin>
Get the line join of the current path object.
Parameters
- utils: GraphicObjectUtilsType
Returns Promise<FPD_LineJoin>
A promise that resolves to the line join.

Implementation of PathObjectUtilsType.getLineJoin

getLineWidth

getLineWidth(utils: GraphicObjectUtilsType): Promise<number>
Get the line width of the current path object.
Parameters
- utils: GraphicObjectUtilsType
  The graphic object utils instance.
Returns Promise<number>
A promise that resolves to the line width.

Implementation of PathObjectUtilsType.getLineWidth

getMiterLimit

getMiterLimit(utils: GraphicObjectUtilsType): Promise<number>
Get the miter limit of the current path object.
Parameters
- utils: GraphicObjectUtilsType
  The graphic object utils instance.
Returns Promise<number>
A promise that resolves to the miter limit.

Implementation of PathObjectUtilsType.getMiterLimit

setLineCap

setLineCap(utils: GraphicObjectUtilsType, cap: FPD_LineCap): Promise<boolean>
Set the line cap of the current path object.
Parameters
- utils: GraphicObjectUtilsType
  The graphic object utils instance.
- cap: FPD_LineCap
  The line cap to set.
Returns Promise<boolean>
A promise that resolves to true if successful, false otherwise.

Implementation of PathObjectUtilsType.setLineCap

setLineJoin

setLineJoin(utils: GraphicObjectUtilsType, join: FPD_LineJoin): Promise<boolean>
Set the line join of the current path object.
Parameters
- utils: GraphicObjectUtilsType
  The graphic object utils instance.
- join: FPD_LineJoin
  The line join to set.
Returns Promise<boolean>
A promise that resolves to true if successful, false otherwise.

Implementation of PathObjectUtilsType.setLineJoin

setLineWidth

setLineWidth(utils: GraphicObjectUtilsType, lineWidth: number): Promise<boolean>
Set the line width of the current path object.
Parameters
- utils: GraphicObjectUtilsType
  The graphic object utils instance.
- lineWidth: number
  The line width to set.
Returns Promise<boolean>
A promise that resolves to true if successful, false otherwise.

Implementation of PathObjectUtilsType.setLineWidth

setMiterLimit

setMiterLimit(
utils: GraphicObjectUtilsType,
miterLimit: number,
): Promise<boolean>
Set the miter limit of the current path object.
Parameters
- utils: GraphicObjectUtilsType
  The graphic object utils instance.
- miterLimit: number
  The miter limit to set.
Returns Promise<boolean>
A promise that resolves to true if successful, false otherwise.

Implementation of PathObjectUtilsType.setMiterLimit

`Static`create

create(options?: Options): Promise<PathObjectUtilsType>
Create a PathObjectUtils instance.
Parameters
- Optionaloptions: Options
  Create a PathObjectUtils instance with the specified options.
Returns Promise<PathObjectUtilsType>
Example
```
const pathObjectUtils = await PathObjectUtils.create();
```