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>

获取字间距。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      返回字间距。

getBaselineAngle

getBaselineAngle: () => Promise<number>

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

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

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

getCharSpace

getCharSpace: () => Promise<number>

获取字符间距。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回字符间距。

getFont

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

获取文本状态的字体。

Type declaration

getFontSize

getFontSize: () => Promise<number>

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

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

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

getFontSizeH

getFontSizeH: () => Promise<number>

获取以设备单位表示的水平尺寸。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回以设备单位表示的水平尺寸。

getFontSizeV

getFontSizeV: () => Promise<number>

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

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

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

getShearAngle

getShearAngle: () => Promise<number>

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

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

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

getTextMode

getTextMode: () => Promise<number>

获取文本模式。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回文本模式。

getWordSpace

getWordSpace: () => Promise<number>

获取字间距。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回字间距。

isNull

isNull: () => Promise<boolean>

检查文本状态是否为 null。

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

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

options

options: Options

setCharSpace

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

设置字符间距。

Type declaration

    • (charSpace: number): Promise<void>

    • Parameters

      • charSpace: number

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

      Returns Promise<void>

setFont

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

设置文本状态的字体。

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>

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

Type declaration

    • (fontSize: number): Promise<void>

    • Parameters

      • fontSize: number

        字体大小（像素）。

      Returns Promise<void>

setTextMode

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

设置文本模式。

Type declaration

    • (textMode: number): Promise<void>

    • Parameters

      • textMode: number

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

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

      Returns Promise<void>

setWordSpace

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

设置单词间距。

Type declaration

    • (wordSpace: number): Promise<void>

    • Parameters

      • wordSpace: number

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

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties