Class TextState

constructor

• new TextState(options?: Options): TextState

  创建一个 TextState 实例。 请使用 create 方法来创建实例，而不是通过 new 关键字创建。

  Parameters

  • Optionaloptions: Options

    使用指定的配置项创建一个 TextState 实例。

  Returns TextState

  Example

  let textState = await TextState.create();
  Copy

options

destroy

• destroy(): Promise<void>

  销毁 TextState 对象。

  Returns Promise<void>

getBaselineAngle

• getBaselineAngle(): Promise<number>

  获取设备空间 X 轴与文本基线之间的角度（弧度）。

  Returns Promise<number>

  返回设备空间 X 轴与文本基线之间的角度。

getCharSpace

• getCharSpace(): Promise<number>

  获取字符间距。

  Returns Promise<number>

  返回字符间距。

getFont

• getFont(): Promise<null | PDFFontType>

  获取文本状态的字体。

  Returns Promise<null | PDFFontType>

  返回文本状态的字体。

getFontSize

• getFontSize(): Promise<number>

  获取文本状态的字体大小。

  Returns Promise<number>

  返回文本状态的字体大小。

getFontSizeH

• getFontSizeH(): Promise<number>

  获取设备单位中的水平尺寸。

  Returns Promise<number>

  返回设备单位中的水平尺寸。

getFontSizeV

• getFontSizeV(): Promise<number>

  获取设备单位中的垂直尺寸。

  Returns Promise<number>

  返回设备单位中的垂直尺寸。

getShearAngle

• getShearAngle(): Promise<number>

  获取文本空间 Y 轴在设备空间中的倾斜角度（单位：弧度）。

  Returns Promise<number>

  返回文本空间 Y 轴在设备空间中的倾斜角度。

getTextMode

• getTextMode(): Promise<number>

  获取文本模式。

  Returns Promise<number>

  返回文本模式。

getWordSpace

• getWordSpace(): Promise<number>

  获取字间距。

  Returns Promise<number>

  返回字间距。

isNull

• isNull(): Promise<boolean>

  检查文本状态是否为 null。

  Returns Promise<boolean>

  如果文本状态为 null 则返回 true，否则返回 false。

setCharSpace

• setCharSpace(charSpace: number): Promise<void>

  设置字符间距。

  Parameters

  • charSpace: number

    字符间距值，用于设置文本中的字符间距。

  Returns Promise<void>

setFont

• setFont(font: PDFFontType): Promise<void>

  设置文本状态的字体。

  Parameters

  • font: PDFFontType

    字体对象。

  Returns Promise<void>

  Example

  let doc = await app.getActiveDoc();
  let font = await doc.addStandardFont('Times-Bold');
  await textState.setFont(font);
  Copy

setFontSize

• setFontSize(fontSize: number): Promise<void>

  设置文本状态的字体大小。

  Parameters

  • fontSize: number

    字体大小（像素）。

  Returns Promise<void>

setTextMode

• setTextMode(textMode: number): Promise<void>

  设置文本模式。

  Parameters

  • textMode: number

    文本模式的值，用于设置文本渲染模式。例如：
    

    • 0 填充文本。
      
    • 1 描边文本。
      
    • 2 先填充再描边文本。
      
    • 3 不填充也不描边文本（不可见）。

  Returns Promise<void>

setWordSpace

• setWordSpace(wordSpace: number): Promise<void>

  设置单词间距。

  Parameters

  • wordSpace: number

    单词间距值，用于设置文本中的单词间距。

  Returns Promise<void>

Staticcreate

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

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

  Parameters

  • Optionaloptions: Options

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

  Returns Promise<TextStateType>

  返回一个 TextState 实例。

  Example

  let textState = await TextState.create();
  Copy