Class CPDFCircleAnnotation

StaticfromJson

• fromJson<T extends CPDFAnnotation>(
      this: new (params: Partial<T>) => T,
      json: any,
  ): T

  Type Parameters

  • T extends CPDFAnnotation

  Parameters

  • this: new (params: Partial<T>) => T
  • json: any

  Returns T

StaticfromJsonArray

• fromJsonArray<T extends CPDFAnnotation>(
      this: new (params: Partial<T>) => T,
      jsonArray: any[],
  ): T[]

  Type Parameters

  • T extends CPDFAnnotation

  Parameters

  • this: new (params: Partial<T>) => T
  • jsonArray: any[]

  Returns T[]

update

• update(
      updates: Partial<
          Pick<
              CPDFSquareAnnotation,
              | "title"
              | "content"
              | "borderColor"
              | "borderAlpha"
              | "fillColor"
              | "fillAlpha"
              | "borderWidth"
              | "bordEffectType"
              | "dashGap",
          >,
      >,
  ): this

  Update square annotation properties with type safety

  Parameters

  • updates: Partial<
        Pick<
            CPDFSquareAnnotation,
            | "title"
            | "content"
            | "borderColor"
            | "borderAlpha"
            | "fillColor"
            | "fillAlpha"
            | "borderWidth"
            | "bordEffectType"
            | "dashGap",
        >,
    >

    Partial object containing properties to update

  Returns this

  this instance for chaining

  Example

  squareAnnotation.update({
    title: 'Updated Title',
    content: 'Updated content',
    borderColor: '#FF0000',
    borderAlpha: 200,
    fillColor: '#00FF00',
    fillAlpha: 150,
    borderWidth: 2,
    bordEffectType: CPDFBorderEffectType.DASHED,
    dashGap: 4
  });
  await document.updateAnnotation(squareAnnotation);
  Copy

toJSON

• toJSON(): Omit<CPDFCircleAnnotation, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      borderColor: string;
      borderAlpha: number;
      fillColor: string;
      fillAlpha: number;
      borderWidth: number;
      bordEffectType: string;
      dashGap: number;
  }

  Returns Omit<CPDFCircleAnnotation, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      borderColor: string;
      borderAlpha: number;
      fillColor: string;
      fillAlpha: number;
      borderWidth: number;
      bordEffectType: string;
      dashGap: number;
  }

type

title

Readonlypage

content

Readonlyuuid

createDate

markState

reviewState

rect

borderColor

borderAlpha

fillColor

fillAlpha

borderWidth

bordEffectType

dashGap