Class TextObject

constructor

• new TextObject(options?: Options): TextObject

  Create a TextObject instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a TextObject instance with the specified options.

  Returns TextObject

  Example

  const pdfArr = await TextObject.create();
  Copy

options

createCJKFont

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

  Create a CJK font for the text object.

  Parameters

  • fontName: string

    The font name to create.
  • fontSize: number
  • doc: DocType

    The document object to create the font.

  Returns Promise<null | PDFFontType>

  Return the created PDFFont object.

  Example

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

destroy

• destroy(): Promise<void>

  Destroy the TextObject instance.

  Returns Promise<void>

getCharCount

• getCharCount(): Promise<number>

  Get the count of characters in the text object.

  Returns Promise<number>

  Return the count of characters in the text object.

getCharInfo

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

  Get the information of specified character.

  Parameters

  • index: number

    Specify zero-based character index in the text object.

  Returns Promise<CharInfo>

  Return the information of specified character.

getCharRect

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

  Get the rect of specified character.

  Parameters

  • index: number

    Specify zero-based character index in the text object.

  Returns Promise<null | Rect>

  Return the rect of specified character.

getFont

• getFont(): Promise<null | PDFFontType>

  Get the font of the current text object.

  Returns Promise<null | PDFFontType>

  Return the font of the current text object.

getFontSize

• getFontSize(): Promise<number>

  Get the font size of the current text object.

  Returns Promise<number>

  Return the font size of the current text object.

getIndex

• getIndex(): Promise<number>

  Get the index of the text object.

  Returns Promise<number>

  Return the index of the text object.

getItemCount

• getItemCount(): Promise<number>

  Get the count of text object items.

  Returns Promise<number>

  Return the count of text object items.

getPosX

• getPosX(): Promise<number>

  Get the x-coordinate of the origin in the device space.

  Returns Promise<number>

  Return the x-coordinate of the origin in the device space.

getPosY

• getPosY(): Promise<number>

  Get the y-coordinate of the origin in the device space.

  Returns Promise<number>

  Return the y-coordinate of the origin in the device space.

getTextMatrix

• getTextMatrix(): Promise<Matrix>

  Get the text matrix of the current object.

  Returns Promise<Matrix>

  Return the text matrix of the current object.

reCalcPositionData

• reCalcPositionData(): Promise<void>

  Recalculate the position data of the text object.

  Returns Promise<void>

setCJKText

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

  Set the CJK text for the text object.

  Parameters

  • text: string

    The text to set.
  • font: PDFFontType

    The font to set.

  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>

  Set the color state of the text object.

  Parameters

  • state: ColorStateType

    The color state to set.

  Returns Promise<void>

setEmpty

• setEmpty(): Promise<void>

  Set the text object to empty.

  Returns Promise<void>

setIndex

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

  Set the index of the text object.

  Parameters

  • index: number

    The index to set.

  Returns Promise<void>

setPosition

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

  Set the position of the text object.

  Parameters

  • x: number

    The x-coordinate.
  • y: number

    The y-coordinate.

  Returns Promise<void>

  Example

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

setText

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

  Set the text of the text object.

  Parameters

  • text: string

    The text to set.

  Returns Promise<void>

  Example

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

setTextState

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

  Set the text state of the text object.

  Parameters

  • textState: TextStateType

    The text state to set.

  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>

  Transform the text object by the specified matrix.

  Parameters

  • matrix: Matrix

    The matrix to transform.

  Returns Promise<void>

Staticcreate

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

  Create a TextObject instance.

  Parameters

  • Optionaloptions: Options

    Create a TextObject instance with the specified options.

  Returns Promise<TextObjectType>

  Return a TextObject instance.

  Example

  const pdfArr = await TextObject.create();
  Copy