Interface TextObjectType

interface TextObjectType {
    createCJKFont: (
        fontName: string,
        fontsize: number,
        doc: DocType,
    ) => Promise<null | PDFFontType>;
    destroy: () => Promise<void>;
    getCharCount: () => Promise<number>;
    getCharInfo: (index: number) => Promise<CharInfo>;
    getCharRect: (index: number) => Promise<null | Rect>;
    getFont: () => Promise<null | PDFFontType>;
    getFontSize: () => Promise<number>;
    getIndex: () => Promise<number>;
    getItemCount: () => Promise<number>;
    getPosX: () => Promise<number>;
    getPosY: () => Promise<number>;
    getTextMatrix: () => Promise<Matrix>;
    options?: Options;
    reCalcPositionData: () => Promise<void>;
    setCJKText: (text: string, font: PDFFontType) => Promise<void>;
    setColorState: (state: ColorStateType) => Promise<void>;
    setEmpty: () => Promise<void>;
    setIndex: (index: number) => Promise<void>;
    setPosition: (x: number, y: number) => Promise<void>;
    setText: (text: string) => Promise<void>;
    setTextState: (textState: TextStateType) => Promise<void>;
    transform: (matrix: Matrix) => Promise<void>;
}

Implemented by

Properties

createCJKFont destroy getCharCount getCharInfo getCharRect getFont getFontSize getIndex getItemCount getPosX getPosY getTextMatrix options? reCalcPositionData setCJKText setColorState setEmpty setIndex setPosition setText setTextState transform

Properties

createCJKFont

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

为文本对象创建一个 CJK 字体。

Type declaration

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

    • Parameters

      • fontName: string

        要创建的字体名称。

      • fontsize: number

        要创建的字体大小。

      • doc: DocType

        用于创建字体的文档对象。

      Returns Promise<null | PDFFontType>

      返回创建的 PDFFont 对象。

Example

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

destroy

destroy: () => Promise<void>

销毁 TextObject 实例。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getCharCount

getCharCount: () => Promise<number>

获取文本对象中的字符数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回文本对象中的字符数量。

getCharInfo

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

获取指定字符的信息。

Type declaration

    • (index: number): Promise<CharInfo>

    • Parameters

      • index: number

        指定文本对象中从零开始的字符索引。

      Returns Promise<CharInfo>

      返回指定字符的信息。

getCharRect

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

获取指定字符的矩形区域。

Type declaration

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

    • Parameters

      • index: number

        指定文本对象中从零开始的字符索引。

      Returns Promise<null | Rect>

      返回指定字符的矩形区域。

getFont

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

获取当前文本对象的字体。

Type declaration

getFontSize

getFontSize: () => Promise<number>

获取当前文本对象的字体大小。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回当前文本对象的字体大小。

getIndex

getIndex: () => Promise<number>

获取文本对象的索引。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回文本对象的索引。

getItemCount

getItemCount: () => Promise<number>

获取文本对象项的数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回文本对象项的数量。

getPosX

getPosX: () => Promise<number>

获取设备空间中原点的 x 坐标。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回设备空间中原点的 x 坐标。

getPosY

getPosY: () => Promise<number>

获取设备空间中原点的 y 坐标。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回设备空间中原点的 y 坐标。

getTextMatrix

getTextMatrix: () => Promise<Matrix>

获取当前对象的文本矩阵。

Type declaration

    • (): Promise<Matrix>

    • Returns Promise<Matrix>

      返回当前对象的文本矩阵。

Optionaloptions

options?: Options

reCalcPositionData

reCalcPositionData: () => Promise<void>

重新计算文本对象的位置数据。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

setCJKText

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

为文本对象设置 CJK 文本。

Type declaration

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

    • Parameters

      • text: string

        要设置的文本。

      • font: PDFFontType

        要设置的字体。

      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);

setColorState

setColorState: (state: ColorStateType) => Promise<void>

设置文本对象的颜色状态。

Type declaration

setEmpty

setEmpty: () => Promise<void>

将文本对象设置为空。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

setIndex

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

设置文本对象的索引。

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        要设置的索引。

      Returns Promise<void>

setPosition

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

设置文本对象的位置。

Type declaration

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

    • Parameters

      • x: number

        x 坐标。

      • y: number

        y 坐标。

      Returns Promise<void>

Example

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

setText

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

设置文本对象的文本。

Type declaration

    • (text: string): Promise<void>

    • Parameters

      • text: string

        要设置的文本。

      Returns Promise<void>

Example

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

setTextState

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

设置文本对象的文本状态。

Type declaration

Example

let textObj = await TextObject.create();
let textState = await TextState.create();
await textState.setFontSize(25);
await textObject.setTextState(textState

transform

transform: (matrix: Matrix) => Promise<void>

使用指定的矩阵变换文本对象。

Type declaration

    • (matrix: Matrix): Promise<void>

    • Parameters

      • matrix: Matrix

        用于变换的矩阵。

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties