Interface TextObjectUtilsType

interface TextObjectUtilsType {
    canMergeText: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<boolean>;
    canSplitText: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<boolean>;
    canText2Path: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<boolean>;
    getCharSpace: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<number>;
    getFillInfo: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<FillInfoType>;
    getFont: (
        graphicObjectUtils: GraphicObjectUtilsType,
        isFullName: boolean,
    ) => Promise<string>;
    getFontSize: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<number>;
    getHorizontalScale: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<number>;
    getLineWidth: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<number>;
    getStrokeInfo: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<StrokeInfoType>;
    getTextColorInfo: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<TextColorInfoType>;
    getTextMode: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<FPD_TextMode>;
    getWordSpace: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<number>;
    isFontBold: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<boolean>;
    isFontItalic: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<boolean>;
    isWordSpaceValid: (
        graphicObjectUtils: GraphicObjectUtilsType,
    ) => Promise<FPD_ValidFlag>;
    mergeText: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<boolean>;
    options?: Options;
    setCharSpace: (
        graphicObjectUtils: GraphicObjectUtilsType,
        charSpace: number,
    ) => Promise<boolean>;
    setFillInfo: (
        graphicObjectUtils: GraphicObjectUtilsType,
        isFill: boolean,
        color: RGBColor,
        addUndo: boolean,
    ) => Promise<void>;
    setFont: (
        __namedParameters: {
            bold?: boolean;
            fontName: string;
            graphicObjectUtils: GraphicObjectUtilsType;
            italic?: boolean;
            opType: FPD_FONTOPERATION;
        },
    ) => Promise<boolean>;
    setFontSize: (
        graphicObjectUtils: GraphicObjectUtilsType,
        fontSize: number,
    ) => Promise<boolean>;
    setHorizontalScale: (
        graphicObjectUtils: GraphicObjectUtilsType,
        horizonScale: number,
    ) => Promise<boolean>;
    setLineWidth: (
        graphicObjectUtils: GraphicObjectUtilsType,
        lineWidth: number,
    ) => Promise<boolean>;
    setStrokeInfo: (
        graphicObjectUtils: GraphicObjectUtilsType,
        isStroke: boolean,
        color: RGBColor,
        addUndo: boolean,
    ) => Promise<void>;
    setTextMode: (
        graphicObjectUtils: GraphicObjectUtilsType,
        mode: FPD_TextMode,
    ) => Promise<boolean>;
    setWordSpace: (
        graphicObjectUtils: GraphicObjectUtilsType,
        wordSpace: number,
    ) => Promise<boolean>;
}

Implemented by

Properties

canMergeText canSplitText canText2Path getCharSpace getFillInfo getFont getFontSize getHorizontalScale getLineWidth getStrokeInfo getTextColorInfo getTextMode getWordSpace isFontBold isFontItalic isWordSpaceValid mergeText options? setCharSpace setFillInfo setFont setFontSize setHorizontalScale setLineWidth setStrokeInfo setTextMode setWordSpace

Properties

canMergeText

canMergeText: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<boolean>

can merge text

