Class CPDFImageAnnotation

CPDFImageAnnotation

Hierarchy (View Summary)

CPDFAnnotation
- CPDFImageAnnotation

Index

Constructors

constructor

new CPDFImageAnnotation(
params: Partial<CPDFImageAnnotation> & { imageData?: unknown },
): CPDFImageAnnotation
Parameters
- params: Partial<CPDFImageAnnotation> & { imageData?: unknown }
Returns CPDFImageAnnotation
Overrides CPDFAnnotation.constructor

Methods

`Static`fromJson

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
Inherited from CPDFAnnotation.fromJson

`Static`fromJsonArray

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[]
Inherited from CPDFAnnotation.fromJsonArray

update

update(
    updates: Partial<
        Omit<this, "_viewerRef" | "page" | "uuid" | "createDate">,
    >,
): this
Update annotation properties in a type-safe way
Parameters
- updates: Partial<Omit<this, "_viewerRef" | "page" | "uuid" | "createDate">>
  Partial object containing properties to update
Returns this
this instance for chaining
Example
```
annotation.update({ title: 'New Title', content: 'New Content' });
await document.updateAnnotation(annotation);
```
Inherited from CPDFAnnotation.update

`Static`fromBase64

fromBase64(
    params: {
        page: number;
        rect: CPDFRectF;
        base64: string;
        title?: string;
        content?: string;
        createDate?: Date;
        uuid?: string;
    },
): CPDFImageAnnotation
Parameters
- params: {
      page: number;
      rect: CPDFRectF;
      base64: string;
      title?: string;
      content?: string;
      createDate?: Date;
      uuid?: string;
  }
Returns CPDFImageAnnotation

`Static`fromDataUri

fromDataUri(
    params: {
        page: number;
        rect: CPDFRectF;
        dataUri: string;
        title?: string;
        content?: string;
        createDate?: Date;
        uuid?: string;
    },
): CPDFImageAnnotation
Parameters
- params: {
      page: number;
      rect: CPDFRectF;
      dataUri: string;
      title?: string;
      content?: string;
      createDate?: Date;
      uuid?: string;
  }
Returns CPDFImageAnnotation

`Static`fromPath

fromPath(
    params: {
        page: number;
        rect: CPDFRectF;
        filePath: string;
        title?: string;
        content?: string;
        createDate?: Date;
        uuid?: string;
    },
): CPDFImageAnnotation
Parameters
- params: {
      page: number;
      rect: CPDFRectF;
      filePath: string;
      title?: string;
      content?: string;
      createDate?: Date;
      uuid?: string;
  }
Returns CPDFImageAnnotation

`Static`fromAsset

fromAsset(
    params: {
        page: number;
        rect: CPDFRectF;
        assetPath: string;
        title?: string;
        content?: string;
        createDate?: Date;
        uuid?: string;
    },
): CPDFImageAnnotation
Parameters
- params: {
      page: number;
      rect: CPDFRectF;
      assetPath: string;
      title?: string;
      content?: string;
      createDate?: Date;
      uuid?: string;
  }
Returns CPDFImageAnnotation

`Static`fromUri

fromUri(
    params: {
        page: number;
        rect: CPDFRectF;
        uri: string;
        title?: string;
        content?: string;
        createDate?: Date;
        uuid?: string;
    },
): CPDFImageAnnotation
Parameters
- params: {
      page: number;
      rect: CPDFRectF;
      uri: string;
      title?: string;
      content?: string;
      createDate?: Date;
      uuid?: string;
  }
Returns CPDFImageAnnotation

toJSON

toJSON(): Omit<CPDFImageAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    image: string | undefined;
    imageData: Record<string, any> | undefined;
    stampType: string;
}
Returns Omit<CPDFImageAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    image: string | undefined;
    imageData: Record<string, any> | undefined;
    stampType: string;
}
Overrides CPDFAnnotation.toJSON

Properties

type

type: CPDFAnnotationType

Annotation type identifier

title

title: string

Annotation title

`Readonly`page

page: number

The page number where the note is located

content

content: string

annotation content.

`Readonly`uuid

uuid: string

annotation uuid.

createDate

createDate: Date | null = null

annotation create date.

markState

markState: CPDFAnnotationMarkState = CPDFAnnotationMarkState.UNMARKED

annotation mark state.

reviewState

reviewState: CPDFAnnotationReviewState = CPDFAnnotationReviewState.NONE

annotation review state.

rect

rect: CPDFRectF | null = null

annotation rect.

`Optional`image

image?: string

Legacy Base64 encoded image string representing the image annotation.

`Optional`imageData

imageData?: CPDFImageData

Preferred image source descriptor.

Class CPDFImageAnnotation

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns CPDFImageAnnotation

Methods

StaticfromJson

Type Parameters

Parameters

Returns T

StaticfromJsonArray

Type Parameters

Parameters

Returns T[]

update

Parameters

Returns this

Example

StaticfromBase64

Parameters

Returns CPDFImageAnnotation

StaticfromDataUri

Parameters

Returns CPDFImageAnnotation

StaticfromPath

Parameters

Returns CPDFImageAnnotation

StaticfromAsset

Parameters

Returns CPDFImageAnnotation

StaticfromUri

Parameters

Returns CPDFImageAnnotation

toJSON

Returns Omit<CPDFImageAnnotation, "createDate" | "update" | "toJSON"> & { createDate?: number; image: string | undefined; imageData: Record<string, any> | undefined; stampType: string;}

Properties

type

title

Readonlypage

content

Readonlyuuid

createDate

markState

reviewState

rect

Optionalimage

OptionalimageData

Settings

On This Page

`Static`fromJson

`Static`fromJsonArray

`Static`fromBase64

`Static`fromDataUri

`Static`fromPath

`Static`fromAsset

`Static`fromUri

Returns Omit<CPDFImageAnnotation, "createDate" | "update" | "toJSON"> & {
createDate?: number;
image: string | undefined;
imageData: Record<string, any> | undefined;
stampType: string;
}

`Readonly`page

`Readonly`uuid

`Optional`image

`Optional`imageData