Class TextObjectUtils

constructor

• new TextObjectUtils(options?: Options): TextObjectUtils

  Create a TextObjectUtils instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a TextObjectUtils instance with the specified options.

  Returns TextObjectUtils

  Example

  const pdfArr = await TextObjectUtils.create();
  Copy

options

canMergeText

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

  can merge text

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<number>

  The char space.

getFillInfo

• getFillInfo(graphicObjectUtils: GraphicObjectUtilsType): Promise<FillInfoType>

  get fill info

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<FillInfoType>

  The fill info.

getFont

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

  get font

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<number>

  The font size.

getHorizontalScale

• getHorizontalScale(graphicObjectUtils: GraphicObjectUtilsType): Promise<number>

  get horizontal scale

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<number>

  The horizontal scale.

getLineWidth

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

  get line width

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<number>

  The line width.

getStrokeInfo

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

  get stroke info

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<StrokeInfoType>

  The stroke info.

getTextColorInfo

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

  get text color info

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<TextColorInfoType>

  The text color info.

getTextMode

• getTextMode(graphicObjectUtils: GraphicObjectUtilsType): Promise<FPD_TextMode>

  get text mode

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<FPD_TextMode>

  A promise that resolves to the text mode.

getWordSpace

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

  get word space

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<number>

  The word space.

isFontBold

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

  get font bold info

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<FPD_ValidFlag>

  A promise that resolves to a valid flag indicating whether the word space is valid.

mergeText

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

  merge text

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.

  Returns Promise<boolean>

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

setCharSpace

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

  set char space

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType
  • charSpace: number

    The char space to set.

  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

  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

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType
  • fontSize: number

    The font size to set.

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType
  • horizonScale: number

    The horizontal scale to set.

  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

  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

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType

    The graphic object utilities to use.
  • mode: FPD_TextMode

    The text mode to set.

  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

  Parameters

  • graphicObjectUtils: GraphicObjectUtilsType
  • wordSpace: number

    The word space to set.

  Returns Promise<boolean>

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

Staticcreate

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

  Creates a TextObjectUtils instance.

  Parameters

  • Optionaloptions: Options

    The configuration options required for creation, containing necessary initialization information.

  Returns Promise<TextObjectUtils>

  A promise that resolves to a TextObjectUtils instance.