Class TextState

constructor

• new TextState(options?: Options): TextState

  Creates an instance of TextState. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a TextState instance with the specified options.

  Returns TextState

  Example

  let textState = await TextState.create();
  Copy

options

destroy

• destroy(): Promise<void>

  Destroy the TextState object.

  Returns Promise<void>

getBaselineAngle

• getBaselineAngle(): Promise<number>

  Get the angle between device space X-axis and text baseline. In radians.

  Returns Promise<number>

  Returns the angle between device space X-axis and text baseline.

getCharSpace

• getCharSpace(): Promise<number>

  Get the character space.

  Returns Promise<number>

  Returns the character space.

getFont

• getFont(): Promise<null | PDFFontType>

  Get the font of the text state.

  Returns Promise<null | PDFFontType>

  Returns the font of the text state.

getFontSize

• getFontSize(): Promise<number>

  Get the font size of the text state.

  Returns Promise<number>

  Returns the font size of the text state.

getFontSizeH

• getFontSizeH(): Promise<number>

  Get the horizontal size in device units.

  Returns Promise<number>

  Returns the horizontal size in device units.

getFontSizeV

• getFontSizeV(): Promise<number>

  Get the vertical size in device units.

  Returns Promise<number>

  Returns the vertical size in device units.

getShearAngle

• getShearAngle(): Promise<number>

  Get the angle that text space Y-axis shears in device space. In radians.

  Returns Promise<number>

  Returns the angle that text space Y-axis shears in device space.

getTextMode

• getTextMode(): Promise<number>

  Get the text mode.

  Returns Promise<number>

  Returns the text mode.

getWordSpace

• getWordSpace(): Promise<number>

  Get the word space.

  Returns Promise<number>

  Returns the word space.

isNull

• isNull(): Promise<boolean>

  Check whether the text state is null.

  Returns Promise<boolean>

  Returns true if the text state is null, otherwise false.

setCharSpace

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

  Set the character space.

  Parameters

  • charSpace: number

    The character space value, used to set the character spacing in text.

  Returns Promise<void>

setFont

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

  Set the font of the text state.

  Parameters

  • font: PDFFontType

    The font object.

  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>

  Set the font size of the text state.

  Parameters

  • fontSize: number

    The font size in pixels.

  Returns Promise<void>

setTextMode

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

  Set the text mode.

  Parameters

  • textMode: number

    The text mode value, used to set the text rendering mode.Like:
    

    • 0 Fill text.
      
    • 1 Stroke text.
      
    • 2 Fill, then stroke text.
      
    • 3 Neither fill nor stroke text(invisible).

  Returns Promise<void>

setWordSpace

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

  Set the word space.

  Parameters

  • wordSpace: number

    The word space value, used to set the word spacing in text.

  Returns Promise<void>

Staticcreate

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

  Create a TextState instance with the specified options.

  Parameters

  • Optionaloptions: Options

    Create a TextState instance with the specified options.

  Returns Promise<TextStateType>

  Returns a TextState instance.

  Example

  let textState = await TextState.create();
  Copy