Class CPDFInkAnnotation

constructor

• new CPDFInkAnnotation(params: Partial<CPDFInkAnnotation>): CPDFInkAnnotation

  Parameters

  • params: Partial<CPDFInkAnnotation>

  Returns CPDFInkAnnotation

update

• update(
      updates: Partial<
          Pick<
              CPDFInkAnnotation,
              "title"
              | "content"
              | "color"
              | "alpha"
              | "borderWidth",
          >,
      >,
  ): this

  Update ink annotation properties with type safety

  Parameters

  • updates: Partial<
        Pick<
            CPDFInkAnnotation,
            "title"
            | "content"
            | "color"
            | "alpha"
            | "borderWidth",
        >,
    >

    Partial object containing properties to update

  Returns this

  this instance for chaining

  Example

  inkAnnotation.update({
    title: 'Updated Title',
    content: 'Updated content',
    color: '#FF0000',
    alpha: 200,
    borderWidth: 2,
  });
  await document.updateAnnotation(inkAnnotation);
  Copy

toJSON

• toJSON(): Omit<CPDFInkAnnotation, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      color: string;
      alpha: number;
      borderWidth: number;
      inkPath: number[][][] | undefined;
  }

  Returns Omit<CPDFInkAnnotation, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      color: string;
      alpha: number;
      borderWidth: number;
      inkPath: number[][][] | undefined;
  }

color

alpha

borderWidth

OptionalinkPath