Class GraphicObjectUtils

Implements

GraphicObjectUtilsType

Index

Constructors

Properties

Constructors

constructor

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

Properties

`Optional`options

options?: Options

Methods

align

align(mode: FPD_AlignMode): Promise<void>
根据指定的对齐模式对图形对象进行对齐。
Parameters
- mode: FPD_AlignMode
  要使用的对齐模式。
Returns Promise<void>
在对齐操作完成时被解析的 Promise。

Implementation of GraphicObjectUtilsType.align

center

center(mode: FPD_CenterMode): Promise<void>
根据指定的居中模式对图形对象进行居中。
Parameters
- mode: FPD_CenterMode
  要使用的居中模式。
Returns Promise<void>
当居中操作完成时被解析的 Promise。

Implementation of GraphicObjectUtilsType.center

changeRenderingOrder

changeRenderingOrder(operation: FPD_RendingOrder): Promise<void>
更改图形对象的渲染顺序。
Parameters
- operation: FPD_RendingOrder
  要执行的操作（0 表示上移，1 表示下移）。
Returns Promise<void>
一个在渲染顺序更改完成时解析的 Promise。

Implementation of GraphicObjectUtilsType.changeRenderingOrder

copy

copy(): Promise<boolean>
复制图形对象。

Returns Promise<boolean>
一个 Promise，当复制操作成功时返回 true，失败时返回 false。

Implementation of GraphicObjectUtilsType.copy

cut

cut(): Promise<void>
剪切图形对象。

Returns Promise<void>
在剪切操作完成时解析的 Promise。

Implementation of GraphicObjectUtilsType.cut

delete

delete(): Promise<void>
删除图形对象。

Returns Promise<void>
一个在删除操作完成时被解析的 Promise。

Implementation of GraphicObjectUtilsType.delete

flip

flip(vertical?: boolean): Promise<void>
垂直或水平翻转图形对象。
Parameters
- vertical: boolean = false
  若为 true，则垂直翻转；若为 false，则水平翻转。
Returns Promise<void>
当翻转操作完成时 resolve 的 Promise。

Implementation of GraphicObjectUtilsType.flip

getHeight

getHeight(): Promise<number>
获取图形对象的高度

Returns Promise<number>
一个 Promise，解析为高度值，如果操作失败则为 -1。

Implementation of GraphicObjectUtilsType.getHeight

getOpacity

getOpacity(): Promise<number>
获取图形对象的不透明度

Returns Promise<number>
一个 Promise，解析为不透明度值；如果操作失败则为 Infinity。

Implementation of GraphicObjectUtilsType.getOpacity

getType

getType(): Promise<FPD_GraphicObjectUtilsType>
获取图形对象工具的类型。

Returns Promise<FPD_GraphicObjectUtilsType>
一个 Promise，解析为图形对象工具的类型。

Implementation of GraphicObjectUtilsType.getType

getWidth

getWidth(): Promise<number>
获取图形对象的宽度

Returns Promise<number>
一个 Promise，解析为宽度值；如果操作失败则为 -1。

Implementation of GraphicObjectUtilsType.getWidth

getXPosition

getXPosition(): Promise<boolean>
获取图形对象的 X 位置

Returns Promise<boolean>
一个 Promise，它解析为 X 位置的值，如果操作失败则为 false。

Implementation of GraphicObjectUtilsType.getXPosition

getYPosition

getYPosition(): Promise<boolean>
获取图形对象的 Y 位置

Returns Promise<boolean>
一个 Promise，解析为 Y 位置的值，如果操作失败则为 false。

Implementation of GraphicObjectUtilsType.getYPosition

move

move(destPage: PageType, docView: DocViewType, offset: Point): Promise<void>
将图形对象移动到指定的页面和位置。
Parameters
- destPage: PageType
  要将图形对象移动到的目标页面。
- docView: DocViewType
  执行移动操作时所使用的文档视图上下文。
- offset: Point
  要将图形对象移动到的偏移位置。
Returns Promise<void>
当移动操作完成时被解析的 Promise。

Implementation of GraphicObjectUtilsType.move

rotate

rotate(rotate: number): Promise<void>
按指定角度旋转图形对象。
Parameters
- rotate: number
  用于旋转图形对象的角度（单位为度）。
Returns Promise<void>
当旋转完成时解析的 Promise。

Implementation of GraphicObjectUtilsType.rotate

scale

scale(rect: Rect): Promise<void>
将图形对象缩放以适配指定的矩形区域。
Parameters
- rect: Rect
  要适配的矩形区域。
Returns Promise<void>
当缩放操作完成时会被解析的 Promise。

Implementation of GraphicObjectUtilsType.scale

setHeight

setHeight(height: number): Promise<boolean>
设置图形对象的高度。
Parameters
- height: number
  要设置的高度值。
Returns Promise<boolean>
一个 Promise，当操作成功时返回 true，失败时返回 false。

Implementation of GraphicObjectUtilsType.setHeight

setOpacity

setOpacity(opacity: number, undo?: boolean): Promise<boolean>
设置图形对象的不透明度。
Parameters
- opacity: number
  要设置的不透明度值（0-100）。
- undo: boolean = false
  是否允许撤销该操作。默认 false
Returns Promise<boolean>
一个 Promise，如果操作成功则返回 true，否则返回 false。

Implementation of GraphicObjectUtilsType.setOpacity

setWidth

setWidth(width: number): Promise<boolean>
设置图形对象的宽度。
Parameters
- width: number
  要设置的宽度值。
Returns Promise<boolean>
一个 Promise，当操作成功时返回 true，失败时返回 false。

Implementation of GraphicObjectUtilsType.setWidth

setXPosition

setXPosition(posX: number): Promise<boolean>
设置图形对象的 X 轴位置。
Parameters
- posX: number
  要设置的 X 轴位置值。
Returns Promise<boolean>
一个 Promise，当操作成功时返回 true，失败时返回 false。

Implementation of GraphicObjectUtilsType.setXPosition

setYPosition

setYPosition(posY: number): Promise<boolean>
设置图形对象的 Y 位置。
Parameters
- posY: number
  要设置的 Y 位置值。
Returns Promise<boolean>
一个 Promise，如果操作成功则解析为 true，失败则为 false。

Implementation of GraphicObjectUtilsType.setYPosition

shear

shear(angle: number): Promise<void>
按指定角度对图形对象进行错切变换。
Parameters
- angle: number
  用于对图形对象进行错切变换的角度（单位：度）。
Returns Promise<void>
当错切操作完成时解析的 Promise。

Implementation of GraphicObjectUtilsType.shear

size

size(mode: FPD_SizeMode): Promise<void>
根据指定的尺寸模式调整图形对象的大小。
Parameters
- mode: FPD_SizeMode
  要使用的尺寸模式。
Returns Promise<void>
当调整大小操作完成时解析的 Promise。

Implementation of GraphicObjectUtilsType.size

`Static`create

create(options?: Options): Promise<GraphicObjectUtils>
创建一个 GraphicObjectUtils 实例。
Parameters
- Optionaloptions: Options
  使用指定的选项创建一个 GraphicObjectUtils 实例。
Returns Promise<GraphicObjectUtils>
返回一个 GraphicObjectUtils 实例。