Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FreeText

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new FreeText(fxAnnot: fxAnnot): FreeText

  • Parameters

    • fxAnnot: fxAnnot

    Returns FreeText

Methods

destroy

  • destroy(): Promise<boolean>

  • Delete the annot of the page

    see

    Annot

    Returns Promise<boolean>

    bool is true of false

getAlignment

  • getAlignment(): Promise<number>

  • Get the alignment information of Free Text contents.

    see

    Alignment

    Returns Promise<number>

    number

getAnnot

getCalloutLineEndingStyle

  • getCalloutLineEndingStyle(): Promise<number>

  • Get Annotation's calloutLineEndingStyle. Only support: Callout annot.

    see

    EndingStyle

    Returns Promise<number>

    EndingStyle

getCalloutLinePoints

  • getCalloutLinePoints(): Promise<Point[]>

  • Get Annotation's calloutLinepoints. Only support: Callout annot.

    Returns Promise<Point[]>

getFillColor

  • getFillColor(): Promise<number>

  • Get free text's fill color. An interge indecated fill color.

    see

    setFillColor

    Returns Promise<number>

    number. such as 0xff0000, 16711680

getPadding

  • getPadding(): Promise<number>

  • Gets the distance from annot's border to its inner border.

    Returns Promise<number>

getProps

  • Export the current annotation to a Json object.

    see

    Annot

    Returns Promise<AnnotOptions>

    • A json object of annotation's property. The key and value formats try to follow XFDF specifications

setAlignment

  • setAlignment(alignment: Alignment): Promise<void>

  • Controls the alignment of Free Text contents.

    Parameters

    Returns Promise<void>

    void

setCalloutLineEndingStyle

  • setCalloutLineEndingStyle(style: EndingStyle): Promise<void>

  • Set Annotation's calloutLineEndingStyle . Only support: Callout annot.

    see

    EndingStyle

    Parameters

    Returns Promise<void>

setCalloutLinePoints

  • setCalloutLinePoints(points: Point[]): Promise<void>

  • Set Annotation's calloutLinepoints. Only support: Callout annot.

    Parameters

    • points: Point[]

    Returns Promise<void>

    void

setFillColor

  • setFillColor(color: any): Promise<boolean>

  • Set free text's fill color.

    Parameters

    • color: any

      An interge indecated fill color (alpha is not supported). Supported color format
      0 or ['T'] for transparent
      number, such as 0xff0000, 16711680
      PDF color array, such as ['RGB',1,1,1] which means white.
      HTML color format, such as '#ff0000', 'rgb(255,0,0)', 'rgba(255,0,0,1)'

    Returns Promise<boolean>

    boolean

setProps

  • Set the properties of annot

    see

    Annot

    Parameters

    Returns Promise<void>

    underfined