Type declaration

    • (graphicObjectUtils: GraphicObjectUtilsType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether text can be merged.

canSplitText

canSplitText: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<boolean>

can split text

Type declaration

    • (graphicObjectUtils: GraphicObjectUtilsType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the text can be split.

canText2Path

canText2Path: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<boolean>

can text to path

Type declaration

    • (graphicObjectUtils: GraphicObjectUtilsType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the text can be converted to a path.

getCharSpace

getCharSpace: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<number>

get char space

Type declaration

getFillInfo

getFillInfo: (
    graphicObjectUtils: GraphicObjectUtilsType,
) => Promise<FillInfoType>

get fill info

Type declaration

getFont

getFont: (
    graphicObjectUtils: GraphicObjectUtilsType,
    isFullName: boolean,
) => Promise<string>

get font

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          isFullName: boolean,
      ): Promise<string>

    • Parameters

      • graphicObjectUtils: GraphicObjectUtilsType

        The graphic object utilities to use.

      • isFullName: boolean

        Whether to get the full name of the font.

      Returns Promise<string>

      A promise that resolves to the name of the font.

getFontSize

getFontSize: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<number>

get font size

Type declaration

getHorizontalScale

getHorizontalScale: (
    graphicObjectUtils: GraphicObjectUtilsType,
) => Promise<number>

get horizontal scale

Type declaration

getLineWidth

getLineWidth: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<number>

get line width

Type declaration

getStrokeInfo

getStrokeInfo: (
    graphicObjectUtils: GraphicObjectUtilsType,
) => Promise<StrokeInfoType>

get stroke info

Type declaration

getTextColorInfo

getTextColorInfo: (
    graphicObjectUtils: GraphicObjectUtilsType,
) => Promise<TextColorInfoType>

get text color info

Type declaration

getTextMode

getTextMode: (
    graphicObjectUtils: GraphicObjectUtilsType,
) => Promise<FPD_TextMode>

get text mode

Type declaration

getWordSpace

getWordSpace: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<number>

get word space

Type declaration

isFontBold

isFontBold: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<boolean>

get font bold info

Type declaration

    • (graphicObjectUtils: GraphicObjectUtilsType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the font is bold.

isFontItalic

isFontItalic: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<boolean>

get font italic

Type declaration

    • (graphicObjectUtils: GraphicObjectUtilsType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the font is italic.

isWordSpaceValid

isWordSpaceValid: (
    graphicObjectUtils: GraphicObjectUtilsType,
) => Promise<FPD_ValidFlag>

is word space valid

Type declaration

mergeText

mergeText: (graphicObjectUtils: GraphicObjectUtilsType) => Promise<boolean>

merge text

Type declaration

    • (graphicObjectUtils: GraphicObjectUtilsType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether text was merged successfully.

Optionaloptions

options?: Options

setCharSpace

setCharSpace: (
    graphicObjectUtils: GraphicObjectUtilsType,
    charSpace: number,
) => Promise<boolean>

set char space

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          charSpace: number,
      ): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the char space was successfully set.

setFillInfo

setFillInfo: (
    graphicObjectUtils: GraphicObjectUtilsType,
    isFill: boolean,
    color: RGBColor,
    addUndo: boolean,
) => Promise<void>

set fill info

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          isFill: boolean,
          color: RGBColor,
          addUndo: boolean,
      ): Promise<void>

    • Parameters

      • graphicObjectUtils: GraphicObjectUtilsType

        The graphic object utilities to use.

      • isFill: boolean

        Whether to enable fill.

      • color: RGBColor

        The fill color.

      • addUndo: boolean

        Whether to add an undo step.

      Returns Promise<void>

      A promise that resolves when the fill info is set.

setFont

setFont: (
    __namedParameters: {
        bold?: boolean;
        fontName: string;
        graphicObjectUtils: GraphicObjectUtilsType;
        italic?: boolean;
        opType: FPD_FONTOPERATION;
    },
) => Promise<boolean>

set font

Type declaration

    • (
          __namedParameters: {
              bold?: boolean;
              fontName: string;
              graphicObjectUtils: GraphicObjectUtilsType;
              italic?: boolean;
              opType: FPD_FONTOPERATION;
          },
      ): Promise<boolean>

    • Parameters

      • __namedParameters: {
            bold?: boolean;
            fontName: string;
            graphicObjectUtils: GraphicObjectUtilsType;
            italic?: boolean;
            opType: FPD_FONTOPERATION;
        }

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the font was successfully set.

setFontSize

setFontSize: (
    graphicObjectUtils: GraphicObjectUtilsType,
    fontSize: number,
) => Promise<boolean>

set font size

Type declaration

    • (graphicObjectUtils: GraphicObjectUtilsType, fontSize: number): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the font size was successfully set.

setHorizontalScale

setHorizontalScale: (
    graphicObjectUtils: GraphicObjectUtilsType,
    horizonScale: number,
) => Promise<boolean>

set horizontal scale

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          horizonScale: number,
      ): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the horizontal scale was successfully set.

setLineWidth

setLineWidth: (
    graphicObjectUtils: GraphicObjectUtilsType,
    lineWidth: number,
) => Promise<boolean>

set line width

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          lineWidth: number,
      ): Promise<boolean>

    • Parameters

      • graphicObjectUtils: GraphicObjectUtilsType

        The graphic object utilities to use.

      • lineWidth: number

        The line width to set.

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the line width was successfully set.

setStrokeInfo

setStrokeInfo: (
    graphicObjectUtils: GraphicObjectUtilsType,
    isStroke: boolean,
    color: RGBColor,
    addUndo: boolean,
) => Promise<void>

set stroke info

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          isStroke: boolean,
          color: RGBColor,
          addUndo: boolean,
      ): Promise<void>

    • Parameters

      • graphicObjectUtils: GraphicObjectUtilsType

        The graphic object utilities to use.

      • isStroke: boolean

        Whether to enable stroke.

      • color: RGBColor

        The stroke color.

      • addUndo: boolean

        Whether to add an undo step.

      Returns Promise<void>

      A promise that resolves when the stroke info is set.

setTextMode

setTextMode: (
    graphicObjectUtils: GraphicObjectUtilsType,
    mode: FPD_TextMode,
) => Promise<boolean>

set text mode

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          mode: FPD_TextMode,
      ): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the text mode was successfully set.

setWordSpace

setWordSpace: (
    graphicObjectUtils: GraphicObjectUtilsType,
    wordSpace: number,
) => Promise<boolean>

set word space

Type declaration

    • (
          graphicObjectUtils: GraphicObjectUtilsType,
          wordSpace: number,
      ): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the word space was successfully set.

Settings

Member Visibility

On This Page

Properties