Class CPDFSoundAnnotation

CPDFSoundAnnotation

Hierarchy (View Summary)

CPDFAnnotation
- CPDFSoundAnnotation

Index

Constructors

Methods

fromJson fromJsonArray update toJSON

Properties

type title page content uuid createDate markState reviewState rect soundPath

Constructors

constructor

new CPDFSoundAnnotation(
params: Partial<CPDFSoundAnnotation>,
): CPDFSoundAnnotation
Parameters
- params: Partial<CPDFSoundAnnotation>
Returns CPDFSoundAnnotation
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

toJSON

toJSON(): Omit<CPDFSoundAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    soundPath: string;
}
Returns Omit<CPDFSoundAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    soundPath: 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.

soundPath

soundPath: string

Path to the sound file representing the sound annotation.