Interface TextStateType

interface TextStateType {
    destroy: () => Promise<void>;
    getBaselineAngle: () => Promise<number>;
    getCharSpace: () => Promise<number>;
    getFont: () => Promise<null | PDFFontType>;
    getFontSize: () => Promise<number>;
    getFontSizeH: () => Promise<number>;
    getFontSizeV: () => Promise<number>;
    getShearAngle: () => Promise<number>;
    getTextMode: () => Promise<number>;
    getWordSpace: () => Promise<number>;
    isNull: () => Promise<boolean>;
    options: Options;
    setCharSpace: (charSpace: number) => Promise<void>;
    setFont: (font: PDFFontType) => Promise<void>;
    setFontSize: (fontSize: number) => Promise<void>;
    setTextMode: (textMode: number) => Promise<void>;
    setWordSpace: (wordSpace: number) => Promise<void>;
}

Implemented by

Properties

destroy getBaselineAngle getCharSpace getFont getFontSize getFontSizeH getFontSizeV getShearAngle getTextMode getWordSpace isNull options setCharSpace setFont setFontSize setTextMode setWordSpace

Properties

destroy

destroy: () => Promise<void>

Destroy the TextState object.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getBaselineAngle

getBaselineAngle: () => Promise<number>

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

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

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

getCharSpace

getCharSpace: () => Promise<number>

Get the character space.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      Returns the character space.

getFont

getFont: () => Promise<null | PDFFontType>

Get the font of the text state.

Type declaration

getFontSize

getFontSize: () => Promise<number>

Get the font size of the text state.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      Returns the font size of the text state.

getFontSizeH

getFontSizeH: () => Promise<number>

Get the horizontal size in device units.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      Returns the horizontal size in device units.

getFontSizeV

getFontSizeV: () => Promise<number>

Get the vertical size in device units.

Type declaration

    • (): Promise<number>

    • 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.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

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

getTextMode

getTextMode: () => Promise<number>

Get the text mode.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      Returns the text mode.

getWordSpace

getWordSpace: () => Promise<number>

Get the word space.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      Returns the word space.

isNull

isNull: () => Promise<boolean>

Check whether the text state is null.

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

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

options

options: Options

setCharSpace

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

Set the character space.

Type declaration

    • (charSpace: number): Promise<void>

    • 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.

Type declaration

Example

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

setFontSize

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

Set the font size of the text state.

Type declaration

    • (fontSize: number): Promise<void>

    • Parameters

      • fontSize: number

        The font size in pixels.

      Returns Promise<void>

setTextMode

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

Set the text mode.

Type declaration

    • (textMode: number): Promise<void>

    • 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.

Type declaration

    • (wordSpace: number): Promise<void>

    • Parameters

      • wordSpace: number

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

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties