Class CPDFFreeTextAnnotation

constructor

• new CPDFFreeTextAnnotation(
      params: Partial<CPDFFreeTextAnnotation>,
  ): CPDFFreeTextAnnotation

  Parameters

  • params: Partial<CPDFFreeTextAnnotation>

  Returns CPDFFreeTextAnnotation

update

• update(
      updates: Partial<
          Pick<
              CPDFFreeTextAnnotation,
              "title"
              | "content"
              | "alignment"
              | "textAttribute"
              | "alpha",
          >,
      >,
  ): this

  Update free text annotation properties with type safety

  Parameters

  • updates: Partial<
        Pick<
            CPDFFreeTextAnnotation,
            "title"
            | "content"
            | "alignment"
            | "textAttribute"
            | "alpha",
        >,
    >

    Partial object containing properties to update

  Returns this

  this instance for chaining

  Example

  freeTextAnnotation.update({
    title: 'Updated Title',
    content: 'Updated content',
    alignment: CPDFAlignment.CENTER,
    textAttribute: {
      fontSize: 14,
      fontFamily: 'Times',
      styleName: 'Bold',
      color: '#00FF00'
    },
    alpha: 200
  });
  await document.updateAnnotation(freeTextAnnotation);
  Copy

toJSON

• toJSON(): Omit<CPDFFreeTextAnnotation, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      alignment: CPDFAlignment;
      textAttribute: CPDFTextAttribute;
      alpha: number;
  }

  Returns Omit<CPDFFreeTextAnnotation, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      alignment: CPDFAlignment;
      textAttribute: CPDFTextAttribute;
      alpha: number;
  }

alignment

textAttribute

alpha