Class TextObject

constructor

• new TextObject(options?: Options): TextObject

  创建一个 TextObject 实例。 请使用 create 来创建实例，而不是通过 new 模式创建实例。

  Parameters

  • Optionaloptions: Options

    使用指定的选项创建一个 TextObject 实例。

  Returns TextObject

  Example

  const pdfArr = await TextObject.create();
  Copy

options

createCJKFont

• createCJKFont(
      fontName: string,
      fontSize: number,
      doc: DocType,
  ): Promise<null | PDFFontType>

  为文本对象创建一个 CJK 字体。

  Parameters

  • fontName: string

    要创建的字体名称。
  • fontSize: number
  • doc: DocType

    用于创建字体的文档对象。

  Returns Promise<null | PDFFontType>

  返回创建的 PDFFont 对象。

  Example

  let doc = await app.getActiveDoc();
  let textObj = await TextObject.create();
  let font = await textObject.createCJKFont('SimSun', 12, doc);
  Copy

destroy

• destroy(): Promise<void>

  销毁 TextObject 实例。

  Returns Promise<void>

getCharCount

• getCharCount(): Promise<number>

  获取文本对象中的字符数量。

  Returns Promise<number>

  返回文本对象中的字符数量。

getCharInfo

• getCharInfo(index: number): Promise<CharInfo>

  获取指定字符的信息。

  Parameters

  • index: number

    指定文本对象中从零开始的字符索引。

  Returns Promise<CharInfo>

  返回指定字符的信息。

getCharRect

• getCharRect(index: number): Promise<null | Rect>

  获取指定字符的矩形区域。

  Parameters

  • index: number

    指定文本对象中从零开始的字符索引。

  Returns Promise<null | Rect>

  返回指定字符的矩形区域。

getFont

• getFont(): Promise<null | PDFFontType>

  获取当前文本对象的字体。

  Returns Promise<null | PDFFontType>

  返回当前文本对象的字体。

getFontSize

• getFontSize(): Promise<number>

  获取当前文本对象的字体大小。

  Returns Promise<number>

  返回当前文本对象的字体大小。

getIndex

• getIndex(): Promise<number>

  获取文本对象的索引。

  Returns Promise<number>

  返回文本对象的索引。

getItemCount

• getItemCount(): Promise<number>

  获取文本对象项的数量。

  Returns Promise<number>

  返回文本对象项的数量。

getPosX

• getPosX(): Promise<number>

  获取设备空间中原点的 x 坐标。

  Returns Promise<number>

  返回设备空间中原点的 x 坐标。

getPosY

• getPosY(): Promise<number>

  获取设备空间中原点的 y 坐标。

  Returns Promise<number>

  返回设备空间中原点的 y 坐标。

getTextMatrix

• getTextMatrix(): Promise<Matrix>

  获取当前对象的文本矩阵。

  Returns Promise<Matrix>

  返回当前对象的文本矩阵。

reCalcPositionData

• reCalcPositionData(): Promise<void>

  重新计算文本对象的位置数据。

  Returns Promise<void>

setCJKText

• setCJKText(text: string, font: PDFFontType): Promise<void>

  为文本对象设置 CJK 文本。

  Parameters

  • text: string

    要设置的文本。
  • font: PDFFontType

    要设置的字体。

  Returns Promise<void>

  Example

  let doc = await app.getActiveDoc();
  let textObj = await TextObject.create();
  let font = await textObject.createCJKFont('SimSun', 12, doc);
  await textObj.setCJKText('你好，欢迎来到PDF世界！', font);
  Copy

setColorState

• setColorState(state: ColorStateType): Promise<void>

  设置文本对象的颜色状态。

  Parameters

  • state: ColorStateType

    要设置的颜色状态。

  Returns Promise<void>

setEmpty

• setEmpty(): Promise<void>

  将文本对象设置为空。

  Returns Promise<void>

setIndex

• setIndex(index: number): Promise<void>

  设置文本对象的索引。

  Parameters

  • index: number

    要设置的索引。

  Returns Promise<void>

setPosition

• setPosition(x: number, y: number): Promise<void>

  设置文本对象的位置。

  Parameters

  • x: number

    x 坐标。
  • y: number

    y 坐标。

  Returns Promise<void>

  Example

  let textObj = await TextObject.create();
  await textObject.setPosition(100, 100);
  Copy

setText

• setText(text: string): Promise<void>

  设置文本对象的文本内容。

  Parameters

  • text: string

    要设置的文本。

  Returns Promise<void>

  Example

  let textObj = await TextObject.create();
  await textObject.setText('Hello World!');
  Copy

setTextState

• setTextState(textState: TextStateType): Promise<void>

  设置文本对象的文本状态。

  Parameters

  • textState: TextStateType

    要设置的文本状态。

  Returns Promise<void>

  Example

  let textObj = await TextObject.create();
  let textState = await TextState.create();
  await textState.setFontSize(25);
  await textObject.setTextState(textState
  Copy

transform

• transform(matrix: Matrix): Promise<void>

  通过指定的矩阵变换文本对象。

  Parameters

  • matrix: Matrix

    用于变换的矩阵。

  Returns Promise<void>

Staticcreate

• create(options?: Options): Promise<TextObjectType>

  创建一个 TextObject 实例。

  Parameters

  • Optionaloptions: Options

    使用指定的选项创建一个 TextObject 实例。

  Returns Promise<TextObjectType>

  返回一个 TextObject 实例。

  Example

  const pdfArr = await TextObject.create();
  Copy